PollUserStatus - 轮询坐席状态

轮询指定实例下指定坐席的坐席状态,一般由前端坐席工作台调用,用于同步坐席状态。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
UserIdstring

坐席 ID。

agent@ccc-test
DeviceIdstring

设备 ID,无意义,可以随便填写。

device

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Paramsarray

响应参数列表。

Paramstring

响应参数。

Dataobject

数据。

ContextIdlong

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

103655
CallContextobject

话务上下文环境。

CallTypestring

通话类型。

枚举值:
  • INBOUND呼入
  • BARGE强插
  • CONSULTANT咨询
  • CONFERENCE会议
  • MONITOR监听
  • INTERNAL内部通话
  • OUTBOUND呼出
  • INTERCEPT强拆
  • BACK2BACK双呼
  • PREDICTIVE预测式外呼
  • COACH辅导
OUTBOUND
InstanceIdstring

实例 ID。

ccc-test
JobIdstring

通话 ID。

job-6538214103685****
ChannelContextsarray<object>

话务通道列表。

ChannelContextobject

话务通道。

Indexinteger

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

1
ReleaseInitiatorstring

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

1390501****
ChannelStatestring

话务通道的状态。

枚举值:
  • CREATED已创建
  • ANSWERED已接通
  • RELEASED已挂断
  • RETIRED已失效
  • EARLY_MEDIA早媒体阶段
  • NONE初始状态
  • RINGING振铃中
CREATED
Destinationstring

话务通道的被叫方。

1390501****
UserIdstring

话务通道关联的坐席 ID,如果是客户的话务通道,该字段为空。

agent@ccc-test
ChannelFlagsstring

话务通道标志。

枚举值:
  • COACHING辅导中
  • MONITORING监听中
  • MONITORED被监听
  • COACHED被辅导
  • HOLD保持
  • MUTED静音
MONITORING
SkillGroupIdstring

话务通道关联的技能组 ID,呼入场景下,关联的技能组 ID 由 IVR 中转人工模块配置的技能组决定,呼出场景下,关联的技能组 ID 为座席签入的第一个技能组的 ID。

skillgroup@ccc-test
Timestamplong

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

1609138903315
ReleaseReasonstring

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

404 - No destination
CallTypestring

话务通道的通话类型。

枚举值:
  • INBOUND呼入
  • BARGE强插
  • CONSULTANT咨询
  • CONFERENCE会议
  • MONITOR监听
  • INTERNAL内部通话
  • OUTBOUND呼出
  • INTERCEPT强拆
  • BACK2BACK双呼
  • PREDICTIVE预测式外呼
  • COACH辅导
OUTBOUND
ChannelVariablesstring

随路数据。

123
JobIdstring

通话 ID。

job-6538214103685****
ChannelIdstring

话务通道 ID。

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

话务通道关联的坐席的分机号。

8032****
Originatorstring

话务通道的主叫方。

0830019****
CallVariablesstring

随路数据。通过 SIP 信令传递的自定义数据。

a=b;c=d
UserContextobject

坐席上下文环境。

Extensionstring

坐席分机号。

8032****
Heartbeatlong

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

1609136956378
WorkModestring

工作模式。

枚举值:
  • ON_SITE场内模式
  • OFF_SITE场外模式
  • OFFICE_PHONE办公电话模式
ON_SITE
DeviceIdstring

设备 ID,浏览器 WebRTC 软电话或实体话机设备的标识 ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
UserIdstring

坐席 ID。

agent@ccc-test
Reservedlong

坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为 Unix 时间戳,单位毫秒。

1609136956378
BreakCodestring

小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。

Warm-up
InstanceIdstring

实例 ID。

ccc-test
OutboundScenarioboolean

坐席是否处于仅外呼模式。

false
Mobilestring

坐席的个人电话号码。

1324730****
JobIdstring

通话 ID。

job-6538214103685****
UserStatestring

座席状态。

枚举值:
  • READY空闲
  • WORKING话后处理中
  • DIALING拨号中
  • BREAK小休
  • OFFLINE离线
  • TALKING通话中
  • RINGING振铃中
BREAK
SignedSkillGroupIdListarray

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

SkillGroupIdstring

技能组 ID。

skillgroup1@ccc-test
ParallelJobListarray<object>

坐席当前正在处理和已经处理完的 Chat 会话

JobStatusobject
JobIdstring

会话 ID

job-6538214103685****
Statusstring

客服在这个会话中的状态。

枚举值:

  • RINGING
  • TALKING
  • RELEASED(结束)
  • MISSED(未接)
RINGING
Timestamplong

状态变更的时间

1609136956378
ChatContextsarray<object>

会话上下文环境。

ChatContextobject
InstanceIdstring

实例 ID。

ccc-test
JobIdstring

话务 ID。

chat-65382141036853491
ChatTypestring

会话类型。

INBOUND
CallVariablesstring

随路数据。

Membersarray<object>

参与这个 Chat 会话的坐席和客户的信息。

ChatMemberobject
Indexinteger

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

1
UserIdstring

坐席 ID。

agent@ccc-test
UserTypestring

用户类型。

枚举值:

  • CUSTOMER:客户
  • AGENT:坐席
Manager
Statusstring

客服在这个会话中的状态。

枚举值:

  • RINGING
  • TALKING
  • RELEASED(结束)
  • MISSED(未接)
RINGING
SkillGroupIdstring

技能组 ID。

a527a80a-75cf-448f-aba0-fca37c61946d
ReleaseInitiatorstring

挂断方。

User
ReleaseReasonstring

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

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": {
    "ContextId": 103655,
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6538214103685****",
      "ChannelContexts": [
        {
          "Index": 1,
          "ReleaseInitiator": "1390501****",
          "ChannelState": "CREATED",
          "Destination": "1390501****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "MONITORING",
          "SkillGroupId": "skillgroup@ccc-test",
          "Timestamp": 1609138903315,
          "ReleaseReason": "404 - No destination",
          "CallType": "OUTBOUND",
          "ChannelVariables": "123",
          "JobId": "job-6538214103685****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "UserExtension": "8032****",
          "Originator": "0830019****"
        }
      ],
      "CallVariables": "a=b;c=d"
    },
    "UserContext": {
      "Extension": "8032****",
      "Heartbeat": 1609136956378,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609136956378,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "BREAK",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ],
      "ParallelJobList": [
        {
          "JobId": "job-6538214103685****\n",
          "Status": "RINGING",
          "Timestamp": 1609136956378
        }
      ]
    },
    "ChatContexts": [
      {
        "InstanceId": "ccc-test",
        "JobId": "chat-65382141036853491\n",
        "ChatType": "INBOUND",
        "CallVariables": "无",
        "Members": [
          {
            "Index": 1,
            "UserId": "agent@ccc-test\n",
            "UserType": "Manager",
            "Status": "RINGING",
            "SkillGroupId": "a527a80a-75cf-448f-aba0-fca37c61946d",
            "ReleaseInitiator": "User",
            "ReleaseReason": "无"
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。

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

变更历史

变更时间变更内容概要操作
2023-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情