Configure una URL de callback HTTP para recibir notificaciones sobre el estado de revisión de las plantillas de mensajes.
Especificación del protocolo
|
Elemento |
Descripción |
|
Protocolo |
HTTP + JSON |
|
Método de codificación |
UTF-8 |
Requisitos previos
Debe contar con una cuenta de Alibaba Cloud y un par de AccessKey. Para obtener más información, consulte Create an AccessKey.
Debe haber revisado descripción general y configuración de recibos de mensajes ; además, debe comprender sus modos, tipos y proceso de configuración. Posteriormente, configure los recibos de mensajes según corresponda.
Solicitud
Es posible que se envíen varios informes de revisión simultáneamente.
Ejemplo de solicitud
[
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
},
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca*****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
}
]
Parámetros de la solicitud
V1
Parámetro | Tipo | Obligatorio | Descripción |
WabaId | String | Sí | ID de la cuenta de WhatsApp Business (WABA). Nota Después de crear una WABA, obtenga su ID en la plataforma Business Manager. |
TemplateCode | String | Sí | Código de la plantilla. Nota Obtenga el código de la plantilla en la página Template Design de la consola de Chat App Message Service o mediante la operación ListChatappTemplate. |
Language | String | Sí | Idioma de la plantilla. |
AuditStatus | String | Sí | Estado de revisión de la plantilla de mensajes. Valores válidos:
|
Reason | String | No | Motivo del rechazo en la revisión. Nota Se devuelve un valor cuando el valor de retorno de AuditStatus es fail. |
V2
Utilice la versión V2 cuando el proveedor de software independiente (ISV) gestione las cuentas de WhatsApp Business (WABA) y los números telefónicos de sus clientes.
Parámetro | Tipo | Obligatorio | Descripción |
WabaId | String | Sí | ID de la WABA. Nota Después de crear una WABA, obtenga su ID en la plataforma Business Manager. |
TemplateCode | String | Sí | Código de la plantilla. Nota Obtenga el código de la plantilla en la página Template Design de la consola de Chat App Message Service o mediante la operación ListChatappTemplate. |
Language | String | Sí | Idioma de la plantilla. |
AuditStatus | String | Sí | Estado de revisión de la plantilla de mensajes. Valores válidos:
|
Reason | String | No | Motivo del rechazo en la revisión. Nota Se devuelve un valor cuando el valor de retorno de AuditStatus es fail. |
Type | String | Sí | Tipo de notificación. Valores válidos:
Nota Si el valor de retorno de Type es template, los parámetros del informe de revisión de V2 coinciden con los del informe de revisión de V1. |
PhoneNumber | String | No | Número telefónico. Nota
|
Status | String | No | Estado. Nota
|
CurrentLimit | String | No | Cantidad máxima de mensajes que el número telefónico puede enviar por día. Nota
|
Respuesta
Su endpoint debe devolver un código de estado HTTP 200 en un plazo máximo de 3 segundos. El cuerpo de la respuesta debe ser un objeto JSON con el formato a continuación. De lo contrario, el sistema considera que el envío falló y lo reintenta.
Ejemplo de respuesta
{
"code" : 0,
"msg" : "Successful"
}
Parámetros de la respuesta
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
|
code |
Number |
Sí |
Código de respuesta. |
|
msg |
String |
No |
Descripción del código de respuesta. |
Reintentos
Si falla el intento inicial de envío, el servicio reintenta la solicitud después de 1 minuto y nuevamente tras 5 minutos. Un intento se considera con errores si su endpoint devuelve un código de estado HTTP distinto de 200 o si la solicitud excede el tiempo de espera. Después de tres intentos con errores, el servicio deja de reintentar.