Authorization: Bearer {BearerToken}.
Estes endpoints operam sobre os canais da sua própria conta, a mesma do
ApiID usado na requisição.Criar sessão
Cria um novo canal (sessão) do WhatsApp.
A rota cria só o canal: ela não cria uma API para ele. Para integrar o canal novo, crie a API depois em Configuração → API no painel.
Com
type instagram, se a conta do Instagram já estiver conectada por um canal do Login Unificado (sem Página do Facebook), a rota responde 409 com ERR_IG_ACCOUNT_CONNECTED_UNIFIED: remova aquele canal antes.
Para conectar um canal por QR Code depois de criá-lo:
- Iniciar sessão (
startSession): o status passa paraOPENING. - Mostrar QR Code (
qrCodeSession): traz o código de pareamento. - Leia o QR Code no WhatsApp do celular, em Aparelhos conectados > Conectar um aparelho.
- Confirme o status
CONNECTEDcom Exibir informações do canal por ID (showChannelById) ou pela listagem de sessões (listSessions).
Iniciar sessão
Inicia (conecta) uma sessão existente.
A resposta traz o status do canal no momento da chamada, em
data.status.
Mostrar QR Code
Retorna o QR Code atual para pareamento do canal com o WhatsApp.
O código vem em
data.qrcode. Conforme o tipo de canal, o valor é o texto do QR Code (para o seu sistema gerar a imagem) ou a imagem em Base64. Com o canal já conectado, qrcode vem vazio.
Solicitar novo QR Code
Gera um novo QR Code: use quando o código anterior expirou antes de ser escaneado ou quando o canal precisa ser pareado de novo.
A resposta só confirma o pedido, sem o código:
{ "success": true, "data": { "id": 1, "status": "qr_requested" } }. Depois, busque o QR Code novo em Mostrar QR Code.
Exibir informações do canal por número
Sem
number, a rota responde 400 com ERR_NUMBER_REQUIRED.
Exibir informações do canal por ID
Se o
id não for de um canal da sua empresa, a rota responde 404 com ERR_CHANNEL_NOT_FOUND.
A resposta de
showChannel e showChannelById não traz tokens, senhas, chaves nem a sessão do canal. Para só consultar status e número, também servem as listagens de sessões e canais (listSessions, listChannels).Excluir sessão
Remove permanentemente um canal (sessão) e desconecta o número associado.Resposta Padrão
showChannel e showChannelById, data traz as informações do canal (com id, name, status, type e number, entre outros), sem tokens, senhas, chaves nem a sessão do canal. Em qrCodeSession, data.qrcode traz o código de pareamento (vazio quando o canal já está conectado). createtSession e deleteSession devolvem os dados do canal criado ou excluído.
