功能说明
App 管理员可以通过该接口发送自定义消息。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/send_custom_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com美国： adminapiusa.im.qcloud.com |
v4/live_engine_http_srv/send_custom_msg | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
基础形式
{"RoomId":"room1","Sender_Account":"user1","BusinessId":"xxxxx","Data":"zzzzzzz"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间ID。 |
Sender_Account | String | 选填 | 消息发送者用户ID。 |
BusinessId | String | 必填 | 标记发送消息类型。 |
Data | Integer | 必填 | 消息内容。 |
消息回调格式说明
{"MsgBody" : [{"MsgContent" : {"Data" : "{\\"BusinessId\\":\\"key\\",\\"Data\\":\\"value\\"}"},"MsgType" : "TIMCustomElem"}}
其中 Data中的内容对应发消息请求中的 BusinessId和 Data字段组成的json字符串信息。
应答包体示例
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-b6454678e8a647ffa476ec1fee1263d1-O-Seq-2433991","Response": {"MsgTime": 1750074537,"MsgSeq": 26,"MsgDropReason" : "MsgFreqCtrl"}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败。 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败。 |
ErrorInfo | String | 错误信息。 |
RequestId | String | 唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。 |
MsgTime | Integer | 消息发送的时间戳，对应后台 server 时间。 |
MsgSeq | Integer | 消息序列号，唯一标示一条消息。 |
MsgDropReason | String | 消息丢弃原因；默认为空，否则表明消息被丢弃原因，当前只支持消息频控丢弃。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
100001 | 服务器内部错误，请重试。 |
100002 | 请求参数非法，请根据错误描述检查请求是否正确。 |
100004 | 房间不存在。 |
100006 | 操作权限不足，需要管理员账号操作。 |
100601 | 因被禁言而不能发送消息，请检查发送者是否被设置禁言。 |
100602 | 发消息的频率超限，请延长两次发消息时间的间隔。 |
100603 | 消息内容过长，目前最大支持12K字节的消息，请调整消息长度。 |
