Pular para o conteúdo principal
Uma sessão é uma conexão de canal (por exemplo, um número de WhatsApp) dentro do PanÐá Zap. Use os endpoints abaixo para criar novos canais, controlá-los e consultá-los de forma programática. Todas as requisições exigem o cabeçalho 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.
O caminho é /createtSession, com um “t” a mais. Esse é o nome real da rota: não corrija para createSession, ou a chamada falha.
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:
  1. Iniciar sessão (startSession): o status passa para OPENING.
  2. Mostrar QR Code (qrCodeSession): traz o código de pareamento.
  3. Leia o QR Code no WhatsApp do celular, em Aparelhos conectados > Conectar um aparelho.
  4. Confirme o status CONNECTED com 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.
Chamar startSession num canal já conectado reinicia a sessão: o status passa para OPENING. Use só em canal desconectado.

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.
Excluir uma sessão não pode ser desfeito pela API. Os atendimentos do canal continuam existindo, mas ficam sem canal vinculado, e a API ligada ao canal não é apagada: continua ativa, sem sessão. Se não for mais usá-la, exclua a API em Configuração → API. Para usar o número de novo, crie outro canal e leia um novo QR Code.

Resposta Padrão

Em 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.