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 | 固定为 Group.CallbackBeforeSendMsg |
contenttype | 固定值为 JSON |
ClientIP | 客户端 IP,格式如:127.0.0.1 |
OptPlatform |
{"CallbackCommand": "Group.CallbackBeforeSendMsg", // 回调命令"GroupId": "@TGS#2J4SZEAEL", // 群组 ID"Type": "Community", // 群组类型"From_Account": "jared", // 发送者"Operator_Account":"admin", // 请求的发起者"Random": 123456, // 随机数"OnlineOnlyFlag": 1, //在线消息,为1,否则为0;直播群忽略此属性,为默认值0。"MsgBody": [ // 消息体,参见 TIMMessage 消息对象{"MsgType": "TIMTextElem", // 文本"MsgContent": {"Text": "red packet"}}],"CloudCustomData": "your cloud custom data","TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",// 话题的 ID, 仅支持话题的社群适用此选项"EventTime":"1670574414123"//毫秒级别,事件触发时间戳}
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令 |
GroupId | String | 产生群消息的群组 ID |
Type | String | |
From_Account | String | 消息发送者 UserID |
Operator_Account | String | 请求发起者 UserID,可以用来识别是否为管理员请求的 |
Random | Integer | 发消息请求中的 32 位随机数 |
OnlineOnlyFlag | Integer | 在线消息,为1,否则为0;直播群忽略此属性,为默认值0。 |
MsgBody | Array | 消息体,具体参见 消息格式描述 |
CloudCustomData | String | 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到) |
TopicId | String | 话题的 ID,若具有此选项表示在话题内发言,仅支持话题的社群适用此选项 |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 0 为允许发言}
10016
。{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 1 // 1 为拒绝发言}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 2 // 2 为静默丢弃}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0, // 必须为 0,只有这样,变动之后的消息才能正常下发"MsgBody": [ // App 变动之后的消息,如果没有,则默认使用用户发送的消息{"MsgType": "TIMTextElem", // 文本"MsgContent": {"Text": "red packet"}},{"MsgType": "TIMCustomElem", // 自定义消息"MsgContent": {"Desc": "CustomElement.MemberLevel", // 描述"Data": "LV1" // 数据}}],"CloudCustomData": "your cloud custom data"}
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 必填 | 错误码,0为允许发言;1为拒绝发言;2为静默丢弃。若业务希望拒绝发言的同时,将错误码 ErrorCode 和 ErrorInfo 传递至客户端,请将错误码 ErrorCode 设置在 [10100, 10200] 区间内 |
ErrorInfo | String | 必填 | 错误信息 |
MsgBody | Array | 选填 | 经过App变动之后的消息体,云通讯后台将把变动后的消息发送到群组中,具体格式参见 消息格式描述 |
CloudCustomData | String | 选填 | 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到) |
本页内容是否解决了您的问题?