Ao enviar
Conceituação#
Esse é o webhook de retorno de mensagens enviadas
Atenção
O Z-API não aceita webhooks que não sejam HTTPS
Atualizando Webhook#
Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel administrativo.
API#
/update-webhook-delivery#
PUT https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-delivery
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Request Body#
Painel Administrativo#
Retornos dos webhooks#
Os possíveis retornos do webhook on-message-send estão cadastrado logo abaixo:
Response#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Número de telefone de destino da mensagem. |
| zaapId | string | Identificador da mensagem na conversa. |
| type | string | Tipo do evento da instância, nesse caso será "DeliveryCallback". |
200#
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT conforme especificado no inicio deste tópico.
415#
Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"