调用ListRealtimeAgentStates获取实时坐席状态报表_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SkillGroupId	string	否	按技能组 ID 过滤，非必填，默认为空，表示不过滤。	skillgroup@ccc-test
PageNumber	integer	是	分页序号，范围 1-100。	1
PageSize	integer	是	分页大小，范围 1-100。	10
InstanceId	string	是	实例 ID。	ccc-test
AgentIdList	string	否	坐席 ID 列表，格式为 JSON 数组的字符串，数组元素最多 20 个，非必填，默认为空，表示匹配当前实例下的所有坐席。	["agent1@ccc-test", "agent2@ccc-test"]
StateList	string	否	按状态列表过滤，非必填，默认为空，表示匹配所有状态。枚举值： Ready：空闲。 Talking：通话。 ACW：话后处理。 Break：小休。 Ringing：振铃。 Offline：离线。 Dialing：拨号。	["ACW", "Dialing"]
AgentName	string	否	按坐席名称进行模糊匹配。	agent
WorkModeList	string	否	按工作模式列表过滤，非必填，默认为空，表示匹配所有工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	["OFFICE_PHONE","ON_SITE"]
OutboundScenario	boolean	否	过滤仅外呼模式下的坐席，非必填，默认为空，表示不按仅外呼模式过滤。	false
Query	string	否	模糊过滤，可以是坐席展示名、坐席工号或坐席分机号的全部或者一部分，非必填，默认为空，表示不过滤。	agent
CallTypeList	string	否	按通话类型列表过滤，格式为 JSON 数组的字符串，数组元素为通话类型，非必填，默认为空，表示匹配所有的通话类型。枚举值： Outbound：呼出。 Back2Back：双呼。 PrivacyDial：加密通话。 Internal：内部呼叫。 Predictive：预测式外呼。 Inbound：呼入。 Conference：会议。	["Inbound", "Outbound"]

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	数据。
PageNumber	integer	分页序号，范围 1-100。	1
PageSize	integer	分页大小，范围 1-100。	10
TotalCount	integer	总数。	1
List	array<object>	实时坐席状态数据列表。
AgentState	object	实时坐席状态数据。
Extension	string	坐席分机号。	80317391
StateCode	string	子状态，部分场景下，仅用 State 字段无法完整表示坐席状态，因此需要子状态辅助，比如监听状态下，State=Talking，StateCode=Monitoring。枚举值： Monitored：被监听。 Consulted：被咨询。 Coaching：辅导中。 Consulting：咨询中。 Coached：被辅导。 Conference：会议。 Monitoring：监听中。	Monitored
State	string	坐席状态。枚举值： Ready：空闲。 Talking：通话。 ACW：话后处理。 Ringing：振铃。 Break：小休。 Offline：下线。 Dialing：拨号。	ACW
AgentId	string	坐席 ID。	agent1@ccc-test
StateTime	long	状态开始的时间。	1696670640774
AgentName	string	坐席姓名。	坐席小王
InstanceId	string	实例 ID。	ccc-test
CounterParty	string	用于一些特定的三方场景，主要是监听，辅导，咨询，在三方场景时表示第三方，比如在监听或辅导场景，用于表示被监听或被辅导的坐席，在咨询场景下，表示被转接的坐席或外呼号码。	agent@ccc-test
SkillGroupIdList	array	坐席签入的技能组 ID 列表。
SkillGroupId	string	技能组 ID。	skillgroup1@ccc-test
SkillGroupNameList	array	坐席签入的技能组名称列表。
SkillGroupId	string	技能组名称。	测试技能组
WorkMode	string	工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	ON_SITE
OutboundScenario	boolean	坐席是否处于仅外呼模式。	false
Mobile	string	坐席的个人电话号码。	1382114****
CallType	string	通话类型。枚举值： Outbound：呼出。 Back2Back：双呼。 PrivacyDial：加密通话。 Internal：内部呼叫。 Predictive：预测式外呼。 Inbound：呼入。 Conference：会议。	Outbound
Duration	long	当前状态的持续时长，单位秒。	16

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Extension": "80317391",
        "StateCode": "Monitored",
        "State": "ACW",
        "AgentId": "agent1@ccc-test",
        "StateTime": 1696670640774,
        "AgentName": "坐席小王",
        "InstanceId": "ccc-test",
        "CounterParty": "agent@ccc-test",
        "SkillGroupIdList": [
          "skillgroup1@ccc-test"
        ],
        "SkillGroupNameList": [
          "测试技能组"
        ],
        "WorkMode": "ON_SITE",
        "OutboundScenario": false,
        "Mobile": "1382114****",
        "CallType": "Outbound",
        "Duration": 16
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalService.Common	An internal service error occurred. %s	内部服务错误。

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

变更历史

变更时间	变更内容概要	操作
2024-06-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情