App 管理员可以通过该接口在群组中发送系统通知。
群组类型 ID | 支持此 REST API |
---|---|
Private | 支持,同新版本中的 Work(好友工作群) |
Public | 支持 |
ChatRoom | 支持,同新版本中的 Meeting(临时会议群) |
AVChatRoom | 支持,仅支持面向全员 |
Community(社群) | 支持 |
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统。
说明:
https://xxxxxx/v4/group_open_http_svc/send_group_system_notification?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介。
参数 | 说明 |
---|---|
xxxxxx | SDKAppID 所在国家/地区对应的专属域名:console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com adminapiusa.im.qcloud.com |
v4/group_open_http_svc/send_group_system_notification | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | 必须为 App 管理员帐号,更多详情请参见 App 管理员 |
usersig | App 管理员帐号生成的签名,具体操作请参见 生成 UserSig |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为json |
200次/秒。
{
"GroupId": "@TGS#2C5SZEAEF",
"Content": "Hello World" // 系统通知内容
}
{
"GroupId": "@TGS#2C5SZEAEF",
"ToMembers_Account": [ // 接收者群成员列表,不填或为空表示全员下发,AVChatRoom 群类型仅支持全员下发,不支持指定群成员接收者。
"peter",
"leckie"
],
"Content": "Hello World" // 系统通知内容
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
GroupId | String | 必填 | 向哪个群组发送系统通知 |
ToMembers_Account | Array | 选填 | 接收者群成员列表,请填写接收者 UserID,最多填写500个,不填或为空表示全员下发 |
Content | String | 必填 | 系统通知的内容 |
TopicId | String | 选填 | 话题的 ID,若具有此选项表示在对应的话题中发送系统通知,仅支持话题的社群适用此选项 |
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
字段 | 类型 | 说明 |
---|---|---|
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 描述 |
---|---|
10002 | 服务器内部错误,请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法,请根据错误描述检查请求是否正确 |
10007 | 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限 |
10010 | 群组不存在,或者曾经存在过,但是目前已经被解散 |
10015 | 群组 ID 非法,请检查群组 ID 是否填写正确 |
通过 REST API 在线调试工具 调试本接口。
在群组中发送普通消息(v4/group_open_http_svc/send_group_msg)
本页内容是否解决了您的问题?