ListGroupChatMessages - 查询消息列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

查询Chat消息记录。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
JobId	string	否	话务 ID。	chat-65382141036853491
SortOrder	string	否	排序方式，默认为降序。枚举值： ASC：升序。 DESC：降序。	DESC
InstanceId	string	否	呼叫中心实例。	ccc-test
PageSize	integer	否	分页大小，范围 1-100。	10
NextPageToken	string	否	下一页标识，32 位 UUID。请求第一页时，NextPageToken 为空；请求后续文件时需传入前一页查询结果中的 NextPageToken 值。	b2ad450b116e4f8396e58108acf5c020

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	2263B273-AC1B-44EB-BA98-87F2322C6780
HttpStatusCode	integer	HTTP 请求返回的响应状态码，200 表示请求成功。	200
Message	string	响应信息。	无
Code	string	响应码。	OK
Data	object	数据。
Messages	array<object>	消息列表。
GroupChatMessage	object	消息体。
JobId	string	话务 ID。	chat-65382141036853491
SenderId	string	消息发送者用户 ID。	64bb4ececc34fc5ec1ca1153
SenderType	string	发送方类型。枚举值 ADMIN：系统 CUSTOMER：访客 AGENT：坐席	CUSTOMER
Timestamp	long	消息时间戳，格式是 Unix 时间戳，单位毫秒。	1696126980371
Content	string	内容信息。	{"variables":{},"text":"<p>好的，不客气</p>","contentType":"Text","subContentType":"richtext"}
SenderName	string	发送者名称。	test-agent@test-instanceId
SenderAvatarUrl	string	发送者头像地址。	http://xxxxx.com
Recalled	boolean	是否被撤回。	false
NextPageToken	string	下一页标识。	54d1a616d95a4a01ba58967a9115b649

示例

正常返回示例

JSON格式

{
  "RequestId": "2263B273-AC1B-44EB-BA98-87F2322C6780",
  "HttpStatusCode": 200,
  "Message": "无",
  "Code": "OK",
  "Data": {
    "Messages": [
      {
        "JobId": "chat-65382141036853491",
        "SenderId": "64bb4ececc34fc5ec1ca1153",
        "SenderType": "CUSTOMER",
        "Timestamp": 1696126980371,
        "Content": "{\"variables\":{},\"text\":\"<p>好的，不客气</p>\",\"contentType\":\"Text\",\"subContentType\":\"richtext\"}",
        "SenderName": "test-agent@test-instanceId",
        "SenderAvatarUrl": "http://xxxxx.com",
        "Recalled": false
      }
    ],
    "NextPageToken": "54d1a616d95a4a01ba58967a9115b649"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Permission.Unauthorized	You are not authorized to perform this action. %s privileges are required.	您无权执行此操作。必须具有指定权限。

访问错误中心查看更多错误码。