Skip to main content
GET
Retrieve a channel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
number
required

Response

200 - application/json
id
number
required
Example:

103

platformId
number
required

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

Example:

1

description
string

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

Example:

"Comercial"

phone
string
Example:

"5585988887777"

status
string
Example:

"connected"

isConnected
boolean
Example:

true

version
number

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

Example:

4

waba_id
string

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

Example:

"123456789012345"

groupIds
number[]
isPrivate
boolean
Example:

false

isBanned
boolean
Example:

false

customFields
object