设单聊消息扩展
功能说明
App 后台可以通过该回调实时查看用户的单聊消息扩展操作。
注意事项
要启用回调，必须配置回调 URL，并打开本回调对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 App 后台发起 HTTPS POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介：安全考虑 文档。
可能触发该回调的场景
App 用户通过客户端设置单聊消息扩展。
App 管理员通过 REST API 设置单聊消息扩展。
回调发生时机
单聊消息扩展设置成功之后。
接口说明
请求 URL 示例
以下示例中 App 配置的回调 URL 为
https://www.example.com 。示例：
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
请求参数说明
参数 | 说明 |
https | 请求协议为 HTTPS，请求方式为 POST。 |
www.example.com | 回调 URL。 |
SDKAppID | 创建应用时在即时通信 IM 控制台分配的 SDKAppID。 |
CallbackCommand | 固定为： C2C.CallbackAfterC2CMsgExtension。 |
contenttype | 请求包体固定为 JSON。 |
ClientIP | 客户端 IP，格式如：127.0.0.1。 |
OptPlatform |
请求包示例
// 设置消息扩展 KV{"CallbackCommand": "C2C.CallbackAfterC2CMsgExtension","From_Account":"user1","To_Account":"user2","MsgKey":"93847636_1287657_1764688415","OperateType":1,"ExtensionList":[{"Key":"k1","Value":"v1","Seq":1}, // 单条KV的版本号{"Key":"k2","Value":"v2","Seq":1},{"Key":"k3","Value":"v3","Seq":1}],"Seq":1, // 代表整条消息最新的版本号"EventTime":1764688540182}// 删除消息扩展 KV{"CallbackCommand": "C2C.CallbackAfterC2CMsgExtension", // 回调命令"From_Account":"user1","To_Account":"user2","MsgKey":"93847636_1287657_1764688415","OperateType":2,"ExtensionList":[{"Key":"k1","Value":"","Seq":2},{"Key":"k2","Value":"","Seq":2},{"Key":"k3","Value":"","Seq":2}],"Seq":2, // 代表整条消息最新的版本号"EventTime":1764688641499}// 清空消息扩展 KV{"CallbackCommand": "C2C.CallbackAfterC2CMsgExtension", // 回调命令"From_Account":"user1","To_Account":"user2","MsgKey":"93847636_1287657_1764688415","OperateType":3,"ExtensionList":[],"Seq":3, // 代表整条消息最新的版本号"EventTime":1764688662721}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令。 |
From_Account | String | 消息发送者 UserID。 |
To_Account | String | 消息接收者 UserID。 |
MsgKey | String | 该条消息的唯一标识。 |
OperateType | Integer | 1：设置消息扩展 KV。 2：删除消息扩展 KV。 3：清空所有消息扩展 KV。 |
ExtensionList | Array | 消息扩展 KV 对。 |
Seq | Integer | 版本号。 |
EventTime | Integer | 事件触发的毫秒级别时间戳。 |
应答包示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 0为回调成功，1为回调出错}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果： OK：表示处理成功。 FAIL：表示失败。 |
ErrorCode | Integer | 必填 | 错误码： 0为回调成功。 1为回调出错。 |
ErrorInfo | String | 必填 | 错误信息。 |
参考
第三方回调简介
REST API：设置单聊消息扩展
