有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: ccc.tencentcloudapi.com
获取指定服务记录文本聊天内容,需要先使用查询在线客服记录(DescribeIMCdrs) API 获取服务记录 SessionId。
文本聊天记录只保存了 1 年内的,1 年之前会自动清理。
默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数
参数名称
必选
类型
描述
Action
String
?公共参数,本接口取值:DescribeChatMessages。
Version
String
?公共参数,本接口取值:2020-02-10。
Region
String
?公共参数,详见产品支持的 地域列表
SdkAppId
Integer
应用 ID(必填) 示例值:1400000000
?
?
?
CdrId
String
服务记录 ID(废弃) 示例值:13503
Limit
Integer
返回记录条数,最大为100 默认20 示例值:20
Offset
Integer
返回记录偏移,默认为 0 示例值:0
Order
Integer
1为从早到晚,2为从晚到早,默认为2 示例值:1
SessionId
String
服务记录 SessionID(必填) 示例值:d6253538-7c28-477b-998a-919059801899

3. 输出参数

参数名称
类型
描述
TotalCount
Integer
总记录数 示例值:0
Messages
Array of MessageBody?
消息列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"Timestamp":1600007226,"From":"John","Messages":[{"Type":"Text","Content":"Hello, how are you?"},{"Type":"Image","Content":"https://example.com/image.jpg"}]},{"Timestamp":1400753150,"From":"Alice","Messages":[{"Type":"Text","Content":"Hi there!"}]}]
RequestId
String
唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询聊天记录示例

获取指定服务记录的文本消息记录。

输入示例

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeChatMessages
<公共请求参数>
?
{
"SdkAppId": 1400000000,
"SessionId": "d6253538-7c28-477b-998a-919059801899"
}

输出示例

{
"Response": {
"RequestId": "48edd236-7ef1-45af-9e12-fc376ba355bf",
"TotalCount": 2,
"Messages": [
{
"Timestamp": 1600007226,
"From": "John",
"Messages": [
{
"Type": "Text",
"Content": "Hello, how are you?"
},
{
"Type": "Image",
"Content": "https://example.com/image.jpg"
}
]
},
{
"Timestamp": 1400753150,
"From": "Alice",
"Messages": [
{
"Type": "Text",
"Content": "Hi there!"
}
]
}
]
}
}

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
内部数据库访问失败。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InstanceNotExist
实例不存在。
InvalidParameterValue.RecordNotExist
查询记录不存在。


http://www.vxiaotou.com