ListWaitingChats - 获取队列中的聊天

坐席通过ListWaitingChats获取队列中等待分配或认领的聊天。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
SkillGroupIdListstring

技能组 ID 列表。

["skillgroup1@ccc-test", "skillgroup2@ccc-test"]

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

03C67DAD-EB26-41D8-949D-9B0C470FB716
Dataarray<object>

返回数据。

Chatobject

会话信息。

ChatConversationIdstring

聊天会话 ID。

$23086709$EAUNIT
BeingAssignedboolean

会话是否已分配坐席。

false
JobIdstring

话务 ID。

chat-434537064047960064
EnqueueTimelong

进入队列时刻,格式为 Unix 时间戳,单位毫秒。

1718868572094
AccessChannelIdstring

网络业务渠道 ID。

843073c2-*****-49fb-a616-738ddddfebdc
AccessChannelTypestring

网络业务渠道类型。

Web
UserListarray<object>

用户列表。

Userobject

用户。

UserNamestring

用户姓名。

访客-1c***
UserIdstring

用户 ID。

c361765f-******-4e07-b81c-4b5d9183fac6
UserTypestring

用户类型。

CUSTOMER
AvatarUrlstring

头像链接。

Messagesarray<object>

消息列表。

Messageobject
SenderIdstring

消息发送用户 ID。

c361765f-******-4e07-b81c-4b5d9183fac6
Contentstring

内容信息。

测试消息
SenderTypestring

发送方类型。取值:

  • CUSTOMER:访客
  • AGENT:坐席
{"variables":{},"text":"<p>这种的名片选单面还是双面</p>"}
SkillGroupIdstring

技能组信息。

skill@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "03C67DAD-EB26-41D8-949D-9B0C470FB716",
  "Data": [
    {
      "ChatConversationId": "$23086709$EAUNIT",
      "BeingAssigned": false,
      "JobId": "chat-434537064047960064",
      "EnqueueTime": 1718868572094,
      "AccessChannelId": "843073c2-*****-49fb-a616-738ddddfebdc",
      "AccessChannelType": "Web",
      "UserList": [
        {
          "UserName": "访客-1c***",
          "UserId": "c361765f-******-4e07-b81c-4b5d9183fac6\n",
          "UserType": "CUSTOMER",
          "AvatarUrl": "无"
        }
      ],
      "Messages": [
        {
          "SenderId": "c361765f-******-4e07-b81c-4b5d9183fac6",
          "Content": "测试消息",
          "SenderType": "{\"variables\":{},\"text\":\"<p>这种的名片选单面还是双面</p>\"}"
        }
      ],
      "SkillGroupId": "skill@ccc-test"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。
400Parameter.BlankThe parameter %s must not be null or empty.该参数不能为null值。
400Parameter.NullThe parameter %s may not be null.该参数不能为null值.
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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