CreateChatappTemplate - Chat App Message Service - Centro de documentación de Alibaba Cloud

Crea una plantilla de mensajes. Una vez aprobada la plantilla, puede utilizarla para enviar mensajes.

Descripción de la operación

Límite de QPS

El límite de QPS por usuario para esta operación es de 50 llamadas por segundo. Si se supera este límite, las llamadas a la API se limitan, lo que puede afectar su negocio. Invoque esta operación según sea necesario.

Cambios de estado

Puede monitorear los cambios de estado y calidad de la plantilla mediante MNS o HTTP. Para obtener más información, consulte Mensajes de confirmación.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

cams:CreateChatappTemplate

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Category	string	Sí	Categoría de plantilla de WhatsApp. Valores válidos: UTILITY: relacionada con transacciones. MARKETING: marketing. AUTHENTICATION: verificación de identidad. Categoría de plantilla de Viber. Valores válidos: UTILITY: relacionada con transacciones. MARKETING: marketing. AUTHENTICATION: verificación de identidad.	UTILITY
Components	array<object>	Sí	La lista de componentes de la plantilla de mensajes. Nota Cuando Category=AUTHENTICATION, Components no puede contener nodos con Type=HEADER. Cuando Type=BODY o FOOTER, el contenido de Text debe estar vacío.
	array<object>	No	La lista de componentes.
HasExpiration	boolean	No	Especifica si el código de cupón tiene una hora de caducidad. Este parámetro se utiliza cuando type = LIMITED_TIME_OFFER.	true
ThumbUrl	string	No	La miniatura para los mensajes de video de Viber.	https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100
FileName	string	No	El nombre del archivo.	Video de entrega exprés
Text	string	No	El texto del mensaje que se enviará. Nota Para el tipo WHATSAPP, este valor de propiedad está vacío cuando Category=AUTHENTICATION.	hola whatsapp
Duration	integer	No	La duración (en segundos) de los mensajes de video de Viber. Valores válidos: 0 a 600.	120
Url	string	No	La ruta del recurso multimedia. Nota Para el tipo Viber, el tamaño de imagen recomendado es 800 px × 800 px.	https://image.developer.aliyundoc.com
Caption	string	No	La descripción del archivo.	Este es un video
AddSecretRecommendation	boolean	No	Válido para plantillas de WhatsApp cuando Category es AUTHENTICATION y Component Type es Body. Muestra un aviso encima del Body que aconseja no compartir el código de verificación con otras personas.	true
Type	string	Sí	El tipo de componente. Valores válidos: BODY HEADER FOOTER BUTTONS CAROUSEL LIMITED_TIME_OFFER Nota Para las plantillas de WhatsApp, el componente BODY no puede exceder los 1024 caracteres. Los componentes HEADER y FOOTER no pueden exceder los 60 caracteres. Para las plantillas de Viber, los tipos FOOTER, CAROUSEL y LIMITED_TIME_OFFER no son válidos. Para las plantillas de Viber, las imágenes, los videos y los archivos se colocan en el HEADER (el dispositivo muestra las imágenes debajo del texto). El texto se coloca en el BODY.	BODY
Format	string	No	El tipo de recurso multimedia. TEXT: texto IMAGE: imagen DOCUMENT: documento VIDEO: video	TEXT
CodeExpirationMinutes	integer	No	El periodo de validez (en minutos) del código de verificación para plantillas AUTHENTICATION de WhatsApp. Válido solo para mensajes de WhatsApp cuando Category es AUTHENTICATION y Component Type es Footer (se muestra en la posición del Footer).	5
FileType	string	No	El tipo de archivo para los mensajes de archivo de Viber.	docx
Buttons	array<object>	No	La lista de botones. Aplicable solo a componentes BUTTONS. Nota Reglas de cantidad de botones de WhatsApp: Para las plantillas de WhatsApp con Category MARKETING/UTILITY, se permite un máximo de 10 botones. Solo se permite 1 botón PHONE_NUMBER. Se permite un máximo de 2 botones URL. Los botones QUICK_REPLY no pueden aparecer en orden mixto con botones PHONE_NUMBER/URL. Nota Reglas de cantidad de botones de Viber: Solo se admite el tipo URL y solo se permite un botón. Cuando el HEADER contiene un VIDEO, el tipo de botón es URL, pero no puede establecer una dirección URL.
	array<object>	No	La definición del botón.
AutofillText	string	No	Obligatorio para plantillas de WhatsApp cuando Category es AUTHENTICATION y Button Type es ONE_TAP/ZERO_TAP. El texto del botón para la operación de Autocompletado de WhatsApp.	Autocompletar
PackageName `deprecated`	string	No	Utilice las propiedades bajo SupportedApps en su lugar.	com.demo
Text	string	No	El nombre para mostrar del botón.	Llámame
Url	string	No	La URL que se visita al hacer clic en el botón de enlace.	https://example.com
FlowId	string	No	El ID de flujo.	479884093605****
Type	string	Sí	El tipo de botón. PHONE_NUMBER: botón de marcación telefónica URL: botón web QUICK_REPLY: botón de respuesta rápida COPY_CODE: copiar código de verificación o código de cupón ONE_TAP: botón de autocompletado para plantillas AUTHENTICATION ZERO_TAP: botón de autocompletado para plantillas AUTHENTICATION MPM: catálogo de múltiples productos CATALOG: catálogo FLOW: abrir flujo de WhatsApp Nota Para las plantillas de WhatsApp con Category AUTHENTICATION, solo se permite un botón, y el tipo solo puede ser COPY_CODE/ONE_TAP. Cuando se selecciona COPY_CODE, Text es obligatorio. Cuando se selecciona ONE_TAP, son obligatorios Text (se muestra cuando la aplicación destino no está instalada en el dispositivo, representa el nombre del botón de copiar código de verificación), SignatureHash, PackageName y AutofillText. Las plantillas de Viber solo permiten un botón, y debe ser de tipo URL.	PHONE_NUMBER
CouponCode	string	No	El valor del código de cupón. Solo se admiten letras y números. Puede pasar una variable como $(couponCode) y proporcionar el código de cupón real al enviar.	120293
IsOptOut	boolean	No	Válido para plantillas de WhatsApp cuando Category es Marketing y Button type es QUICK_REPLY. Indica que el botón es un botón de exclusión de marketing. Si el cliente hace clic en este botón y el control de envío está configurado en ChatApp, no se enviarán mensajes de Marketing posteriores al cliente.	false
FlowAction	string	No	El tipo de evento de datos de Flow. Valores válidos: DATA_EXCHANGE: intercambio de datos. NAVIGATE: navegación.	NAVIGATE
SignatureHash `deprecated`	string	No	Utilice las propiedades bajo SupportedApps en su lugar.	wi299382
NavigateScreen	string	No	La pantalla de navegación. Obligatorio cuando FlowAction=NAVIGATE.	DETAILS
PhoneNumber	string	No	El número de teléfono. Válido solo cuando el tipo de botón es PHONE_NUMBER.	+861368897****
SupportedApps	array<object>	No	La lista de aplicaciones compatibles.
	object	No
SignatureHash	string	No	Obligatorio para plantillas de WhatsApp cuando Category es AUTHENTICATION y Button Type es ONE_TAP/ZERO_TAP. El valor hash de firma para la aplicación invocada por WhatsApp.	ieid83kdiek
PackageName	string	No	Obligatorio para plantillas de WhatsApp cuando Category es AUTHENTICATION y Button Type es ONE_TAP/ZERO_TAP. El nombre del paquete de la aplicación invocada por WhatsApp.	com.kuaidian.waimaistaff
UrlType	string	No	El tipo de URL. static: estática dynamic: dinámica	static
Cards	array<object>	No	La lista de tarjetas de la plantilla Carousel.
	array<object>	No	El objeto de tarjeta de la plantilla Carousel.
CardComponents	array<object>	No	La lista de componentes en la tarjeta Carousel.
	array<object>	No	El objeto de componente en la tarjeta Carousel.
Type	string	Sí	El tipo de componente. Valores válidos: BODY HEADER BUTTONS	BODY
Format	string	No	El tipo de recurso multimedia. Válido cuando Type = HEADER. IMAGE: imagen VIDEO: video	IMAGE
Text	string	No	El contenido BODY en la tarjeta Carousel.	Who is the very powerful team
Buttons	array<object>	No	La lista de botones. Aplicable solo a componentes BUTTONS. Cada tarjeta Carousel puede tener un máximo de dos botones.
	object	No	El objeto de botón.
Type	string	Sí	El tipo de botón. PHONE_NUMBER: botón de marcación telefónica URL: botón web QUICK_REPLY: botón de respuesta rápida	PHONE_NUMBER
PhoneNumber	string	No	El número de teléfono.	+86138007****
Text	string	No	El texto del botón.	Call me
UrlType	string	No	El tipo de URL. static: Estática. dynamic: Dinámica.	static
Url	string	No	La URL a la que se accede al hacer clic en el botón.	https://alibaba.com/xx
Url	string	No	La ruta del material.	https://alibaba.com/img.png
Name	string	Sí	El nombre de la plantilla.	hello_whatsapp
Language	string	Sí	El idioma de la plantilla. Para obtener información detallada sobre los códigos de idioma, consulte Códigos de idioma.	en
Example	object	No	El ejemplo para crear la plantilla.	hello_whatsapp
	string	No	El ejemplo para crear la plantilla.	StringConcat('a', 'b', 'c')
TemplateType	string	Sí	El tipo de plantilla. Valores válidos: WHATSAPP VIBER	WHATSAPP
CustWabaId `deprecated`	string	No	El WabaId del cliente ISV. Nota Parámetro desaprobado. Use CustSpaceId en su lugar.	65921621816****
IsvCode `deprecated`	string	No	El código de verificación ISV, utilizado para verificar si la subcuenta está autorizada por el ISV.	skdi3kksloslikdkkdk
CustSpaceId	string	No	El SpaceId del subcliente ISV o el ID de instancia del cliente directo.	293483938849493
AllowCategoryChange `deprecated`	boolean	No	Especifica si se permite que Facebook cambie automáticamente la categoría de la plantilla (para mejorar la tasa de aprobación de plantillas). Esta propiedad solo es válida cuando TemplateType se establece en WHATSAPP. Importante Esta propiedad ha sido desaprobada. WhatsApp ya no admite esta propiedad.	true
MessageSendTtlSeconds	integer	No	El tiempo de vida (TTL) para los mensajes de plantilla en WhatsApp. AUTHENTICATION: los valores válidos oscilan entre 30 y 900. UTILITY: los valores válidos oscilan entre 30 y 43200.	120
CategoryChangePaused	boolean	No	Especifica si se debe pausar el envío de plantillas cuando una plantilla de Utility se cambia al tipo Marketing. Esta propiedad solo es válida para plantillas de WhatsApp.	false
		No	productSetId.	9928**

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	90E63D28-E31D-1EB2-8939-A94866411B2D
Code	string	El código de estado de la solicitud. OK indica que la solicitud fue exitosa. Para otros códigos de error, consulte Códigos de error.	OK
Message	string	El mensaje de error.	User not authorized to operate on the specified resource
Data	object	Los datos devueltos.	{"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}
TemplateCode	string	El código de la plantilla.	SMS_232907****
TemplateName	string	El nombre de la plantilla.	hello_whatsapp
AccessDeniedDetail	string	Los detalles de acceso denegado.	Ninguna
Success	boolean		true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "SMS_232907****",
    "TemplateName": "hello_whatsapp"
  },
  "AccessDeniedDetail": "None",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.