Criar conexão de WhatsApp oficial

POST

{{baseURL}}/api/v3/settings/channels-gateway/whatsapp/official

Última modificação:2026-08-14 20:09:25

Cadastra uma nova conexão de WhatsApp oficial (broker pontal-tech).

O api-core faz duas chamadas encadeadas no ms-channels-gateway: cria o
channel-config e, em seguida, a whatsapp-account com os ids da Meta. A conexão
nasce com status: "disconnected" — para ativar, chame
POST /whatsapp/official/connect com o id retornado aqui.

Use pra:

Cadastrar um número oficial novo

Habilitar coexistência com o WhatsApp Business App (coexistenceMode)

⚠️ Se a criação do channel-config funcionar mas a da conta WhatsApp falhar,
a configuração fica criada e órfã — nesse caso o status HTTP vem do erro do
gateway, não 201.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

Cadastro padrãoCom coexistência

{
    "name": "Atendimento Comercial",
    "wabaId": "900000000000001",
    "phoneNumberId": "700000000000001"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Cadastro padrãoCom coexistência

curl --location --globoff 'https://api-{tenant}.digitalk.com.br/api/v3/settings/channels-gateway/whatsapp/official' \
--header 'api-key: API_TOKEN (disponível no database da plataforma)' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Atendimento Comercial",
    "wabaId": "900000000000001",
    "phoneNumberId": "700000000000001"
}'

Respostas

🟢201Criado

application/json

Conexão criada. Ainda desconectada — chame /whatsapp/official/connect.

Bodyapplication/json

Exemplo

{
    "id": "3f2a91c4-7b60-4d15-9a2e-1c8d5e0b7411",
    "name": "Atendimento Comercial",
    "description": null,
    "broker": "pontal-tech",
    "channel": "whatsapp",
    "status": "disconnected",
    "createdAt": "2026-08-14T13:20:11.402Z",
    "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91"
}

🟠400Pedido Inválido

🟠401Não Autorizado

🟠403Proibido

🔴500Erro Interno

Modificado em 2026-08-14 20:09:25

Página anterior

Listar números disponíveis de uma WABA

Próxima página

Conectar o número oficial (ativar a conexão)