Pular para o conteúdo principal
POST
/
v1
/
channels
/
{channelId}
/
connect
Conectar canal
curl --request POST \
  --url https://api.hubmessage.io/v1/channels/{channelId}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wabaId": "428083093730937",
  "phoneId": "123456789012345",
  "code": "ABC123DEF456",
  "coexistence": false
}
'
{
  "success": true
}

​
Visão geral

Após criar um canal, você precisa conectá-lo a um número de WhatsApp. Existem duas formas:
  • Pelo painel — Fluxo guiado diretamente no Dashboard
  • Via SDK + API — Integre o fluxo de conexão no seu sistema

​
Conexão pelo painel

A forma mais simples. Acesse o Dashboard, selecione o canal criado e siga o fluxo de conexão guiado.

​
Conexão via SDK + API

Use este fluxo quando quiser que o seu usuário conecte o canal de dentro do seu sistema, sem precisar acessar o painel do . O fluxo tem 3 etapas:
1

Frontend — Iniciar conexão com o SDK

No frontend da sua aplicação, use o SDK para iniciar o fluxo de conexão. O SDK vai abrir o processo de autenticação com o WhatsApp e retornar as informações necessárias.
import HubMessage from '@hubmessage/connect';

const client = HubMessage.newClient({
  publicKey: 'SUA_PUBLIC_KEY'
});

const response = await client.connect({
  channelId: 'ID_DO_CANAL'
});

// Envie o response para o seu backend
A publicKey pode ser exposta no frontend. Veja mais em Autenticação.
2

Frontend → Backend — Enviar dados

O SDK retorna um objeto com as informações da conexão. Envie esses dados para o backend da sua aplicação:
{
  "wabaId": "428083093730937",
  "phoneId": "123456789012345",
  "code": "ABC123DEF456",
  "coexistence": false
}
CampoTipoDescrição
wabaIdstringID do WhatsApp Business Account selecionado
phoneIdstringID do número de telefone selecionado
codestringCódigo de autorização gerado pelo WhatsApp
coexistencebooleanSe o número está em modo de coexistência
3

Backend — Finalizar conexão via API

No backend, chame a API de conexão passando os dados recebidos do frontend:POST /v1/channels/{channelId}/connect
curl -X POST https://api.hubmessage.io/v1/channels/ID_DO_CANAL/connect \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SUA_SECRET_KEY" \
  -d '{
    "wabaId": "428083093730937",
    "phoneId": "123456789012345",
    "code": "ABC123DEF456",
    "coexistence": false
  }'
Esta chamada deve ser feita no backend, pois utiliza a Secret Key que nunca deve ser exposta no frontend.

​
Fluxo resumido

Frontend (SDK)              →  Backend (API)

1. client.connect()
2. Usuário autentica
3. SDK retorna dados ----→  4. POST /v1/channels/{id}/connect
                               com wabaId, phoneId, code, coexistence
                            5. Canal conectado ✓
Após a conexão, o canal está pronto para enviar e receber mensagens. Use o channelId nos endpoints de mensagens livres e templates.

Autorizações

​
Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Hub Message

Parâmetros de caminho

​
channelId
string
obrigatório

ID do canal (obtido via Criar canal)

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Corpo

application/json
​
wabaId
string
obrigatório

ID do WhatsApp Business Account

​
phoneId
string
obrigatório

ID do número de telefone

​
code
string
obrigatório

Código de autorização gerado pelo WhatsApp

​
coexistence
boolean
obrigatório

Se o número está em modo de coexistência

Resposta

Canal conectado com sucesso

​
success
boolean

Indica se a operação foi realizada com sucesso