Login Cadastre-se

Atualização de status das mensagens enviadas

Através desse Webhook você poderá acompanhar o status da entrega da mensagem no seu contato, se a mensagem foi lida ou se o vídeo ou áudio que mandou foi reproduzido.

Header do request
Atributo Descrição Obrigatório Tipo

hook

Em todos os nossos Webhooks você irá receber este parâmetro no header do nosso request, cada tipo de Webhook irá enviar um valor diferente.

Para este Webhook você irá receber o valor: onAck

Sim

String

apiKey

Aqui você irá receber o MD5 da API Key do canal de atendimento/conta conectada em nossa plataforma, possibilitando que você confirme de qual canal se trata o Webhook.

Para identificar corretamente, pegue a API Key gerada na área de integrações do CRONCRM, gere md5(SUA_API_KEY) e compare com o valor recebido em apiKey.

IMPORTANTE: O header apiKey não é a API Key “pura”, e sim o seu MD5.

Sim

String
Body do request

Você irá receber um JSON com 2 arrays, um contendo informações da conversa e outro contendo informações da mensagem que foi enviada.

Atributo Descrição Obrigatório Tipo

chat

Array com informações básicas da conversa.

access_token: Token de identificação única do chat.

chat_wid: Número da conversa.

Sim

Array

message

Será retornado um array com os parâmetros abaixo:

access_token: Token de identificação única para o registro gerado pelo CRONCRM.

message_wid: ID da mensagem.

shipping_status: Status do envio da mensagem junto ao CRONCRM.

  • sent = Enviada.
  • failed = Falha ao tentar enviar, novas tentativas serão feitas.
  • queued = Na fila de envio.
  • cancelled = Cancelada.
  • received = Mensagem recebida.

shipping_attempts: Número de tentativas para enviar a mensagem.

message_ack: Status da mensagem.

  • -1 = Mensagem recebida.
  • 0 = Aguardando envio.
  • 1 = Entregue no servidor de entrega da mensagem.
  • 2 = Mensagem entregue no seu contato.
  • 3 = Mensagem lida pelo seu contato.
  • 4 = Mensagem escutada ou assistida pelo seu contato. (Comum para áudio e vídeos)
  • 100 = Mensagem cancelada no CRONCRM.

message_ack_timestamp: Última atualização em timestamp de status da mensagem.

Sim

Array

 
{
  "chat": {
    "access_token": "2023gtwLeuDB3wxNAzJCxBu9PKP99535433d51DVjo5HDNeafjAKTo4FHgRT1101",
    "chat_wid": "[email protected]"
  },
  "message": {
    "access_token": "20238WuyPjbFKCZwbBtGpRTcQHo98abdc905acquCjJD4kmldrgfA5V2ONaV1213",
    "message_wid": "[email protected]_3EB0EC5D75E9DBEB349C48",
    "shipping_status": "sent",
    "shipping_attempts": 1,
    "message_ack": 3,
    "message_ack_timestamp": 1702496509
  }
}