v1

latestOpenAPI 3.0.12026-07-149718.6 KB

Retrieve a Whatsapp account

get/whatsapp/{external_id}

Path parameters

external_idstring required

External id of the account you want to retrieve. In this case it will be the WhatsApp number.

Response

OK.

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

providerstring required

The provider (will be whatsapp).

Example response

{
  "api_key": "abcd1234",
  "applications": [
    "optionalApplicationId"
  ],
  "external_id": "12345678",
  "name": "optionalName",
  "provider": "whatsapp"
}