Skip to main content
POST
Conectar canal WhatsApp

Authorizations

Authorization
string
header
required

Token JWT da sua conta. Use o formato: Bearer {seu-jwt-token}

Body

application/json

Dados para conectar o canal WhatsApp, caso não passe o phone, será gerado um QR Code para conexão.

phone
string

Número do telefone para conectar ao WhatsApp

Example:

"+5511999999999"

Response

Canal WhatsApp conectado com sucesso

id
string
required

ID único do canal

Example:

"clh1234567890"

companyId
string
required

ID da empresa proprietária do canal

Example:

"clh9876543210"

connectionStatus
enum<string>
required

Status da conexão do canal

Available options:
open,
close,
connecting,
refused,
qrcode_limit_scan
Example:

"connected"

type
enum<string>
required

Tipo do canal

Available options:
whatsapp,
telegram,
instagram
Example:

"whatsapp"

createdAt
string<date-time>
required

Data de criação do canal

Example:

"2024-01-15T10:30:00Z"

name
string

Nome do canal

Example:

"Canal WhatsApp Principal"

phone
string

Número do telefone conectado

Example:

"+5511999999999"

qrcode
object

QR Code para conexão

paircode
string

Código de pareamento

Example:

"ABC123XYZ"