v1

latestOpenAPI 3.0.02026-07-24202886.6 KB
Channel Adapter Services

Returns a customer's profile data for use in Medallia Conversations' reporting interfaces. All fields returned by the adapter are optional. The adapter returns whatever it can, and it may return an empty response.

get/{customer-id}

Path parameters

customer-idstring required

An identifier unique to the customer, such as phone number, email, or other channel-specific value. For phone numbers, the ID must be in E.164 format.

Query parameters

access_tokenstring required

The 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.

Response

The customer's profile data. If the customer id provided is not found, an empty response should be returned.

first_namestring
last_namestring
profile_picstring uri

A publicly-accessible URL to the customer's avatar or profile picture.

localestring

The ISO-639 or ISO-3166 country code.

timezoneinteger

Time zone offset, the number relative to GMT, (ex: -8).

phone_numberstring

The customer's phone number, in E.164 format.