调用PollUserStatus轮询坐席状态_云联络中心(Cloud Contact Center)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
UserId	string	是	坐席 ID。	agent@ccc-test
DeviceId	string	是	设备 ID，无意义，可以随便填写。	device

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Params	array	响应参数列表。
Param	string	响应参数。	无
Data	object	数据。
ContextId	long	系统自增 ID，客户无需关心。	103655
CallContext	object	话务上下文环境。
CallType	string	通话类型。枚举值： INBOUND：呼入。 BARGE：强插。 CONSULTANT：咨询。 CONFERENCE：会议。 MONITOR：监听。 INTERNAL：内部通话。 OUTBOUND：呼出。 INTERCEPT：强拆。 BACK2BACK：双呼。 PREDICTIVE：预测式外呼。 COACH：辅导。	OUTBOUND
InstanceId	string	实例 ID。	ccc-test
JobId	string	通话 ID。	job-6538214103685****
ChannelContexts	array<object>	话务通道列表。
ChannelContext	object	话务通道。
Index	integer	系统自增 ID，客户无需关心。	1
ReleaseInitiator	string	话务通道的挂断方，表示该话务通道是谁首先发起的挂断。	1390501****
ChannelState	string	话务通道的状态。枚举值： CREATED：已创建。 ANSWERED：已接通。 RELEASED：已挂断。 RETIRED：已失效。 EARLY_MEDIA：早媒体阶段。 NONE：初始状态。 RINGING：振铃中。	CREATED
Destination	string	话务通道的被叫方。	1390501****
UserId	string	话务通道关联的坐席 ID，如果是客户的话务通道，该字段为空。	agent@ccc-test
ChannelFlags	string	话务通道标志。枚举值： COACHING：辅导中。 MONITORING：监听中。 MONITORED：被监听。 COACHED：被辅导。 HOLD：保持。 MUTED：静音。	MONITORING
SkillGroupId	string	话务通道关联的技能组 ID，呼入场景下，关联的技能组 ID 由 IVR 中转人工模块配置的技能组决定，呼出场景下，关联的技能组 ID 为座席签入的第一个技能组的 ID。	skillgroup@ccc-test
Timestamp	long	话务通道最近一次状态变化的时间戳，格式是 Unix 时间戳，单位毫秒。	1609138903315
ReleaseReason	string	话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 SIP 协议中定义的响应码，请客户参考 SIP 协议分析挂断原因。	404 - No destination
CallType	string	话务通道的通话类型。枚举值： INBOUND：呼入。 BARGE：强插。 CONSULTANT：咨询。 CONFERENCE：会议。 MONITOR：监听。 INTERNAL：内部通话。 OUTBOUND：呼出。 INTERCEPT：强拆。 BACK2BACK：双呼。 PREDICTIVE：预测式外呼。 COACH：辅导。	OUTBOUND
ChannelVariables	string	随路数据。	123
JobId	string	通话 ID。	job-6538214103685****
ChannelId	string	话务通道 ID。	ch:user:1390501**->8032:1609138902226:job-653821410368**
UserExtension	string	话务通道关联的坐席的分机号。	8032****
Originator	string	话务通道的主叫方。	0830019****
CallVariables	string	随路数据。通过 SIP 信令传递的自定义数据。	a=b;c=d
UserContext	object	坐席上下文环境。
Extension	string	坐席分机号。	8032****
Heartbeat	long	上次收到坐席心跳的时间，格式为 Unix 时间戳，单位毫秒。	1609136956378
WorkMode	string	工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	ON_SITE
DeviceId	string	设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。	ACC-YUNBS-1.0.10-****
UserId	string	坐席 ID。	agent@ccc-test
Reserved	long	坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为 Unix 时间戳，单位毫秒。	1609136956378
BreakCode	string	小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。	Warm-up
InstanceId	string	实例 ID。	ccc-test
OutboundScenario	boolean	坐席是否处于仅外呼模式。	false
Mobile	string	坐席的个人电话号码。	1324730****
JobId	string	通话 ID。	job-6538214103685****
UserState	string	座席状态。枚举值： READY：空闲。 WORKING：话后处理中。 DIALING：拨号中。 BREAK：小休。 OFFLINE：离线。 TALKING：通话中。 RINGING：振铃中。	BREAK
SignedSkillGroupIdList	array	坐席签入的技能组 ID 列表。
SkillGroupId	string	技能组 ID。	skillgroup1@ccc-test
ParallelJobList	array<object>	坐席当前正在处理和已经处理完的 Chat 会话
JobStatus	object
JobId	string	会话 ID	job-6538214103685****
Status	string	客服在这个会话中的状态。枚举值： RINGING TALKING RELEASED（结束） MISSED（未接）	RINGING
Timestamp	long	状态变更的时间	1609136956378
ChatContexts	array<object>	会话上下文环境。
ChatContext	object
InstanceId	string	实例 ID。	ccc-test
JobId	string	话务 ID。	chat-65382141036853491
ChatType	string	会话类型。	INBOUND
CallVariables	string	随路数据。	无
Members	array<object>	参与这个 Chat 会话的坐席和客户的信息。
ChatMember	object
Index	integer	系统自增 ID，客户无需关心。	1
UserId	string	坐席 ID。	agent@ccc-test
UserType	string	用户类型。枚举值： CUSTOMER：客户 AGENT：坐席	Manager
Status	string	客服在这个会话中的状态。枚举值： RINGING TALKING RELEASED（结束） MISSED（未接）	RINGING
SkillGroupId	string	技能组 ID。	a527a80a-75cf-448f-aba0-fca37c61946d
ReleaseInitiator	string	挂断方。	User
ReleaseReason	string	话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 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	错误码	错误信息	描述
400	Parameter.Blank	The parameter %s may not be null or blank.	该参数不能为null或含有空白符的字符串。
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。
404	NotExists.UserId	The user %s does not exist in instance %s.	呼叫中心实例中不存在指定的用户。

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

变更历史

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

调试

授权信息

请求参数

返回参数

枚举值：

示例

错误码

变更历史