首页 云呼叫中心 API参考 API目录 报表 ListAgentStates - 获取坐席状态列表

ListAgentStates - 获取坐席状态列表

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

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
SkillGroupIdstring

按技能组ID过滤。

skillgroup@ccc-test
AgentIdsstring

按坐席ID列表过滤。

agent@ccc-test
Statestring

按坐席状态过滤,只能按单个状态过滤。

Ready
枚举值:
- Ready: 空闲
- Talking: 通话
- ACW: 话后处理
- Break: 小休
- Ringing: 振铃
- Offline: 下线
- Dialing: 拨号
PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-300。

100
ExcludeOfflineUsersboolean

过滤掉离线坐席,固定为true,暂不支持false。

true

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP状态码。

200
Codestring

响应码。

OK
Messagestring

响应信息。

RequestIdstring

请求ID。

03C67DAD-EB26-41D8-949D-9B0C470FB716
Successboolean

是否成功。

true
Dataobject

数据。

PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-300。

100
TotalCountinteger

总数。

11
Listarray

列表。

object
LoginNamestring

座席登录名。

agent
Dnstring

坐席分机号。

8030****
StateDurationstring

坐席状态持续时长。

10
Statestring

坐席状态。

Ready
枚举值:
- Ready: 空闲
- Talking: 通话
- ACW: 话后处理
- Ringing: 振铃
- Break: 小休
- Offline: 下线
- Dialing: 拨号
AgentIdstring

坐席ID。

agent@ccc-test
AgentNamestring

座席名称。

坐席小王
InstanceIdstring

实例ID。

ccc-test
BreakCodestring

小休码。

Warm-up
枚举值:
- RingingTimeout: 坐席振铃超时导致的小休
- RejectCall: 坐席拒接导致的小休
- Warm-up: 坐席上线后置闲前的临时小休状态
OutboundScenarioboolean

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

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": true
      }
    ]
  }
}

错误码

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

阿里云首页 云呼叫中心 相关技术圈