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

Envía un mensaje de Chat App Message Service.

Descripción de la operación

Puede llamar a esta operación para enviar un mensaje, o enviarlo manualmente en la página Gestión de canales > Gestión > Enviar mensaje.
Antes de llamar a esta operación, asegúrese de haber creado un canal y de contar con una plantilla aprobada.
Para los canales de WhatsApp, debe completar el registro y vinculación de WABA y agregar un número de teléfono.
Para los canales de Messenger, debe completar la vinculación de una cuenta de página pública.
Para los canales de Instagram, debe completar la vinculación de una cuenta profesional.
Para los canales de Viber, debe completar la solicitud de un ID de servicio.

Límite de QPS

El límite de QPS por usuario individual para esta operación es de 250 llamadas por segundo. Si se supera este límite, las llamadas a la API se limitarán, lo que podría afectar su negocio. Llame a esta operación de manera adecuada.

Cambios de estado

Puede monitorear el estado de entrega de mensajes 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:SendChatappMessage

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ChannelType	string	Sí	El tipo de canal. Valores válidos: whatsapp messenger instagram telegram line telegram viber	whatsapp
Type	string	Sí	El tipo de mensaje. Valores válidos: template: una plantilla de mensaje aprobada en la consola. Este tipo de mensaje se puede enviar en cualquier momento. message: un mensaje en cualquier formato. Este tipo de mensaje solo se puede enviar dentro de las 24 horas posteriores a la recepción del último mensaje del usuario. Importante Cuando Type se establece en template, debe especificar TemplateCode. Cuando Type se establece en message, debe especificar MessageType.	message
MessageType	string	No	El tipo de mensaje detallado cuando Type se establece en message. Valores válidos: WHATSAPP text: mensaje de texto. image: mensaje de imagen. video: mensaje de video. audio: mensaje de audio. document: mensaje de documento. interactive: mensaje interactivo. location: mensaje de ubicación. contacts: mensaje de contactos. reaction: mensaje de reacción. sticker: mensaje de sticker. typing_indicator: mensaje de indicador de escritura. pin: mensaje de fijar o desfijar (solo mensajes de grupo). carousel: mensaje de carrusel. VIBER text: mensaje de texto. image: mensaje de imagen. text_image_button: mensaje de texto + imagen + botón. text_button: mensaje de texto + botón. document: mensaje de documento. video: mensaje de video. text_video: mensaje de texto + video. text_video_button: mensaje de texto + video + botón. text_image: mensaje de texto + imagen. MESSENGER / INSTAGRAM text: mensaje de texto. image: mensaje de imagen. video: mensaje de video. document: mensaje de documento. audio: mensaje de audio. interactive: mensaje interactivo. couponTemplate: mensaje de plantilla de cupón. regularTemplate: mensaje de plantilla estándar. quickReply: mensaje de respuesta rápida. buttonTemplate: mensaje de plantilla de botón. TELEGRAM text: mensaje de texto. image: mensaje de imagen. video: mensaje de video. audio: mensaje de audio. document: mensaje de documento. location: mensaje de ubicación. gif: mensaje de GIF animado. sticker: mensaje de sticker. interactive: mensaje personalizado de paso directo de Telegram. LINE text: mensaje de texto. image: mensaje de imagen. video: mensaje de video. audio: mensaje de audio. buttons: mensaje de botón. confirm: mensaje de confirmación. carousel: mensaje de carrusel. imageCarousel: mensaje de carrusel de imágenes. quickReply: mensaje de respuesta rápida. sticker: mensaje de sticker. location: mensaje de ubicación. textV2: mensaje de texto (V2). coupon: mensaje de cupón. imagemap: mensaje de mapa de imágenes. flex: mensaje flexible. interactive: mensaje personalizado de paso directo de LINE. Nota Para obtener más información, consulte los tipos de mensajes admitidos por LINE	text
TemplateCode	string	No	El código de la plantilla. Puede ver el código de la plantilla en la página Gestión de canales > Gestión > Diseño de plantillas.	1119***************
Language	string	No	El idioma. Para consultar una lista de códigos de idioma, consulte Códigos de idioma.	en
From	string	Sí	El número del remitente. Cuando ChannelType es whatsapp, este es el número de teléfono registrado y vinculado con WhatsApp. Puede verlo en la página Gestión de canales > Gestión > Gestión de WABA > Gestión de números. Cuando ChannelType es messenger, este es el ID de la página. Puede verlo en la página Gestión de canales > Gestión > Página pública. Cuando ChannelType es instagram, este es el ID de la cuenta profesional de Instagram (ID de cuenta). Puede verlo en la página Gestión de canales > Gestión > Cuenta profesional. Cuando ChannelType es viber, este es el ID de servicio de Viber. Puede verlo en la página Gestión de canales > Gestión > Gestión de ID de servicio. Cuando ChannelType es telegram, este es el ID del bot de Telegram. Puede verlo en la página Gestión de canales > Gestión > Gestión de bots. Cuando ChannelType es line, este es el ID del canal de LINE. Puede verlo en la página Gestión de canales > Gestión > Cuenta oficial de LINE.	861387777****
To	string	Sí	El número del destinatario. Cuando ChannelType es whatsapp, este es el número de teléfono o BSUID del destinatario del mensaje. Cuando ChannelType es messenger, este es el ID de usuario con ámbito de página generado cuando el usuario interactúa con la página de Facebook. Cuando ChannelType es instagram, este es el ID de usuario de Instagram generado cuando el usuario interactúa con la cuenta comercial o de creador de Instagram. Cuando ChannelType es viber, este es el número de teléfono del destinatario del mensaje. Cuando ChannelType es telegram, este es el chatId de Telegram. Cuando ChannelType es line, este es el ID de usuario de LINE.	861388988****
TemplateParams	object	No	La colección de parámetros de plantilla.
	string	No	El parámetro de plantilla. Tiene formato clave-valor, donde Key es el nombre del parámetro y Value es el valor del parámetro.	{ "param1": "value1", "param2": "value2" }
Content	string	No	El contenido del mensaje. Notas sobre mensajes de WhatsApp: Cuando messageType es text, el campo text es obligatorio y no se debe especificar el campo Caption. Cuando messageType es image, el campo Link es obligatorio. Cuando messageType es video, el campo Link es obligatorio. Cuando messageType es audio, el campo Link es obligatorio y el campo Caption no es válido. Cuando messageType es document, los campos Link y FileName son obligatorios y el campo Caption no es válido. Cuando messageType es interactive, los campos type y action son obligatorios. Cuando messageType es contacts, el campo name es obligatorio. Cuando messageType es location, los campos longitude y latitude son obligatorios. Cuando messageType es sticker, el campo Link es obligatorio y los campos Caption y FileName no son válidos. Cuando messageType es reaction, los campos messageId y emoji son obligatorios. Notas sobre mensajes de Messenger: Cuando messageType es text, el campo text es obligatorio. Cuando messageType es image, video, audio o document, el campo link es obligatorio. Notas sobre mensajes de Instagram: Cuando messageType es text, el campo text es obligatorio. Cuando messageType es image, video o audio, el campo link es obligatorio. Notas sobre mensajes de Viber: Cuando messageType es text, el campo text es obligatorio. Cuando messageType es image, el campo link es obligatorio. Cuando messageType es video, los campos link, thumbnail, fileSize y duration son obligatorios. Cuando messageType es document, los campos link, fileName y fileType son obligatorios. Cuando messageType es text_button, los campos text, caption y action son obligatorios. Cuando messageType es text_image_button, los campos text, link, caption y action son obligatorios. Cuando messageType es text_video, los campos text, link, thumbnail, fileSize y duration son obligatorios. Cuando messageType es text_video_button, los campos text, link, thumbnail, fileSize, duration y caption son obligatorios, y el campo action no debe estar vacío. Notas sobre mensajes de Telegram: Cuando messageType es text, el campo text es obligatorio. Cuando messageType es image, video, audio, gif o sticker, el campo link es obligatorio. Cuando messageType es location, los campos latitude y longitude son obligatorios. Cuando messageType es interactive, el campo type es obligatorio. Puede enviar varios tipos de mensajes de Telegram. Ejemplo: {"type": "sendPhoto", "sendPhoto": {"photo":"http://img.png","caption":"21"}}. Esto se puede usar para enviar un mensaje de tipo Photo. Para obtener más información sobre los tipos de mensajes, consulte Cuerpo del mensaje de Telegram. Notas sobre mensajes de LINE: Cuando messageType es text o textV2, el campo text es obligatorio. Cuando messageType es image o video, los campos link y previewImageUrl son obligatorios. Cuando messageType es audio, los campos link y duration son obligatorios. Cuando messageType es buttons o confirm, los campos text y actions son obligatorios. Cuando messageType es carousel o imageCarousel, el campo columns es obligatorio. Cuando messageType es quickReply, los campos text y items son obligatorios. Cuando messageType es sticker, los campos packageId y stickerId son obligatorios. Cuando messageType es location, los campos title, address, latitude y longitude son obligatorios. Cuando messageType es coupon, el campo couponId es obligatorio. Cuando messageType es imagemap, los campos baseUrl y altText son obligatorios. Cuando messageType es flex, los campos contents y altText son obligatorios. Cuando messageType es interactive, puede pasar formatos de mensaje admitidos por LINE: Para enviar un solo mensaje, el campo type es obligatorio y los demás campos siguen el formato del cuerpo del mensaje de LINE. Ejemplo: {"type": "text", "text": "test"} Para enviar múltiples mensajes (LINE admite hasta 5 mensajes a la vez), el campo messages es obligatorio. Ejemplo: {"messages": [{"type": "text", "text": "test"}, {"type": "image", "originalContentUrl": "http://img.png", "previewImageUrl": "http://img2.png"}]} Para obtener más información, consulte Cuerpo del mensaje de LINE.	{ "text": "hello,whatsapp", "link": "https://*****", "caption": "", "fileName": "**" }
Payload	array	No	La colección de mensajes de activación de botones. Nota Este parámetro solo es válido para WHATSAPP.	payloadtext1,payloadtext2,payloadtext3
	string	No	El mensaje de activación de un botón en la plantilla.	payloadtext
CustWabaId `deprecated`	string	No	El ID de WABA del cliente ISV. Nota Este parámetro está obsoleto. Utilice CustSpaceId en su lugar. Puede verlo en la página Gestión de canales.	cams-8c8*********
FallBackId	string	No	El ID de la política de respaldo. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Puede ver el ID de la política en la página Estrategia de respaldo.	S0****
FallBackContent	string	No	El contenido de respaldo personalizado. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro.	SMS de respaldo
IsvCode `deprecated`	string	No	El código de verificación de ISV. Nota Este parámetro está obsoleto. Puede ignorarlo.	123123******
CustSpaceId	string	No	El SpaceId del subcliente ISV o el ID de instancia de un cliente directo. Puede verlo en la página Gestión de canales.	cams-8c8*********
ContextMessageId	string	No	El ID del mensaje al que se responde. Este es el ID de un mensaje enviado o recibido anteriormente.	61851ccb2f1365b16aee****
TrackingData	string	No	Los datos de seguimiento personalizados pasados para los tipos de mensajes de Viber. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Nota Válido solo para VIBER.	Datos de seguimiento
Label	string	No	El tipo de mensaje de Viber. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Valores válidos: pormotion: mensajes de marketing o promocionales. transaction: mensajes de notificación. Nota Válido solo para VIBER.	promotion
Ttl	integer	No	El período de tiempo de espera de envío del mensaje de Viber. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Unidad: segundos. Valores válidos: de 30 a 1,209,600. Nota Válido solo para VIBER.	50
Tag	string	No	La información de etiqueta. Información de etiqueta personalizada al enviar mensajes de Viber. Nota Válido solo para VIBER.	tag
TaskId	string	No	El ID de tarea personalizado.	10000****
FallBackDuration	integer	No	El tiempo de activación del respaldo. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Si el mensaje no devuelve una confirmación de entrega dentro del tiempo especificado, se activa el respaldo. Si no se especifica este parámetro, el respaldo se activa solo cuando el mensaje no se envía o se recibe un informe de estado de error. Unidad: segundos. Valor mínimo: 60. Valor máximo: 43,200.	120
ProductAction	object	No	La información del producto. Este parámetro solo es válido para tipos de canal de WhatsApp. Se refiere a la información del producto que cargó en Meta. Nota Válido solo para WHATSAPP.
ThumbnailProductRetailerId	string	No	El ID del catálogo de productos. Puede obtenerlo llamando a la operación ListProductCatalog.	skkks99****
Sections	array<object>	No	La lista de categorías de productos (hasta 10 categorías y 30 productos).
	array<object>	No	La categoría de producto.
Title	string	No	El nombre de la categoría. Puede verlo en la página Gestión de canales > Gestión > Gestión de catálogos > Gestión de productos, u obtenerlo llamando a la operación ListProduct.	abcd
ProductItems	array<object>	No	La lista de artículos de producto.
	object	No	La información del artículo de producto.
ProductRetailerId	string	No	El ID del producto. Puede verlo en la página Gestión de canales > Gestión > Gestión de catálogos > Gestión de productos, u obtenerlo llamando a la operación ListProduct.	ksi3****
FallBackRule	string	No	La regla de respaldo. Este parámetro es para el sitio internacional de China. Los usuarios del sitio de China pueden ignorar este parámetro. Valores válidos: undelivered: el respaldo se activa cuando el mensaje no se puede entregar al endpoint (la validación de plantilla y parámetros debe pasar durante el estado de envío; las plantillas o números bloqueados no se validan). Esta regla se usa de forma predeterminada cuando el valor del parámetro está vacío. sentFailed: el respaldo también se activa cuando falla la validación de la plantilla o de la variable de plantilla. Solo se validan estrictamente los parámetros channelType, type, messageType, to y from (verificación de existencia).	undelivered
FlowAction	object	No	El objeto de mensaje Flow. Nota Válido solo para WHATSAPP.
FlowActionData	object	No	La colección de parámetros predeterminados de Flow.
	any	No	El parámetro predeterminado de Flow. Tiene formato clave-valor, donde Key es el nombre del parámetro y Value es el valor del parámetro.	{ "name": "name" }
FlowToken	string	No	La información personalizada del token de Flow.	kde****
TemplateName	string	No	El nombre de la plantilla. Puede ver el nombre de la plantilla en la página Gestión de canales > Gestión > Diseño de plantillas.	test_name
RecipientType	string	No	El tipo de destinatario. Valores válidos: individual: un individuo. group: un grupo. userId: BSUID de WhatsApp. Válido solo para WHATSAPP.	individual
MessageCampaignId	string	No	El ID del mensaje de campaña. Nota Este parámetro es un parámetro de prueba que no está completamente disponible. Ignore este parámetro.	123123********
AdAccountId	string	No	El ID de la cuenta publicitaria de Meta. Nota Este parámetro es un parámetro de prueba que no está completamente disponible. Ignore este parámetro.	123123********
TokenType	string	No	El tipo de token. Nota Este parámetro es un parámetro de prueba que no está completamente disponible. Ignore este parámetro.	bearer
Category	string	No	El tipo de mensaje (para envío directo de WhatsApp). Aviso No especifique este parámetro si no es un cliente invitado por Meta. De lo contrario, el envío del mensaje fallará.	UTILITY

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
AccessDeniedDetail	string	Los detalles de acceso denegado.	Ninguna
RequestId	string	El ID de la solicitud.	90E63D28-E31D-1EB2-8939-A94866******
Message	string	El mensaje de error.	User not authorized to operate on the specified resource
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
MessageId	string	El ID del mensaje.	61851ccb2f1365b16aee****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Message": "User not authorized to operate on the specified resource.",
  "Code": "OK",
  "MessageId": "61851ccb2f1365b16aee****"
}

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.