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

Modifica una plantilla de mensajes. Solo se pueden modificar las plantillas que no se hayan revisado o que no hayan superado la revisión.

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

Los cambios en el estado y la calidad de una plantilla pueden monitorearse a través de MNS o HTTP. Para obtener más información, consulte Mensajes de recibo.

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:ModifyChatappTemplate

update

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Components	array<object>	Sí	La lista de componentes de la plantilla de mensaje. Nota Cuando Category se establece en AUTHENTICATION, Components no puede contener un nodo con Type establecido en HEADER. Cuando Type se establece en BODY o FOOTER, si el contenido de Text está vacío, el contenido se genera automáticamente.
	array<object>	No	El componente de la plantilla de mensaje.
HasExpiration	boolean	No	Especifica si la plantilla LTO tiene un tiempo de caducidad.	true
ThumbUrl	string	No	La URL de la miniatura de un mensaje de video de Viber.	https://img.png
FileName	string	No	El nombre del archivo. Puede especificar un nombre de archivo cuando Type se establece en Header y Format se establece en DOCUMENT.	txt.txt
Text	string	No	El texto del mensaje que se enviará.	IMAGE
Duration	integer	No	La duración del video de un mensaje de video de Viber. Valores válidos: 0 a 600.	120
Url	string	No	La URL del recurso multimedia.	https://img.png
Caption	string	No	La descripción. Puede agregar una descripción cuando Type se establece en Header y Format se establece en IMGAGE, DOCUMENT o VIDEO.	test
AddSecretRecommendation	boolean	No	Especifica si se debe mostrar una recomendación de seguridad encima del texto del cuerpo, que aconseja a los usuarios no compartir el código de verificación. Este parámetro solo es válido para las plantillas de WhatsApp cuando Category se establece en Authentication y Component Type se establece en Body.	false
Type	string	Sí	El tipo de componente.\nValores válidos: BODY, HEADER, FOOTER y BUTTONS.	HEADER
Format	string	No	El formato.\nValores válidos:\n- TEXT: texto.\n- IMGAGE: imagen.\n- DOCUMENT: documento.\n- VIDEO: video.	body
CodeExpirationMinutes	integer	No	El periodo de validez del código de verificación en la plantilla de autenticación de WhatsApp, en minutos. Este parámetro solo es válido para los mensajes de WhatsApp cuando Category se establece en Authentication y Component Type se establece en Footer. La información se muestra en la sección Footer.	10
FileType	string	No	El tipo de archivo de un mensaje de archivo de Viber.	txt
Buttons	array<object>	No	La lista de botones. Este parámetro solo es aplicable a los componentes BUTTONS. Nota Reglas de cantidad de botones de WhatsApp: Cuando el tipo de plantilla de WhatsApp es MARKETING o UTILITY, se permite un máximo de 10 botones. Solo se permite un botón PHONE_NUMBER. Se permite un máximo de dos botones URL. Los botones QUICK_REPLY no se pueden mezclar en orden aleatorio con botones PHONE_NUMBER o URL.
	array<object>	No	El botón.
AutofillText	string	No	El texto del botón para la operación de autocompletado de WhatsApp. Este parámetro es obligatorio para las plantillas de WhatsApp cuando Category se establece en Authentication y Button Type se establece en ONE_TAP.	Autofill
PackageName	string	No	El nombre del paquete de la aplicación que inicia WhatsApp. Este parámetro es válido para las plantillas de WhatsApp cuando Category se establece en Authentication y Button Type se establece en ONE_TAP o ZERO_TAP.	com.aliyun.pack.***
Text	string	No	El texto del mensaje que se enviará.	CTA
Url	string	No	La URL a la que se accede cuando se hace clic en el botón.	https://aliyun.com
FlowId	string	No	El ID del flujo.	293882
Type	string	Sí	El tipo de botón.\nValores válidos: PHONE_NUMBER (llamada telefónica), URL (botón web) y QUICK_REPLY (respuesta rápida).	URL
CouponCode	string	No	El código de cupón.	23838jdjdj
IsOptOut	boolean	No	Especifica si el botón es un botón de exclusión de marketing. Este parámetro es válido para las plantillas de WhatsApp cuando Category se establece en Marketing y Button Type se establece en QUICK_REPLY. Si un cliente hace clic en este botón y la operación de control de envío está configurada en la plataforma Chat App Message Service, los mensajes de Marketing posteriores no se envían al cliente.	false
FlowAction	string	No	El tipo de evento de datos del flujo.\nValores válidos: NAVIGATE y DATA_EXCHANGE.	NAVIGATE
SignatureHash	string	No	El valor hash de la firma de la aplicación que inicia WhatsApp. Este parámetro es válido para las plantillas de WhatsApp cuando Category se establece en Authentication y Button Type se establece en ONE_TAP o ZERO_TAP.	kdikie9398k
NavigateScreen	string	No	La pantalla de navegación.\nEste parámetro es obligatorio cuando FlowAction se establece en NAVIGATE.	SIGN_UP
PhoneNumber	string	No	El número de teléfono.	8613800**
SupportedApps	array<object>	No	Las aplicaciones compatibles con el botón de código de verificación ONE_TAP o ZERO_TAP.
	object	No	Las aplicaciones compatibles con el botón de código de verificación ONE_TAP o ZERO_TAP.
SignatureHash	string	No	El valor hash de la firma de la aplicación que inicia WhatsApp. Este parámetro es válido para las plantillas de WhatsApp cuando Category se establece en Authentication y Button Type se establece en ONE_TAP o ZERO_TAP.	kdikie9398k
PackageName	string	No	El nombre del paquete de la aplicación que inicia WhatsApp. Este parámetro es válido para las plantillas de WhatsApp cuando Category se establece en Authentication y Button Type se establece en ONE_TAP o ZERO_TAP.	com.aliyun.pack.***
UrlType	string	No	El tipo de URL. Valores válidos:\n- static: URL estática.\n- dynamic: URL dinámica.	static
Cards	array<object>	No	La lista de tarjetas de la plantilla de carrusel.
	array<object>	No	La tarjeta de la plantilla de carrusel.
CardComponents	array<object>	Sí	La lista de componentes de la tarjeta de carrusel.
	array<object>	No	La lista de componentes de la tarjeta de carrusel.
Type	string	Sí	El tipo de componente.\nValores válidos: BODY, HEADER y BUTTONS.	HEADER
Format	string	No	El tipo de Header en la plantilla de carrusel. Solo se admiten IMAGE y VIDEO. El tipo de Header debe ser el mismo en todas las tarjetas.\nValores válidos:\n- IMGAGE: imagen.\n- VIDEO: video.	IMAGE
Text	string	No	El contenido del cuerpo de la tarjeta de carrusel.	body
Buttons	array<object>	No	Los botones de la tarjeta de carrusel. El tipo, el nombre y el orden de los botones deben ser los mismos en todas las tarjetas. Cada tarjeta admite un máximo de 2 botones.
	object	No	Los botones de la tarjeta de carrusel. El tipo, el nombre y el orden de los botones deben ser los mismos en todas las tarjetas. Cada tarjeta admite un máximo de 2 botones.
Type	string	Sí	El tipo de botón de la plantilla Carousel.\nValores válidos: URL, PHONE_NUMBER y QUICK_REQLY.	URL
PhoneNumber	string	No	El número de teléfono.	8613800**
Text	string	No	El texto del botón.	text
UrlType	string	No	El tipo de URL. Valores válidos:\n- static: URL estática.\n- dynamic: URL dinámica.	static
Url	string	No	La URL a la que se accede cuando se hace clic en el botón.	https://aliyun.com/image.png
Url	string	No	La URL de la imagen o video del encabezado.	https://aliyun.com/image.png
Language	string	Sí	El idioma.	en
Example	object	No	Las variables en estructura clave-valor.
	string	No	El ejemplo para crear una plantilla.	StringConcat('a', 'b', 'c')
CustWabaId	string	No	El wabaId del cliente del ISV. Este parámetro quedará obsoleto. Use custSpaceId en su lugar.	939***
IsvCode `deprecated`	string	No	El código de verificación del ISV que se utiliza para verificar si el ISV autorizó una subcuenta.	9393***
TemplateCode	string	No	El código de la plantilla de mensaje.	93938**
CustSpaceId	string	No	El SpaceId del subcliente del ISV o el instanceId de un cliente directo.	cams-did***
Category	string	No	La categoría de la plantilla. Este parámetro puede modificarse al actualizar plantillas de Viber. Este parámetro no es válido para plantillas de WhatsApp.	MARKETING
TemplateType	string	No	El tipo de la plantilla que se modificará. Valores válidos: WHATSAPP VIBER Valor predeterminado: WHATSAPP.	WHATSAPP
MessageSendTtlSeconds	integer	No	El tiempo de vida (TTL) para enviar mensajes de plantilla de autenticación de WhatsApp.	120
TemplateName	string	No	El nombre de la plantilla.	test_name
CategoryChangePaused	boolean	No	Especifica si se debe pausar el envío de plantillas cuando una plantilla de utilidad se cambia al tipo de marketing.	true
ProductSetId	string	No	productSetId.	939***

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-A9486641****
Code	string	El código de respuesta. 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.	None
Data	object	Los datos devueltos.
TemplateCode	string	El código de la plantilla.	8472929283883
TemplateName	string	El nombre de la plantilla.	hello_whatsapp
AccessDeniedDetail	string	Los detalles de la denegación de acceso.	None
Success	boolean	Indica si la solicitud fue exitosa.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "Ninguna",
  "Data": {
    "TemplateCode": "8472929283883",
    "TemplateName": "hello_whatsapp"
  },
  "AccessDeniedDetail": "Ninguna",
  "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.