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

目前该API接口已标记为弃用，推荐使用替代API：CCC(2020-07-01) - ListRealtimeAgentStates。

调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表，该接口仅对特定用户开放，其他客户不建议调用。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
SkillGroupId	string	否	按技能组 ID 过滤。	skillgroup@ccc-test
AgentIds	string	否	按坐席 ID 列表过滤。	agent@ccc-test
State	string	否	按坐席状态过滤，只能按单个状态过滤。枚举值： Ready：空闲。 Talking：通话。 ACW：话后处理。 Break：小休。 Ringing：振铃。 Offline：下线。 Dialing：拨号。	Ready
PageNumber	integer	否	分页序号，范围 1-100。	1
PageSize	integer	否	分页大小，范围 1-300。	100
ExcludeOfflineUsers	boolean	否	过滤掉离线坐席，固定为 true，暂不支持 false。	true

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	响应信息。	无
RequestId	string	请求 ID。	03C67DAD-EB26-41D8-949D-9B0C470FB716
Success	boolean	是否成功。	true
Data	object	数据。
PageNumber	integer	分页序号，范围 1-100。	1
PageSize	integer	分页大小，范围 1-300。	100
TotalCount	integer	总数。	11
List	array<object>	列表。
RealTimeAgentState	object
LoginName	string	座席登录名。	agent
Dn	string	坐席分机号。	8030****
StateDuration	string	坐席状态持续时长。	10
State	string	坐席状态。枚举值： Ready：空闲。 Talking：通话。 ACW：话后处理。 Ringing：振铃。 Break：小休。 Offline：下线。 Dialing：拨号。	Ready
AgentId	string	坐席 ID。	agent@ccc-test
AgentName	string	座席名称。	坐席小王
InstanceId	string	实例 ID。	ccc-test
BreakCode	string	小休码。枚举值： RingingTimeout：坐席振铃超时导致的小休。 RejectCall：坐席拒接导致的小休。 Warm-up：坐席上线后置闲前的临时小休状态。	Warm-up
OutboundScenario	boolean	坐席是否处于仅外呼模式。	false

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "RequestId": "03C67DAD-EB26-41D8-949D-9B0C470FB716",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 11,
    "List": [
      {
        "LoginName": "agent",
        "Dn": "8030****",
        "StateDuration": "10",
        "State": "Ready",
        "AgentId": "agent@ccc-test",
        "AgentName": "坐席小王",
        "InstanceId": "ccc-test",
        "BreakCode": "Warm-up",
        "OutboundScenario": false
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-11-28	OpenAPI 描述信息更新、OpenAPI 变更为 deprecated，即将下线	查看变更详情