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

Consulta la lista de mensajes.

Descripción de la operación

Puede llamar a esta operación para consultar la lista de mensajes. También puede ver la lista de mensajes en la consola Gestión de canales > Gestión > Lista de mensajes.
Esta operación de API admite la consulta de la lista de mensajes solo para los canales de WhatsAppy Viber.
Antes de llamar a esta operación, asegúrese de haber creado un canal de WhatsAppo Viber, haber vinculado un número de teléfono o un ID de cuenta de comerciante, haber creado una plantilla que haya aprobado la revisión y haber enviado mensajes a través del canal.

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

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BusinessNumber	string	Sí	El número de teléfono comercial. Para los canales de WhatsApp, consulte el número de teléfono comercial en la consola Gestión de canales > Gestión > Gestión de WABA > Gestión de números de teléfono. Para los canales de Viber, consulte el ID de servicio en la consola Gestión de canales > Gestión > Gestión de cuentas de servicio.	8613800****
StartTimeStr	string	No	La hora de inicio en el formato AAAA-MM-DD HH:mm:ss.	2024-01-01 00:00:00
EndTimeStr	string	No	La hora de fin en el formato AAAA-MM-DD HH:mm:ss.	2024-01-30 00:00:00
StartTime	integer	No	La hora de inicio. Este valor es una marca de tiempo UNIX. Unidad: milisegundos.	1727057232686
EndTime	integer	No	La hora de fin. Este valor es una marca de tiempo UNIX. Unidad: milisegundos.	1727057232686
EventAction	string	No	El tipo de mensaje. Valores válidos: DOWN: mensaje descendente. UP: mensaje ascendente.	UP
UserNumber	string	No	El número de teléfono del usuario. Este es el número de teléfono del usuario que importó al enviar mensajes en la consola Gestión de canales > Gestión > Envío de mensajes.	86138***
ChannelType	string	Sí	El tipo de canal. Valores válidos: whatsapp. viber.	WHATSAPP
ClientAcceptStatus	string	No	El estado de aceptación de mensajes del usuario.	success
TemplateCode	string	No	El código de la plantilla. Consulte el código de la plantilla en la consola Gestión de canales > Gestión > Diseño de plantillas.	9938***
GroupMessageId	string	No	El ID del mensaje por lotes. Consulte el ID del mensaje por lotes en la consola Gestión de canales > Gestión > Lista de mensajes > Lista de envíos por lotes.	9292****
MessageStatus	string	No	El estado del mensaje.	success
CustSpaceId	string	Sí	El ID de espacio del subcliente ISV o el ID de instancia del cliente directo. Consulte el ID de espacio en la consola Gestión de canales.	cams-************
Page	object	Sí	El objeto de paginación.
Size	integer	Sí	El número de entradas por página.	10
Index	integer	Sí	El número de página.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
AccessDeniedDetail	string	Los detalles sobre la denegación de acceso.	None
Message	string	El mensaje de error.	None
RequestId	string	El ID de la solicitud.	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Data	array<object>	La lista de objetos de datos devueltos.
	object	Los datos devueltos.
ConversationId	string	El ID de la conversación.	805a66**************************
BusinessNumber	string	El número de teléfono comercial.	86183********
ClientAcceptStatusName	string	El nombre del estado de aceptación de mensajes.	Success
Message	string	El contenido del mensaje.	test
MessageTypeName	string	El nombre del tipo de mensaje.	interactive
FailReason	string	El motivo del error de envío.	timeout
EventActionName	string	El nombre del tipo de mensaje ascendente o descendente. Valores válidos: DOWN: mensaje descendente. UP: mensaje ascendente.	DOWN
Month	string	El mes del mensaje.	202507
LanguageCode	string	El idioma de la plantilla. Para más idiomas, consulte Códigos de idioma.	en
TemplateName	string	El nombre de la plantilla.	picture_template
MessageType	string	El tipo de mensaje.	INTERACTIVE
SendTime	string	La hora de envío en formato ISO 8601 con un desplazamiento de zona horaria.	2025-07-11T01:16:49.761+00:00
MessageStatusName	string	El nombre del estado del mensaje.	Success
ClientReadStatus	string	El estado de lectura del mensaje.	success
MessageSource	string	El origen del mensaje.	api
FailBackFlag	string	Indica si el mensaje recurre a SMS. Valores válidos: Y: Sí. N: No.	Y
UserNumber	string	El número de teléfono del usuario.	86177********
TemplateCode	string	El código de la plantilla.	1103***************
MessageStatus	string	El estado del mensaje.	success
Type	string	El tipo.	message
FailBackContent	string	El contenido alternativo.	None
EventAction	string	El tipo de mensaje ascendente o descendente.	DOWN
ClientReadStatusName	string	El nombre del estado de lectura del mensaje.	Success
UniqueMessageId	string	El ID único del mensaje.	20250911******************************
ChannelType	string	El tipo de canal.	WHATSAPP
MessageId	string	El ID del mensaje.	202509*******************
Code	string	El código de estado de la solicitud. OK: La solicitud se realizó correctamente. Para otros códigos de error, consulte Códigos de error.	OK
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "AccessDeniedDetail": "Ninguna",
  "Message": "Ninguna",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC",
  "Data": [
    {
      "ConversationId": "805a66**************************",
      "BusinessNumber": "86183********",
      "ClientAcceptStatusName": "Success",
      "Message": "prueba",
      "MessageTypeName": "interactivo",
      "FailReason": "timeout",
      "EventActionName": "DOWN",
      "Month": "202507",
      "LanguageCode": "en",
      "TemplateName": "picture_template",
      "MessageType": "INTERACTIVE",
      "SendTime": "2025-07-11T01:16:49.761+00:00",
      "MessageStatusName": "Success",
      "ClientReadStatus": "success",
      "MessageSource": "api",
      "FailBackFlag": "Y",
      "UserNumber": "86177********",
      "TemplateCode": "1103***************",
      "MessageStatus": "success",
      "Type": "mensaje",
      "FailBackContent": "Ninguna",
      "EventAction": "DOWN",
      "ClientReadStatusName": "Success",
      "UniqueMessageId": "20250911******************************",
      "ChannelType": "WHATSAPP",
      "MessageId": "202509*******************"
    }
  ],
  "Code": "OK",
  "Success": false
}

Códigos de error

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.