接口调用说明
App 管理员可以通过该接口编辑会话历史消息。
请求 URL 示例:
https://console.tim.qq.com/v4/desk_http_svc/modify_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/modify_msg | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
请求包示例
{"SessionId": "fd8a2e30-54de-4e40-bcaf-02718409c5cf","MsgKey": "k62504023_1747216201_1069_1500086333_b1b6f96511f02d56295023331","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "欢迎使用智能客服,很高兴为您服务!"}}],"CloudCustomData": "your cloud custom data"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
SessionId | String | 必填 | 会话 ID。 |
MsgKey | String | 必填 | 消息的唯一标识(消息回调的MsgKey)。 |
MsgBody | Array | 必填 | 消息内容,具体格式请参见 消息格式描述。智能客服定义的自定义消息格式(如卡片消息、订单消息等)请参见 无 UI 用户端集成,将文档中定义好的 JSON 数据结构序列化后放到自定义消息的 Data 字段。 |
CloudCustomData | String | 选填 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
90001 | JSON 格式解析失败,请检查请求包是否符合 JSON 规范。 |
90002 | |
90007 | JSON 格式请求包体中 MsgBody 类型不是 Array 类型,请将其修改为 Array 类型。 |
90009 | 请求需要 App 管理员权限。 |
90010 | |
93000 | JSON 数据包超长,消息包体请不要超过12K。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |