Conceituação
Esse é o webhook de retorno do status da mensagem.
ATENÇÃO
O PlugMessage 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-message-status
| Tipo | URL |
PUT |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-message-status |
Request Body:
{
"value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status"
}
Painel Administrativo
Atributos
Obrigatórios
| Atributos | Tipo | Descrição |
|---|---|---|
| status | string | Status da mensagem (SENT - se foi enviada, RECEIVED - se foi recebida, READ - se foi lida, READ_BY_ME - se foi lida por você (número conectado na sua instância), PLAYED - se foi ouvida ) |
| id | string | Identificador(es) da(s) mensagem(ns). |
| phone | string | Número de telefone de destino da mensagem. |
| momment | string | Momento em que a instância foi desconectada do número. |
| type | string | Tipo do evento da instância, nesse caso será "MessageStatusCallback". |
| phoneDevice | integer | Indica o dispositivo que ocorreu o evento (0 - Celular) |
| isGroup | boolean | Indica se o chat é um grupo |
Response
200
{
"instanceId": "instance.id",
"status": "SENT",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phoneDevice": 0,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"isGroup": false
}
{
"instanceId": "instance.id",
"status": "RECEIVED",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phoneDevice": 0,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"isGroup": false
}
{
"instanceId": "instance.id",
"status": "READ",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phoneDevice": 0,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"isGroup": false
}
{
"instanceId": "instance.id",
"status": "READ_BY_ME",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phoneDevice": 0,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"isGroup": false
}
{
"instanceId": "instance.id",
"status": "PLAYED",
"ids": ["999999999999999999999"],
"momment": 1632234645000,
"phoneDevice": 0,
"phone": "5544999999999",
"type": "MessageStatusCallback",
"isGroup": false
}
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"
Comentários
0 comentário
Por favor, entre para comentar.