v1

latestOpenAPI 3.0.12026-07-149718.6 KB
Application

Link application to an account

post/{provider}/{external_id}/applications

Path parameters

provider'messenger' | 'viber_service_msg' | 'whatsapp' required

Provider of the account you want to assign an application to

external_idstring required

External id of the account you want to assign an application to. This is channel dependent. For Facebook it will be your Facebook Page ID, for Viber your Viber Service Message ID and for WhatsApp your WhatsApp number.

Request body

applicationstring required

There is just one application allowed per an account. The application type must be type "messages". For more information please see Application API Spec

Example request

{
  "application": "applicationId"
}

Response

OK.

access_tokenstring

The provider access token (only for messenger)

api_keystring required

The external api key for this account

applicationsstring[]

The array of associated application ids

external_idstring required

The external identifier for this account

namestring

The account name

provider'messenger' | 'viber_service_msg' | 'whatsapp' required

The provider (will be one of messenger, viber_service_msg, whatsapp).

Example response

{
  "access_token": "accessToken",
  "api_key": "abcd1234",
  "applications": [
    "applicationId"
  ],
  "external_id": "12345678",
  "name": "name",
  "provider": "messenger"
}