Configure uma URL de callback HTTP para receber notificações sobre o status de revisão dos modelos de mensagem.
Especificação do protocolo
|
Item |
Descrição |
|
Protocolo |
HTTP + JSON |
|
Método de codificação |
UTF-8 |
Pré-requisitos
Você possui uma conta Alibaba Cloud e um par de AccessKey. Para mais informações, consulte Crie um AccessKey.
Revise a visão geral e configuração de recibos de mensagem para compreender os modos, tipos e processo de configuração. Em seguida, configure os recibos de mensagem adequadamente.
Solicitação
O sistema pode enviar vários relatórios de revisão simultaneamente via push.
Exemplo de solicitação
[
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
},
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca*****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
}
]
Parâmetros da solicitação
V1
Parâmetro | Tipo | Obrigatório | Descrição |
WabaId | String | Sim | ID da WhatsApp Business Account (WABA). Nota Após criar uma WABA, obtenha o ID na plataforma Business Manager. |
TemplateCode | String | Sim | Código do modelo. Nota Obtenha o código do modelo na página Template Design no console do Chat App Message Service ou chame a operação ListChatappTemplate. |
Language | String | Sim | Idioma do modelo. |
AuditStatus | String | Sim | Status de revisão do modelo de mensagem. Valores válidos:
|
Reason | String | Não | Motivo da falha na revisão. Nota Este valor é retornado quando AuditStatus for fail. |
V2
Use a V2 quando o fornecedor independente de software (ISV) gerenciar as contas do WhatsApp Business (WABAs) e os números de telefone dos clientes.
Parâmetro | Tipo | Obrigatório | Descrição |
WabaId | String | Sim | ID da WABA. Nota Após criar uma WABA, obtenha o ID na plataforma Business Manager. |
TemplateCode | String | Sim | Código do modelo. Nota Obtenha o código do modelo na página Template Design no console do Chat App Message Service ou chame a operação ListChatappTemplate. |
Language | String | Sim | Idioma do modelo. |
AuditStatus | String | Sim | Status de revisão do modelo de mensagem. Valores válidos:
|
Reason | String | Não | Motivo da falha na revisão. Nota Este valor é retornado quando AuditStatus for fail. |
Type | String | Sim | Tipo de notificação. Valores válidos:
Nota Se Type retornar template, os parâmetros do relatório de revisão V2 serão idênticos aos do relatório V1. |
PhoneNumber | String | Não | Número de telefone. Nota
|
Status | String | Não | Status. Nota
|
CurrentLimit | String | Não | Limite diário máximo de mensagens para o número de telefone. Nota
|
Resposta
O endpoint deve retornar um código de status HTTP 200 em até 3 segundos. O corpo da resposta deve ser um objeto JSON no formato a seguir. Caso contrário, o sistema considera o push como falho e tenta novamente.
Exemplo de resposta
{
"code" : 0,
"msg" : "Successful"
}
Parâmetros da resposta
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
code |
Number |
Sim |
Código da resposta. |
|
msg |
String |
Não |
Descrição do código da resposta. |
Novas tentativas
Se a tentativa inicial de push falhar, o serviço tentará novamente após 1 minuto e, depois, após 5 minutos. Uma tentativa falha se o endpoint retornar um código de status HTTP diferente de 200 ou se a solicitação atingir o tempo limite. Após três falhas consecutivas, o serviço interrompe as novas tentativas.