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-status
| Tipo | URL |
PUT |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-webhook-chat-presence |
Request Body:
{
"value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/presence"
}
Painel Administrativo
Atributos
Obrigatórios
| Atributos | Tipo | Descrição |
|---|---|---|
| type | string | Tipo do evento da instância, nesse caso será "PresenceChatCallback". |
| phone | string | Número de telefone de destino da mensagem. |
| status | string | Identificador do status do chat ex: (Digitando...) status pode conter ( UNAVAILABLE, AVAILABLE, COMPOSING, RECORDING) |
Response
200
Fora do chat
{
"type": "PresenceChatCallback",
"phone": "5544999999999",
"status": "UNAVAILABLE",
"lastSeen": null,
"instanceId": "instance.id"
}
Dentro do chat
{
"type": "PresenceChatCallback",
"phone": "5544999999999",
"status": "AVAILABLE",
"lastSeen": null,
"instanceId": "instance.id"
}
Digitando no chat
{
"type": "PresenceChatCallback",
"phone": "5544999999999",
"status": "COMPOSING",
"lastSeen": null,
"instanceId": "instance.id"
}
Parou de digitar ou apagou o que estava digitando
{
"type": "PresenceChatCallback",
"phone": "5544999999999",
"status": "PAUSED",
"lastSeen": null,
"instanceId": "instance.id"
}
AVISO
Observação:
Após receber um composing ou um recording, um PAUSED será retornado quando o evento parar.
O status PAUSED apenas é retornado se estiver usando o beta multi-devices.
Gravando áudio no chat
{
"type": "PresenceChatCallback",
"phone": "5544999999999",
"status": "RECORDING",
"lastSeen": null,
"instanceId": "instance.id"
}
AVISO
O status RECORDING apenas é retornado se estiver usando o beta multi-devices
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.