首页 云联络中心 开发参考 API参考 API目录 报表 ListGroupChatMessages - 查询消息列表

ListGroupChatMessages - 查询消息列表

更新时间: 2024-10-17 13:14:42

查询Chat消息记录。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
JobIdstring

话务 ID。

chat-65382141036853491
SortOrderstring

排序方式,默认为降序。

枚举值:

ASC:升序。

DESC:降序。

DESC
InstanceIdstring

呼叫中心实例。

ccc-test
PageSizeinteger

分页大小,范围 1-100。

10
NextPageTokenstring

下一页标识,32 位 UUID。请求第一页时,NextPageToken 为空;请求后续文件时需传入前一页查询结果中的 NextPageToken 值。

b2ad450b116e4f8396e58108acf5c020

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2263B273-AC1B-44EB-BA98-87F2322C6780
HttpStatusCodeinteger

HTTP 请求返回的响应状态码,200 表示请求成功。

200
Messagestring

响应信息。

Codestring

响应码。

OK
Dataobject

数据。

Messagesarray<object>

消息列表。

GroupChatMessageobject

消息体。

JobIdstring

话务 ID。

chat-65382141036853491
SenderIdstring

消息发送者用户 ID。

64bb4ececc34fc5ec1ca1153
SenderTypestring

发送方类型。

枚举值

  • ADMIN:系统
  • CUSTOMER:访客
  • AGENT:坐席
CUSTOMER
Timestamplong

消息时间戳,格式是 Unix 时间戳,单位毫秒。

1696126980371
Contentstring

内容信息。

{"variables":{},"text":"<p>好的,不客气</p>","contentType":"Text","subContentType":"richtext"}
SenderNamestring

发送者名称。

test-agent@test-instanceId
SenderAvatarUrlstring

发送者头像地址。

http://xxxxx.com
Recalledboolean

是否被撤回。

false
NextPageTokenstring

下一页标识。

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错误码错误信息描述
403Permission.UnauthorizedYou are not authorized to perform this action. %s privileges are required.您无权执行此操作。 必须具有指定权限。

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

上一篇: ListVoicemails - 获取语音信箱列表 下一篇: 录音