API de Canais e Sessões: Crie, Conecte e Consulte Canais WhatsApp

Uma sessão é uma conexão de canal (por exemplo, um número de WhatsApp) dentro do PanÐá Zap. Use os endpoints abaixo para provisionar novos canais, controlá-los e consultá-los de forma programática — útil para plataformas que oferecem o PanÐá Zap como parte de um produto maior e precisam automatizar o onboarding de clientes. Todas as requisições exigem o cabeçalho Authorization: Bearer {BearerToken}.

Estes endpoints operam sobre canais dentro do tenant do seu ApiID. Para provisionar tenants inteiros (contas de clientes) em uma operação white-label/multi-empresa, veja Administração de Tenants, que exige um SuperAdminToken separado.

Criar sessão

Cria um novo canal (sessão) do WhatsApp.

POST https://{BaseUrl}/v2/api/external/{ApiID}/createtSession

{
  "name": "My WhatsApp Instance",
  "status": "DISCONNECTED",
  "type": "baileys"
}

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome de exibição da instância do WhatsApp.
`status`	string	Não	Status inicial — `DISCONNECTED` ou `CONNECTED`. Normalmente `DISCONNECTED` até que o QR Code seja escaneado.
`type`	string	Sim	Motor de conexão — por exemplo, `baileys`, `zapo`, `waba`, `meow`, `evo`, `uazapi`, `zapi`.

Após criar a sessão, use Mostrar QR Code para obter o código de pareamento e conectar o número.

Iniciar sessão

Inicia (conecta) uma sessão existente.

POST https://{BaseUrl}/v2/api/external/{ApiID}/startSession

{ "whatsappId": 1 }

Campo	Tipo	Obrigatório	Descrição
`whatsappId`	integer	Sim	ID da sessão (canal) a ser iniciada.

Mostrar QR Code

Retorna o QR Code atual para pareamento do canal com o WhatsApp.

POST https://{BaseUrl}/v2/api/external/{ApiID}/qrCodeSession

{ "whatsappId": 1 }

Campo	Tipo	Obrigatório	Descrição
`whatsappId`	integer	Sim	ID da sessão para a qual obter o QR Code.

Solicitar novo QR Code

Gera um novo QR Code — use quando o código anterior expirou antes de ser escaneado.

POST https://{BaseUrl}/v2/api/external/{ApiID}/requestNewQrCodeSession

{ "whatsappId": 1 }

Campo	Tipo	Obrigatório	Descrição
`whatsappId`	integer	Sim	ID da sessão para a qual gerar um novo QR Code.

Exibir informações do canal por número

POST https://{BaseUrl}/v2/api/external/{ApiID}/showChannel

{ "number": "5515998566622" }

Campo	Tipo	Obrigatório	Descrição
`number`	string	Sim	Número do WhatsApp do canal a consultar.

Exibir informações do canal por ID

POST https://{BaseUrl}/v2/api/external/{ApiID}/showChannelById

{ "id": 43 }

Campo	Tipo	Obrigatório	Descrição
`id`	integer	Sim	ID do canal a consultar.

Excluir sessão

Remove permanentemente um canal (sessão) e desconecta o número associado.

POST https://{BaseUrl}/v2/api/external/{ApiID}/deleteSession

{ "whatsappId": 1 }

Campo	Tipo	Obrigatório	Descrição
`whatsappId`	integer	Sim	ID da sessão a ser excluída.

Excluir uma sessão é uma operação destrutiva e não pode ser desfeita pela API. O histórico de tickets associado ao canal permanece no banco de dados, mas o canal deixa de poder enviar ou receber mensagens.

Resposta Padrão

{
  "success": true,
  "data": { ... }
}

Nos endpoints de consulta (showChannel, showChannelById, qrCodeSession), data traz os detalhes do canal ou o QR Code em Base64, conforme o endpoint chamado.

Primeiros Passos

Mensagens

Mensagens Interativas

Tickets e Contatos

Campanhas e CRM

Canais e Recursos

Organização e Produtividade

Dados e Relatórios

Administração da Plataforma

Webhooks e Eventos

API de Canais e Sessões: Crie, Conecte e Consulte Canais WhatsApp

Criar sessão

Iniciar sessão

Mostrar QR Code

Solicitar novo QR Code

Exibir informações do canal por número

Exibir informações do canal por ID

Excluir sessão

Resposta Padrão

​Criar sessão

​Iniciar sessão

​Mostrar QR Code

​Solicitar novo QR Code

​Exibir informações do canal por número

​Exibir informações do canal por ID

​Excluir sessão

​Resposta Padrão

Criar sessão

Iniciar sessão

Mostrar QR Code

Solicitar novo QR Code

Exibir informações do canal por número

Exibir informações do canal por ID

Excluir sessão

Resposta Padrão