1. 接口描述
接口请求域名: ccc.tencentcloudapi.com 。
获取包括全媒体和文本会话两种类型的服务记录。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeIMCdrs。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
StartTimestamp | 是 | Integer | 起始时间(必填),Unix 秒级时间戳 示例值:1603877878 |
EndTimestamp | 是 | Integer | 结束时间(必填),Unix 秒级时间戳 示例值:1603877879 |
SdkAppId | 否 | Integer | 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc 示例值:1400000000 |
Limit | 否 | Integer | 返回记录条数,最大为100默认20 示例值:100 |
Offset | 否 | Integer | 返回记录偏移,默认为 0 示例值:0 |
Type | 否 | Integer | 1为全媒体,2为文本客服,不填则查询全部 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总记录数 示例值:0 |
IMCdrList | Array of IMCdrInfo | 服务记录列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"Id":"12933","Duration":100,"EndStatus":1,"Nickname":"bar","Type":2,"StaffId":"foo@tencent.com","Timestamp":1632814604,"SessionId":"87fa1d7a-4194-4f2a-83dc-d7c293411720","SkillGroupId":"1001","SkillGroupName":"bar","Satisfaction":{"Id":1,"Label":"满意"}}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询在线客服记录示例
获取包括全媒体和文本会话两种类型的服务记录。
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIMCdrs
<公共请求参数>
{
"SdkAppId": 1400000000,
"StartTimestamp": 1603877878,
"EndTimestamp": 1603877879
}
输出示例
{
"Response": {
"IMCdrList": [
{
"Id": "12933",
"Duration": 100,
"EndStatus": 1,
"Nickname": "bar",
"Type": 2,
"StaffId": "foo@tencent.com",
"Timestamp": 1632814604,
"SessionId": "87fa1d7a-4194-4f2a-83dc-d7c293411720",
"SkillGroupId": "1001",
"SkillGroupName": "bar",
"Satisfaction": {
"Id": 1,
"Label": "满意"
}
}
],
"TotalCount": 1,
"RequestId": "66fa1d7a-4194-4f2a-73dc-d7c293411890"
}
}
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 | 内部错误。 |
InternalError.DBError | 内部数据库访问失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InstanceNotExist | 实例不存在。 |