有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: ccc.tencentcloudapi.com 。

获取坐席实时状态统计指标

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStaffStatusMetrics。
Version String 公共参数,本接口取值:2020-02-10。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc
示例值:1400000000
StaffList.N Array of String 筛选坐席列表,默认不传返回全部坐席信息
示例值:[a@tencent.com,b@tencent.com,c@tencent.com]
GroupIdList.N Array of Integer 筛选技能组ID列表
示例值:[1,2,3,4,5,6]
StatusList.N Array of String 筛选坐席状态列表
示例值:[0,100,200,300,400,500,600,700,800]

3. 输出参数

参数名称 类型 描述
Metrics Array of StaffStatusMetrics 坐席状态实时信息
示例值:[{"Email":"aaa@abc.com","Status":"free","StatusExtra":{"Type":"tel","Direct":"callin"},"OnlineDuration":0,"FreeDuration":0,"BusyDuration":0,"NotReadyDuration":0,"RestDuration":0,"AfterCallWorkDuration":0,"Reason":"abc","ReserveRest":true,"ReserveNotReady":true,"UseMobileAccept":0,"UseMobileCallOut":true,"LastOnlineTimestamp":0,"LastStatusTimestamp":0}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取坐席实时状态统计指标示例

获取坐席实时状态统计指标示例。

输入示例

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStaffStatusMetrics
<公共请求参数>

{
    "SdkAppId": 0,
    "StaffList": [
        "aaa@abc.com"
    ],
    "GroupIdList": [
        0
    ],
    "StatusList": [
        "free"
    ]
}

输出示例

{
    "Response": {
        "Metrics": [
            {
                "Email": "aaa@abc.com",
                "Status": "free",
                "StatusExtra": {
                    "Type": "tel",
                    "Direct": "callin"
                },
                "OnlineDuration": 0,
                "FreeDuration": 0,
                "BusyDuration": 0,
                "NotReadyDuration": 0,
                "RestDuration": 0,
                "AfterCallWorkDuration": 0,
                "Reason": "abc",
                "ReserveRest": true,
                "ReserveNotReady": true,
                "UseMobileAccept": 0,
                "UseMobileCallOut": true,
                "LastOnlineTimestamp": 0,
                "LastStatusTimestamp": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBError 内部数据库访问失败。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotExist 实例不存在。
InvalidParameterValue.InstanceNotExist 实例不存在。