1. 接口描述
接口请求域名: ccc.tencentcloudapi.com 。
获取坐席信息列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeStaffInfoList。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc 示例值:1400000000 |
PageSize | 是 | Integer | 分页尺寸,上限 9999 示例值:9999 |
PageNumber | 是 | Integer | 分页页码,从 0 开始 示例值:0 |
StaffMail | 否 | String | 坐席账号,查询单个坐席时使用 示例值:102992@qq.com |
ModifiedTime | 否 | Integer | 查询修改时间大于等于ModifiedTime的坐席时使用 示例值:1611631881 |
SkillGroupId | 否 | Integer | 技能组ID 示例值:123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 坐席用户总数 示例值:10 |
StaffList | Array of StaffInfo | 坐席用户信息列表 示例值:[{"Name":"xiao","Mail":"1000273@qq.com","Phone":"008617636049517","Nick":"测试3","StaffNumber":"125","RoleId":1,"SkillGroupList":[{"SkillGroupId":53,"SkillGroupName":"ALL-dingoding-测试","Priority":3,"Type":"ALL"},{"SkillGroupId":82,"SkillGroupName":"uu","Priority":1,"Type":"IM"}],"LastModifyTimestamp":1613988825}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取坐席列表示例
获取坐席列表示例
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStaffInfoList
<公共请求参数>
{
"ModifiedTime": 1590147606,
"PageSize": 10,
"PageNumber": 0,
"StaffMail": "“121223@qq.com”",
"SdkAppId": "1400000000"
}
输出示例
{
"Response": {
"RequestId": "5ac74e13-ef15-41a6-9639-f1bc8c9896bd",
"TotalCount": 602,
"StaffList": [
{
"Name": "xiao",
"Mail": "1000273@qq.com",
"Phone": "008617636049517",
"Nick": "测试3",
"StaffNumber": "125",
"RoleId": 1,
"SkillGroupList": [
{
"SkillGroupId": 53,
"SkillGroupName": "ALL-dingoding-测试",
"Priority": 3,
"Type": "ALL"
},
{
"SkillGroupId": 82,
"SkillGroupName": "uu",
"Priority": 1,
"Type": "IM"
}
],
"LastModifyTimestamp": 1613988825
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter.InstanceNotExist | 实例不存在。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InstanceNotExist | 实例不存在。 |