Sign in
v1Channels

Retrieve a channel

get/v1/channels/{id}

Path parameters

idnumber required

Response

idnumber required
descriptionstring

Nome do canal. Para e-mail, é o endereço da caixa.

platformIdnumber required

1 WhatsApp, 2 Telegram, 3 Facebook, 4 Widget, 5 E-mail, 6 Customizado, 7 Instagram, 8 Mercado Livre, 9 SMS

phonestring
statusstring
isConnectedboolean
versionnumber

Versão do canal de WhatsApp: 3 não oficial, 4 oficial (Cloud API)

waba_idstring

Id da WABA. Diferente de nulo apenas em canais de WhatsApp Oficial.

groupIdsnumber[]
isPrivateboolean
isBannedboolean
customFieldsobject

Example response

{
  "id": 103,
  "description": "Comercial",
  "platformId": 1,
  "phone": "5585988887777",
  "status": "connected",
  "isConnected": true,
  "version": 4,
  "waba_id": "123456789012345"
}

Changes

Changed in 1 of the 18 revisions of this API.1