API: atendimentos e anotações

Com a API você abre atendimentos, consulta as mensagens, muda a fila e o status e registra anotações. É o que permite, por exemplo, guardar no atendimento o número do chamado aberto em outro sistema. Antes, veja como autenticar e fazer a primeira chamada.

Os caminhos abaixo vêm depois da URL da sua API. Os que têm corpo usam POST com JSON.

Criar um atendimento

Caminho: /createticket

{
  "number": "5511999999999",
  "status": "pending",
  "queueId": 15,
  "userId": null
}

• status: pending deixa o atendimento aguardando na fila; open coloca em atendimento.
• queueId: o número (ID) da fila.
• userId: o atendente responsável. Use null para não atribuir a ninguém.

Consultar atendimentos de um contato

Envie o número para um destes caminhos:

{ "number": "5511999999999" }

• /showticket: dados do atendimento do contato.
• /showallticket: todos os atendimentos do contato.
• /showticketchatbot: a mesma consulta, na variação usada pelo chatbot.

Ver as mensagens de um atendimento

Use um GET em /ticket/ID_DO_ATENDIMENTO.

Mudar fila, status, responsável ou chatbot

O que	Caminho	Corpo
Trocar a fila	/updatequeue	{ "ticketId": 4, "queueId": 1 }
Trocar o chatbot	/updatechatbot	{ "ticketId": 6934, "chatbotId": 62 }
Status, responsável e fila de uma vez	/updateticketinfo	{ "ticketId": 1003, "status": "open", "userId": 1, "queueId": null }

Anotações

As anotações ficam no atendimento e podem ser vistas pela equipe. Caminho: /ticketnote.

Criar por atendimento:

{ "ticketId": 2881, "note": "Chamado #4521 aberto no sistema de suporte" }

Criar por número do cliente:

{ "number": "5511999999999", "note": "Cliente pediu retorno amanhã" }

Criar avisando pessoas ou equipes:

{
  "ticketId": 2881,
  "note": "Preciso de ajuda neste atendimento",
  "userIdNotification": ["5"],
  "equipeIdNotification": ["2"]
}

Consultar e listar:

• GET /ticketnote/ID_DA_ANOTACAO: uma anotação.
• GET /ticketnote/ticket/ID_DO_ATENDIMENTO: todas as anotações de um atendimento.
• GET /ticketnote/contact/ID_DO_CONTATO: todas as anotações de um contato.
• DELETE /ticketnote/ID_DA_ANOTACAO: apagar.

Exemplo: ligar um sistema de chamados ao atendimento

1. O cliente fala no WhatsApp e o atendente abre o atendimento no Zontalk.
2. O seu sistema de chamados cria o chamado e usa /ticketnote para guardar o número dele no atendimento.
3. Quando o chamado é resolvido, o seu sistema usa o envio de mensagem com o ticketId para avisar o cliente na mesma conversa.

Para o Zontalk avisar o seu sistema quando chega uma mensagem ou um atendimento é criado ou fechado, use Webhooks e N8N.

Cuidados

• Os IDs de fila, usuário, chatbot e equipe são números do seu painel.
• Informe o status ao criar o atendimento: pending ou open.