SIsinch
Contact

Get Channel Profile

Get user profile from a specific channel. Only supported on MESSENGER, INSTAGRAM, VIBER and LINE channels. Note that, in order to retrieve a WhatsApp display name, you can use the Get a Contact or List Contacts operations, which will populate the display_name field of each returned contact with the WhatsApp display name (if the name is already stored on the server and the display_name field has not been overwritten by the user).

post/v1/projects/{project_id}/contacts:getChannelProfile

Request

  • Base URL
    https://us.conversation.api.sinch.com
  • URL
    https://us.conversation.api.sinch.com/v1/projects/{project_id}/contacts:getChannelProfile
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Request body

app_idstring required

The ID of the app.

channel'MESSENGER' | 'INSTAGRAM' | 'VIBER' | 'LINE' required

The channel. Must be one of the supported channels for this operation.

Example request

{
  "app_id": "{APP_ID}",
  "recipient": {
    "identified_by": {
      "channel_identities": [
        {
          "channel": "WHATSAPP"
        }
      ]
    }
  },
  "channel": "MESSENGER"
}

Response

A successful response.

profile_namestring

The profile name.

Example response

{
  "profile_name": "John Doe"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.