ClaimChat - 认领聊天

更新时间:2025-02-07 11:47:31

调用ClaimChat认领指定实例下指定话务ID对应的聊天。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
SkillGroupIdstring

按技能组 ID 过滤。

skillgroup@ccc-test
JobIdstring

话务 ID。

chat-65382141036853491

返回参数

名称类型描述示例值
名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E
Paramsarray

响应参数列表。

Paramstring

响应参数。

Dataobject

数据。

ContextIdlong

系统自增 ID,客户无需关心。

123456789
UserContextobject

坐席上下文环境。

Heartbeatlong

上次收到坐席心跳的时间,格式为 Unix 时间戳,单位毫秒。

1609136956378
Extensionstring

坐席分机号。

8032****
WorkModestring

工作模式。Chat 场景无需关心。

枚举值:

  • ON_SITE:场内模式。
  • OFF_SITE:场外模式。
  • OFFICE_PHONE:办公电话模式。
ON_SITE
DeviceIdstring

设备 ID。

CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8
UserIdstring

坐席 ID。

userId@ccc-test
Reservedlong

坐席最近一次被预定的时间,格式为 Unix 时间戳,单位毫秒。

false
BreakCodestring

小休状态码。

Warm-up
InstanceIdstring

实例 ID。

ccc-test
OutboundScenarioboolean

仅外呼场景。Chat 业务无需关心。

false
DeviceStatestring

设备状态。

ONLINE
Mobilestring

坐席的个人电话号码。Chat 场景无需关心。

18******102
JobIdstring

话务 ID。

chat-65382141036853491
UserStatestring

座席状态。

枚举值:

  • READY:空闲。
  • WORKING:话后处理中。
  • BREAK:小休。
  • OFFLINE:离线。
  • TALKING:聊天中。
  • RINGING:聊天进线中。
TALKING
SignedSkillGroupIdListarray

坐席签入的技能组 ID 列表。

SkillGroupIdstring

技能组 ID。

skg-default@ccc-test
ChatContextsarray<object>

会话上下文环境。

ChatContextobject
InstanceIdstring

实例 ID。

ccc-test
JobIdstring

话务 ID。

chat-65382141036853491
ChatTypestring

会话类型。

INBOUND
CallVariablesstring

随路数据。

AccessChannelIdstring

网络业务渠道 ID。

226****-cbb6-****-8fea-1e71baf7bfa7
AccessChannelTypestring

网络业务渠道类型。

Web
AccessChannelNamestring

网络业务渠道名字。

测试渠道
BeingAssignedboolean

会话是否已分配坐席。

true

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E",
  "Params": [
    "无"
  ],
  "Data": {
    "ContextId": 123456789,
    "UserContext": {
      "Heartbeat": 1609136956378,
      "Extension": "8032****\n",
      "WorkMode": "ON_SITE",
      "DeviceId": "CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8",
      "UserId": "userId@ccc-test",
      "Reserved": 0,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "DeviceState": "ONLINE",
      "Mobile": "18******102",
      "JobId": "chat-65382141036853491\n",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skg-default@ccc-test"
      ]
    },
    "ChatContexts": [
      {
        "InstanceId": "ccc-test",
        "JobId": "chat-65382141036853491\n",
        "ChatType": "INBOUND",
        "CallVariables": "无",
        "AccessChannelId": "226****-cbb6-****-8fea-1e71baf7bfa7",
        "AccessChannelType": "Web",
        "AccessChannelName": "测试渠道",
        "BeingAssigned": true
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s must not be null.-
404NotExists.ChannelIdThe specified channel %s does not exist in call %s.通话中不存在指定的Channel信息。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.JobIdThe call %s does not exist.指定的通话信息不存在。
500InternalService.CTIAn internal CTI service error occurred.-

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等