Cortana user profile and contextual information reference

Cortana sends the user's profile and contextual information as part of the message that it sends to your skill. You can use this information to provide a custom experience for the user. User profile information is data that the user has provided about themselves to Cortana. User contextual information is information that Cortana has discovered about the user, such as the user's name.

For information about how you use the objects listed in this reference, see Get the user's profile and contextual information.

User Profile Entities

These are the types of user profile data that you can request when you configure the Cortana channel.

Entity Name Type Description
User.SemanticLocation.Away Away Indicates whether the user is away from their home or work.
User.SemanticLocation.Current Visit The user's current location.
User.Info.Name Name The user's name.
User.Info.Email string The user's email address.

Away object

Defines whether the user is away from home or work.

Property Type Always included Description
Away Boolean Yes A Boolean value that determines whether the user is away from home or work. If true, the user is away from home or work. Otherwise, false.
Since DateTime No The date and time that the user left home or work, in ISO-8601 format.

Example

User is not away:

{
    "Away": false
}

User is away since April 25th, ‎2017‎ ‎6:‎02‎PM UTC:

{
    "Away": true,
    "Since": "2017-04-25T18:02:00+00:00"
}

Name object

Defines the user's name.

Property Type Always included Description
GivenName string No The user's first name.
FamilyName string No The user's last name.

Example

{
    "GivenName": "John",
    "FamilyName": "Smith"
}

Visit object

Defines the user's current location.

Property Type Always included Description
StartTime DateTime Yes The date and time the user arrived at the location, in ISO-8601 format.
EndTime DateTime No The date and time the user left the location, in ISO-8601 format.
VenueName string No The name of the location if the location is a point of interest.
Away Away No Indicates whether the user is away from home or work.

Example

{
    "StartTime": 2017-04-25T18:02:30+00:00,
    "EndTime": 2017-04-27T7:35:00+00:00,
    "VenueName": null,
    "Away": {
        "Away": true,
        "Since": "2017-04-25T18:02:00+00:00"
    }
}