文档

ListRealtimeAgentStates - 获取实时坐席状态报表

更新时间:

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

调试

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

授权信息

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

请求参数

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

按技能组 ID 过滤,非必填,默认为空,表示不过滤。

skillgroup@ccc-test
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
InstanceIdstring

实例 ID。

ccc-test
AgentIdListstring

坐席 ID 列表,格式为 JSON 数组的字符串,数组元素最多 20 个,非必填,默认为空,表示匹配当前实例下的所有坐席。

["agent1@ccc-test", "agent2@ccc-test"]
StateListstring

按状态列表过滤,非必填,默认为空,表示匹配所有状态。

枚举值:
  • Ready空闲
  • Talking通话
  • ACW话后处理
  • Break小休
  • Ringing振铃
  • Offline离线
  • Dialing拨号
["ACW", "Dialing"]
AgentNamestring

按坐席名称进行模糊匹配。

agent
WorkModeListstring

按工作模式列表过滤,非必填,默认为空,表示匹配所有工作模式。

枚举值:
  • ON_SITE场内模式
  • OFF_SITE场外模式
  • OFFICE_PHONE办公电话模式
["OFFICE_PHONE","ON_SITE"]
OutboundScenarioboolean

过滤仅外呼模式下的坐席,非必填,默认为空,表示不按仅外呼模式过滤。

false
Querystring

模糊过滤,可以是坐席展示名、坐席工号或坐席分机号的全部或者一部分,非必填,默认为空,表示不过滤。

agent
CallTypeListstring

按通话类型列表过滤,格式为 JSON 数组的字符串,数组元素为通话类型,非必填,默认为空,表示匹配所有的通话类型。

枚举值:
  • Outbound呼出
  • Back2Back双呼
  • PrivacyDial加密通话
  • Internal内部呼叫
  • Predictive预测式外呼
  • Inbound呼入
  • Conference会议
["Inbound", "Outbound"]

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

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

数据。

PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数。

1
Listobject []

实时坐席状态数据列表。

Extensionstring

坐席分机号。

80317391
StateCodestring

子状态,部分场景下,仅用 State 字段无法完整表示坐席状态,因此需要子状态辅助,比如监听状态下,State=Talking,StateCode=Monitoring。

枚举值:
  • Monitored被监听
  • Consulted被咨询
  • Coaching辅导中
  • Consulting咨询中
  • Coached被辅导
  • Conference会议
  • Monitoring监听中
Monitored
Statestring

坐席状态。

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

坐席 ID。

agent1@ccc-test
StateTimelong

状态开始的时间。

1696670640774
AgentNamestring

坐席姓名。

坐席小王
InstanceIdstring

实例 ID。

ccc-test
CounterPartystring

用于一些特定的三方场景,主要是监听,辅导,咨询,在三方场景时表示第三方,比如在监听或辅导场景,用于表示被监听或被辅导的坐席,在咨询场景下,表示被转接的坐席或外呼号码。

agent@ccc-test
SkillGroupIdListarray

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

string

技能组 ID。

skillgroup1@ccc-test
SkillGroupNameListarray

坐席签入的技能组名称列表。

string

技能组名称。

测试技能组
WorkModestring

工作模式。

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

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

false
Mobilestring

坐席的个人电话号码。

1382114****
CallTypestring

通话类型。

枚举值:
  • Outbound呼出
  • Back2Back双呼
  • PrivacyDial加密通话
  • Internal内部呼叫
  • Predictive预测式外呼
  • Inbound呼入
  • Conference会议
Outbound
Durationlong

当前状态的持续时长,单位秒。

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错误码错误信息描述
500InternalService.CommonAn internal service error occurred. %s内部服务错误。

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

  • 本页导读 (0)