Launch the People app

This topic describes the ms-people: URI scheme. Your app can use this URI scheme to launch the People app for specific actions.

ms-people: URI scheme reference

Results URI scheme
Allows other apps to launch the People app Main page. ms-people:
Allows other apps to launch the People app Settings page. ms-people:settings
Allows other apps to provide a search string that will launch the People app with the result page of the search.

The parameters are case sensitive.

If you do not enter the syntax correctly, or are missing the search string value, the default behavior is to return a full list of contacts without any filtering.

ms-people:search?SearchString=<contactsearchinfo>
Launches to an existing contact card, if the contact is found. Or, launches to a temporary contact card, if no contact is found. If no input parameter is supplied, we will launch the People App with a contact list.

The parameters are case sensitive.

The order of the parameters doesn’t matter.

If there is more than one match, we will return the first match of the contact.

 
ms-people:viewcontact:?ContactId=<contactid>&AggregatedId=<aggid>&PhoneNumber= <phonenum>&Email=<email>&ContactName=<name>&Contact=<contactobj>
Launches to a Save-contact page within the People app to save the given contact with the supplied phone number or email address.

The parameters are case sensitive.

The order of the parameters doesn’t matter.

ms-people:savetocontact?PhoneNumber= <phonenum>&Email=<email>&ContactName=<name>
Launches to the add a new contact page within the People app to save the given contact.

Use LaunchUriForResultsAsync to open the save new contact page. Using LaunchUriAsync will only launch the People app Main page.

The parameters are case sensitive.

The order of the parameters doesn’t matter.

You can use any combination of supported parameters.

ms-people:savecontacttask?PhoneNumber= <phonenum>&Email=<email>&ContactName=<name>

ms-people:search: parameter reference

Parameter Description Example
SearchString

Optional.

The search string for the contact search information.

The phone number or the contact name.

ms-people:search?SearchString=Smith

ms-people:viewcontact: parameter reference

Parameter Description Example
ContactId

Optional.

Contact Id of the contact.

ms-people:viewcontact?ContactId={ContactId}

PhoneNumber

Optional.

Phone number of the contact.

ms-people:viewcontact?PhoneNumber=%2014257069326

Email

Optional.

Email of the contact.

ms-people:viewcontact?Email=johnsmith@contsco.com

ContactName

Optional.

Name of the contact.

ms-people:viewcontact?ContactName=John%20%Smith

Contact

Optional.

Contact object.

ms-people:viewcontact?Contact={Serialized Contact}

ms-people:savetocontact: parameter reference

Parameter Description Example
PhoneNumber

Optional.

Phone number of the contact.

ms-people:savetocontact?PhoneNumber=%2014257069326

Email

Optional.

Email of the contact.

ms-people:savetocontact?Email=johnsmith@contsco.com

ContactName

Optional.

Name of the contact.

ms-people:savetocontact?Email=johnsmith@contsco.com&ContactName= John%20%Smith

ms-people:savecontacttask: parameter reference

Parameter Description
Company

Optional.

Company name of the contact.

FirstName

Optional.

First name of the contact.

HomeAddressCity

Optional.

City of the home address.

HomeAddressCountry

Optional.

Country of the home address.

HomeAddressState

Optional.

State of the home address.

HomeAddressStreet

Optional.

Street of the home address.

HomeAddressZipCode

Optional.

Zip Code of the home address.

HomePhone

Optional.

Home phone of the contact.

JobTitle

Optional.

Job title of the contact.

LastName

Optional.

Last name of the contact.

MiddleName

Optional.

Middle name of the contact.

MobilePhone

Optional.

Mobile phone number of the contact.

Nickname

Optional.

Nickname of the contact.

Notes

Optional.

Notes about the contact.

OtherEmail

Optional.

Other Email of the contact.

PersonalEmail

Optional.

Personal Email of the contact.

Suffix

Optional.

Suffix of the contact.

Title

Optional.

Title of the contact.

Website

Optional.

Website of the contact.

WorkAddressCity

Optional.

City of the work address.

WorkAddressCountry

Optional.

Country of the work address.

WorkAddressState

Optional.

State of the work address.

WorkAddressStreet

Optional.

Street of work address.

WorkAddressZipCode

Optional.

Zip Code of the work address.

WorkEmail

Optional.

Work Email of the contact.

WorkPhone

Optional.

Work phone number of the contact.