ClaimCall - 分配电话

更新时间:
复制为 MD 格式

调用接口ClaimCall把一个电话分配给一个坐席。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

ccc-test

UserId

string

调用者坐席 ID。

invoker@ccc-test

JobId

string

话务 ID。

job-6538214103685****

SkillGroupId

string

待分配电话的技能组 ID。

test_sg_****@ccc-test

CandidateUserListJson

string

可以认领此电话的座席及对应的技能组列表

[ { "f0": "zeren001@report-test-2", "f1": "desktop-voip-box@report-test-2" } ]

Tags

string

调度专用唯一业务 ID,后续事件通知携带此标志

tags

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK

HttpStatusCode

integer

HTTP 状态码。

200

Message

string

响应信息。

RequestId

string

请求 ID。

93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4

Params

array

错误参数列表。

string

错误参数。

Data

object

数据。

CallContext

object

话务上下文环境。

JobId

string

通话 ID。

job-6538214103685****

InstanceId

string

实例 ID。

ccc-test

ChannelContexts

array<object>

话务通道上下文。

object

话务通道。

ReleaseInitiator

string

话务通道的挂断方,表示该话务通道是谁首先发起的挂断。

1390501****

ChannelState

string

话务通道的状态。

ANSWERED

Destination

string

话务通道的被叫方。

1390501****

UserId

string

坐席 ID。

invoker@ccc-test

Timestamp

integer

话务通道最近一次状态变化的时间戳,格式是 Unix 时间戳,单位毫秒。

1609225718295

ReleaseReason

string

话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自 SIP 协议中定义的响应码,请客户参考 SIP 协议分析挂断原因。

CallType

string

话务通道的通话类型。

OUTBOUND

JobId

string

通话 ID。

job-6573574060089****

ChannelId

string

话务通道 ID。

ch:user:1390501****->8032****:1609138902226:job-653821410368****

Originator

string

话务通道的主叫方。

0830019****

UserExtension

string

坐席分机号。

8059****

ChannelVariables

string

随路数据。

a=b;c=d;

UserContext

object

坐席上下文。

Extension

string

分机号。

0830019****

WorkMode

string

工作模式。

ON_SITE

DeviceId

string

设备 ID。

device-xxxx

JobId

string

通话 ID。

job-6573574060089****

UserId

string

坐席 ID。

user@ccc-test

BreakCode

string

小休状态码。

Customized

InstanceId

string

实例 ID。

ccc-test

OutboundScenario

boolean

是否为场外模式。

false

UserState

string

坐席状态。

Dialing

SignedSkillGroupIdList

array

签入的技能组列表。

string

技能组 ID。

skill@ccc-test

ContextId

integer

上下文 ID。

123456

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "JobId": "job-6538214103685****",
      "InstanceId": "ccc-test",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "1390501****",
          "ChannelState": "ANSWERED",
          "Destination": "1390501****",
          "UserId": "invoker@ccc-test",
          "Timestamp": 1609225718295,
          "ReleaseReason": "无",
          "CallType": "OUTBOUND",
          "JobId": "job-6573574060089****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "Originator": "0830019****",
          "UserExtension": "8059****",
          "ChannelVariables": "a=b;c=d;"
        }
      ]
    },
    "UserContext": {
      "Extension": "0830019****",
      "WorkMode": "ON_SITE",
      "DeviceId": "device-xxxx",
      "JobId": "job-6573574060089****",
      "UserId": "user@ccc-test",
      "BreakCode": "Customized",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "UserState": "Dialing",
      "SignedSkillGroupIdList": [
        "skill@ccc-test"
      ]
    },
    "ContextId": 123456
  }
}

错误码

HTTP status code

错误码

错误信息

描述

404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。

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

变更历史

更多信息,参考变更详情