tencent cloud

功能说明

App 管理员可以通过该接口在群组中发送系统通知。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

说明：

• 非直播群支持向群组中的一部分指定成员发送系统通知，而 AVChatRoom（直播群）只支持向群组中所有成员发送系统通知。
• 客户端接收系统通知接口（V2TIMGroupListener.onReceiveRESTCustomData）请参见 Android、iOS 。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/send_group_system_notification?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式
  用来向群中的所有群成员下发系统消息。

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Content": "Hello World" // 系统通知内容
  }
  

• 指定接收群成员
  用来向群中的指定的群成员下发系统消息，接收者在 ToMembers_Account 中设置，AVChatRoom(直播群) 群类型仅支持全员下发，不支持指定群成员接收者。

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "ToMembers_Account": [ // 接收者群成员列表，不填或为空表示全员下发，AVChatRoom 群类型仅支持全员下发，不支持指定群成员接收者。
        "peter",
        "leckie"
    ],
    "Content": "Hello World" // 系统通知内容
  }
  

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

在群组中发送普通消息（v4/group_open_http_svc/send_group_msg）