Retorno de chama de atualização de status
A cada atualização sobre o status das mensagens enviadas (confirmação de entrega para o usuário final, leitura de mensagens, etc.), um retorno de chamada/webhook é enviado. Os retornos de chamada são
total
Número de retornos de chamada na chamada.
String
data
Lista de retorno de chamada.
Data[]
clientInfo
Informações ao Cliente
ClientInfo
Data:
id
ID da última mensagem.
String
correlationId
Um ID exclusivo definido por você para corresponder ao status da mensagem (retorno de chamada e DLR). Esse parâmetro é opcional e você pode usar o ID gerado pelo ChatClub para essa correspondência.
String
destination
Telefone para o qual a mensagem foi enviada (incluindo o código do país). Exemplo: 5511900000000.
String
origin
Telefone que identifica a conta do WhatsApp (incluindo o código do país). Exemplo: 5511900000000.
String
campaignId
ID de campanha definido anteriormente.
String
campaignAlias
Alias de campanha definidos anteriormente.
String
extraInfo
Informações extras enviadas com a mensagem original.
String
sent
Indica se a mensagem foi enviada.
Boolean
sentStatusCode
Código de status gerado pelo ChatClub para mensagem indicando o status de envio.
Number
sentStatus
Descrição do status enviado.
Boolean
sentDate
Data em que a mensagem foi enviada. Formato: aaaa-MM-dd'T'HH:mm:ssZ.
String
sentAt
Hora em que a mensagem foi enviada, usando o formato Unix_time
Number
delivered
Indica se a mensagem foi entregue ao destino.
Boolean
deliveredStatusCode
Código de status gerado pelo ChatClub para mensagem indicando que a mensagem foi entregue.
Number
deliveredStatus
Descrição do status de entrega.
String
deliveredDate
Data em que a mensagem foi entregue. Formato:: aaaa-MM-dd'T'HH:mm:ssZ
String
deliveredAt
Hora em que a mensagem foi entregue, usando Unix_time formato
Number
read
Indica se a mensagem foi lida pelo destino.
Boolean
readDate
Data em que a mensagem foi lida. Formato: aaaa-MM-dd'T'HH:mm:ssZ
String
readAt
Hora em que a mensagem foi lida, usando o formato Unix_time
String
updatedDate
Data em que o status da mensagem foi atualizado. Formato: aaaa-MM-dd'T'HH:mm:ssZ
String
updatedAt
Data em que o status da mensagem foi atualizado, usando o formato Unix_time
String
type
O tipo de entidade sobre o qual esse objeto de status se refere. Atualmente, a única opção disponível é "mensagem".
String
conversation
Conversation
ClientInfo Op
customerId
Identificação do cliente.
Number
subAccountId
Identificação de subcontas.
Number
userId
Identificação do usuário.
Number
Status
Status que pode ser enviado no retorno de chamada:
1
ROUTED_SUCCESS
Routed
Status de roteamento interno intermediário. As mensagens não são persistentes com esse status, portanto, não temos mensagens em relatórios com esse status
2
SENT_SUCCESS
Sent
Mensagem enviada com sucesso para operadora ou contêiner do WhatsApp.
3
CARRIER_ACCEPTED_SUCCESS
Carrier Accepted
Status de roteamento intermediário na transportadora. As mensagens não são persistentes com esse status, portanto, não temos mensagens em relatórios com esse status
4
DELIVERED_SUCCESS
Delivered
Mensagem entregue com sucesso da operadora ou do contêiner do WhatsApp para o dispositivo do destinatário.
5
READ_SUCCESS
Message read
Mensagem aberta e exibida para o usuário no aplicativo WhatsApp. Não temos esse status no SMS
101
EXPIRED
Expired
A mensagem TTL expirou.
102
CARRIER_COMMUNICATION_ERROR
Carrier communication error
Status indicando que estávamos tendo problemas para estabelecer comunicação com a operadora ou com o contêiner do WhatsApp e a mensagem não pôde ser enviada.
103
REJECTED_BY_CARRIER
Rejected by carrier
Status indicando que a operadora ou o contêiner do WhatsApp rejeitou a mensagem. Pode ser devido a vários motivos, como uma fila cheia na operadora, um número inválido para a operadora, um modelo de WhatsApp sem o idioma ou parâmetros ausentes. Ou qualquer outro erro interno do transportador ou do contêiner
104
NOT_DELIVERED
Message not delivered
Mensagem enviada com sucesso para operadora ou contêiner do WhatsApp, mas não entregue no dispositivo do usuário. Pode ser porque o dispositivo do usuário está fora de alcance; o número foi desativado ou bloqueado; Para o WhatsApp pode ser porque o conteúdo (mídia) não pode ser enviado ao usuário ou porque o destinatário não pode receber a mensagem devido a limites ou spam.
105
WA_MO_MEDIA_UNRETRYABLE_EXCEPTION
Retryable media error
Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner e não há necessidade de tentar novamente.
106
WA_MO_MEDIA_RETRYABLE_EXCEPTION
Not retryable media error
Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner, mas é possível tentar novamente
107
WA_MO_MEDIA_UNKNOWN_EXCEPTION
Media message unknown error
Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner e o erro é desconhecido.
108
WA_MO_MEDIA_MESSAGE_WITHOUT_FILE_ID_EXCEPTION
Media message without content
A mídia não pode ser processada corretamente quando enviada ao Felix, devido ao seu conteúdo vazio.
109
WA_MT_UNKNOWN_EXCEPTION
Unknown error (MT)
MT Error Status, indica que ocorreu um erro não relacionado ao conteúdo da mensagem em si, como tempo limite de conexão, conexão interrompida, erro interno ou erro com autenticação ssl.
110
WA_DATABASE_ERROR
Error with WhatsApp container’s database
Indica que ocorreu um erro com o banco de dados de contêiner (WhatsApp)
111
WA_MT_BLOCKED_BY_SPAM_RATE_LIMIT
Blocked for exceeding the amount of shipments (MT)
Bloqueio quando muitas mensagens idênticas são enviadas mais de uma vez para um determinado usuário, então o contêiner é bloqueado e as mensagens não são enviadas.
112
WA_MT_DESTINATION_INCAPABLE
Recipient unable to receive messages (MT)
O destinatário da mensagem não tem uma versão mais atualizada do WhatsApp ou, por algum outro motivo, não pode receber a mensagem enviada
201
NO_CREDIT
No credit
A verificação de crédito é feita no momento da solicitação de envio. Portanto, não temos esse status em mensagens persistentes. Acredito que esse status só é usado no B2C para shortcodes que são cobrados, então a mensagem pode ser recusada se o usuário não tiver crédito.
202
INVALID_DESTINATION_NUMBER
Invalid destination number
O número do destinatário é inválido e a mensagem não será enviada para a operadora ou contêiner do WhatsApp
203
BLACKLISTED
Destination in blocklist
O cliente adicionou o número à lista de bloqueio e a mensagem não será enviada para a operadora ou contêiner do WhatsApp
204
DESTINATION_BLOCKED_BY_OPTOUT
Destination in optOut
O usuário enviou o comando "exit" e foi adicionado à lista de opt-out. A mensagem não será enviada.
205
DESTINATION_MESSAGE_LIMIT_REACHED
Message limit reached
Indica que o contêiner está sobrecarregado e não pode receber mais mensagens.
207
INVALID_MESSAGE_TEXT
Message text is invalid
Envios de modelo que não estão habilitados na conta do cliente. Ou até mesmo parâmetros inválidos para a mensagem. Não temos palavras proibidas para o WhatsApp.
209
INVALID_CONTENT
Invalid message content
Indica que algum parâmetro de mensagem é inválido ou ausente.
210
INVALID_SESSION
Invalid session
Indica que foi feita uma tentativa de enviar um texto ou mídia sem que a sessão tenha sido aberta por um MO. Somente modelos são permitidos com a sessão fechada.
211
DESTINATION_BLOCKED_BY_OPT_IN
Destination blocked by optIn
O número não está na lista de opt-in e, portanto, a mensagem não será enviada.
212
DESTINATION_BLOCKED_BY_WHITELIST
Destination blocked by allowlist
O número não está na lista de números permitidos e, portanto, a mensagem não será enviada..
215
CUSTOMER_QUOTA_BLOCKED
Client blocked by quota limit
Status que indica que o cliente atingiu sua cota (mensal/diária) para envio de mensagens e, portanto, a mensagem não será enviada.
216
MESSAGE_BLOCKED_BY_WARM_UP
Message blocked by WarmUp feature
Status para clientes do WhatsApp que estão realizando aquecimento de contêiner. A mensagem permanece nesse status quando o contêiner já atingiu o limite permitido de mensagens para a camada atual.
217
WA_MT_MEDIA_EXCEPTION
Error in media content (MT)
Status MT para mensagens de mídia, onde devido a um erro no modelo, o tamanho da mídia ou do modelo excedeu o limite suportado, o formato de mídia não foi suportado ou a mídia não pôde ser encontrada e foi considerada inválida.
218
WA_NO_PRODUCTS_FOUND
Product not found
A solicitação tentou buscar um produto que não está cadastrado no sistema. Se for uma Mensagem da Lista de Produtos, significa que o catálogo ou o produto não existe no Gerenciador de Negócios.
219
INVALID_PARAMETER_OR_CONTACT
Invalid parameter or contact/destination
Indica que algum parâmetro de mensagem é inválido ou ausente, ou que o contato/destinatário é inválido/não tem WhatsApp.
301
INTERNAL_ERROR
Internal error
Status indicando que houve algum erro interno em nossas plataformas e a mensagem não pôde ser processada e enviada.
302
WA_MO_UNKWNOWN_EXCEPTION
Unknown error (MO)
Status para WhatsApp MO. Esse status indica que ocorreu um erro desconhecido durante o processamento do MO.
303
WA_BUSINESS_PAYMENT_ISSUE
Business payment issue
Status indica que ocorreu um problema durante o pagamento da transação, que pode ser causado por erros internos e externos. A mensagem não será enviada ao usuário.
Exemplo
Last updated
Was this helpful?