文档

GetRealtimeInstanceStates - 获取实时实例状态

更新时间:

调用GetRealtimeInstanceStates获取指定实例的实时状态。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
MediaTypestring

媒体类型,默认是语音(AUDIO)。

枚举值:
  • ALL全部
  • VIDEO视频
  • CHAT聊天
  • AUDIO语音
AUDIO

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

943D8EF3-3321-471F-A104-51C96FCA94D6
Dataobject

数据。

WorkingAgentslong

处于话后处理状态的坐席数量。

0
LongestWaitingTimelong

当前正在排队的来电的最大排队等待时长。

0
LoggedInAgentslong

在线坐席数量(包括就绪,小休,通话等非下线状态的坐席)。

0
TotalAgentslong

总坐席数。

0
WaitingCallslong

当前正在排队的来电的个数。

0
BreakingAgentslong

处于小休状态的坐席数量。

0
TalkingAgentslong

处于通话状态的坐席数量。

0
InteractiveCallslong

正在 IVR 中交互的电话的数量。

0
ReadyAgentslong

处于就绪状态的坐席数量。

0
InstanceIdstring

实例 ID。

ccc-test
BreakCodeDetailListobject []

各个小休码次数分布列表。

BreakCodestring

小休码。

默认
Countlong

小休次数。

1

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "943D8EF3-3321-471F-A104-51C96FCA94D6",
  "Data": {
    "WorkingAgents": 0,
    "LongestWaitingTime": 0,
    "LoggedInAgents": 0,
    "TotalAgents": 0,
    "WaitingCalls": 0,
    "BreakingAgents": 0,
    "TalkingAgents": 0,
    "InteractiveCalls": 0,
    "ReadyAgents": 0,
    "InstanceId": "ccc-test",
    "BreakCodeDetailList": [
      {
        "BreakCode": "默认",
        "Count": 1
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。

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

变更历史

变更时间变更内容概要操作
2023-11-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:MediaType
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)