Skip to main content

Ao enviar

Método#

POST on-message-send#

Conceituação#

Esse é o webhook de retorno de mensagens enviadas

Atenção

O PlugZapi 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.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-delivery

Request Body#

Body#

{
"value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/delivery"
}

Painel Administrativo#

img


Retornos dos webhooks#

Os possíveis retornos do webhook on-message-send estão cadastrado logo abaixo:

Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringNúmero de telefone de destino da mensagem.
zaapIdstringIdentificador da mensagem na conversa.
typestringTipo do evento da instância, nesse caso será "DeliveryCallback".

Opcionais#

AtributosTipoDescrição
customIdstringIdentificador provido pelo usuário para controle de mensagem utilizando seus próprios IDs.

Response#

200#

{
"phone": "554499999999",
"customId": "123",
"zaapId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"type": "DeliveryCallback"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET 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"