Profile data

Customer profile data are supplied by the channel service to be recorded and stored with the conversation data.

Profile data requests are GET requests that return respondent profile data from the service based on the respondent's ID.

Medallia Conversations requests profile data to include it in the record of the conversation. Medallia Conversations requests the data after the conversation has begun, but only when Channel authentication Get profile setting permits it. When the setting is disabled, Medallia Conversations does not request the data.

Profile request returns respondent profile data from the service

Request URL

The API endpoint implemented by the Channel Adapter to accept messages from Medallia Conversations.

<ADAPTER_URL>/{customer-id}?access_token={access-token}

Request path parameters

customer-idIdentifier unique to the respondent, such as phone number, email, or other channel-specific value. For phone numbers, the ID must be in E.164 format.
access-tokenThe access token is a shared token defined when creating the channel adapter in Medallia Conversations. It is free-form text, but Medallia recommends using a cryptographically-secure token such as a UUID or other random nonce value. For more information, see [NO TITLE FOUND].

Request headers

Content-Type: application/json

Additional custom headers can be defined in the Medallia Conversations Channel configuration.

Example: curl request

curl --request GET \
  -- url https://<ADAPTER_URL>/{customer-id}?access_token={access-token}
  -- header "Content-Type: application/json" 

Response

A successful response includes any available respondent profile data.

HTTP/1.1 200 
status: 200 
server: nginx 
content-type: application/json; 
charset=utf-8 
content-length: 307 
{ "first_name": "<FIRST_NAME>", "last_name": "<LAST_NAME>", "profile_pic": "<IMAGE_URL>", "locale": "<ISO_639_3166_CODE>", "timezone": <TIME_ZONE_OFFSET>, "phone_number": "<CUSTOMER_ID>" }
Note: There are no required fields. The adapter returns whatever it can, and it may return an empty response.