接口调用说明
本接口用于向指定的客服会话中导入历史消息,支持导入用户消息、机器人消息和客服成员消息。
该接口仅适用于“应用(SDK 轻量开发)”的用户端集成方式。
该接口限频为每个 SDKAppID 100次/秒。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/import_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表列出调用本接口时涉及的主要参数及其说明:
参数 | 说明 |
v4/desk_http_svc/import_msg | 请求接口路径。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
请求包说明
请求包示例
{"Command": "Human.UserSendMsg","ClientUserID": "user_001","CustomerServiceId": "@customer_service_account","MemberMail": "xiaoming@tencent.com","MsgTime": 1716105600,"MsgRandom": 12345678,"MsgBody": {"MsgType": "TIMTextElem","MsgContent": {"Text": "你好,请问怎么退款?"}},"CloudCustomData": ""}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Command | String | 必填 | 消息命令类型,表示导入消息所属的会话阶段和发送方向。 可选值: Chatbot.UserSendMsg:机器人阶段用户发送的消息。Chatbot.RobotSendMsg:机器人阶段机器人回复的消息。Human.UserSendMsg:人工阶段用户发送的消息。Human.MemberSendMsg:人工阶段客服成员发送的消息。 |
ClientUserID | String | 必填 | 用户 ID,即发起会话的用户标识。 |
CustomerServiceId | String | 必填 | 客服号 ID,即用户对话的客服号标识。 |
MemberMail | String | 选填 | 客服成员的账号。 当 Command 为 Human.MemberSendMsg 时必填,用于标识消息的发送方。其他 Command 类型传空字符串即可,传入也会被忽略。 |
MsgTime | Integer | 必填 | 消息发送的 Unix 时间戳(单位:秒)。 |
MsgRandom | Integer | 必填 | 消息随机数,用于消息去重。 |
MsgBody | Object | 必填 | |
MsgType | String | 必填 | 消息元素类型,常见取值: TIMTextElem:文本消息。TIMImageElem:图片消息。TIMCustomElem:自定义消息。 |
MsgContent | Object | 必填 | |
CloudCustomData | String | 选填 | 消息自定义数据。 |
应答包说明
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 请求错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码通过应答包体中的 ErrorCode、ErrorInfo 表示。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 该应用非智能客服应用。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |
141009 | 接口限频(该接口限频为每个 SDKAppID 100次/秒)。 |
接口调试工具
联系我们
如果您在接入过程中有任何疑问,请用微信或企业微信扫码加入智能客服交流群进行咨询。
