• 服务端集成 >
 
• 消息管理 >
 
• 发送超级群消息

向应用下的单个或多个超级群发送消息。

该接口可以实现以下功能：

• 发送普通超级群消息：单次支持向最多 3 个超级群发送消息，但单次仅支持指定一个频道 ID。如果超级群下无此频道 ID，则不会下发此条消息。
• 发送定向群聊消息：可向超级群频道中指定一个或多个用户发送消息，但单次仅支持指定一个超级群 ID 和一个频道 ID。如果向私有频道发送定向消息，默认情况下只有已加入该私有频道的目标用户才能收到消息。

通过 Server API 向超级群发送消息时：

• 不要求发送者为超级群成员。App 需要自行控制发消息权限。
• 终端用户在线状态下，发送者会自动同步接收该条已发出消息，该条已发消息会被保存到该用户的服务端历史消息中。

应用下的用户可以向应用下的单个超级群或多个超级群发送消息。通过 Server API 发送超级群消息时，终端用户在线状态下，发送者也会接收该消息，同时保存到该用户的历史消息中。

超级群消息发送成功后支持修改消息内容，详见修改超级群消息。

请求方法

POST： https://数据中心域名/message/ultragroup/publish.json

频率限制： 每秒钟限发送 100 条超级群消息。单个频道每秒钟最多发送 20 条；不传频道参数时（busChannel），往指定群中发消息限每秒钟 20 条。请注意，如果一次向 3 个超级群发送消息，视为发送 3 条消息。

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数

HTTP 请求正文数据格式为 application/json，包含具有以下结构的 JSON 对象：

• pushExt 参数说明

  pushExt 参数支持设置消息推送通知的标题、推送内容模板、是否强制通知及推送 ChannelID 等。pushExt 为 JSON 结构请求时需要做转义处理。

  pushExt 参数	类型	必传	说明
  title	String	否	通知栏显示标题，最长不超过 50 个字符，默认情况下通知标题单聊会话显示用户名称，群聊会话显示群名称。
  templateId	String	否	推送模板 ID，设置后根据目标用户通过 SDK 设置的语言环境，匹配模板中设置的语言内容进行推送，未匹配成功时使用默认内容进行推送，模板内容在“控制台-自定义推送文案”中进行设置。详情请查看 自定义多语言推送模板。
  forceShowPushContent	Number	否	是否越过客户端配置，强制在推送通知内显示通知内容（pushContent）。默认值 0 表示不强制，1 表示强制。 说明：客户端设备可设置在接收推送通知时仅显示类似「您收到了一条通知」的提醒。从服务端发送消息时，可通过设置forceShowPushContent 为 1 越过该配置，强制客户端针在此条消息的推送通知中显示推送内容。
  pushConfigs	Array	否	按厂商设置不同推送属性。支持的推送通道值为 MI（小米）、HONOR（荣耀）、HW（华为）、OPPO、VIVO、APNs、FCM。
  pushConfigs.HONOR.importance	String	否	荣耀通知栏消息优先级，取值： NORMAL（服务与通讯类消息） LOW（咨询营销类消息）。若资讯营销类消息发送时带图片，图片不会展示。
  pushConfigs.HONOR.image	String	否	荣耀推送自定义通知栏消息右侧的大图标 URL，若不设置，则不展示通知栏右侧图标。 URL 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png。 图标文件须小于 512KB，图标建议规格大小：40dp x 40dp，弧角大小为 8dp。 超出建议规格大小的图标会存在图片压缩或显示不全的情况。
  pushConfigs.HW.channelId	String	否	华为推送通知渠道的 ID，详细请参见 华为自定义通知渠道。更多通知渠道信息，请参见 Android 官方文档。
  pushConfigs.HW.importance	String	否	华为通知栏消息优先级，取值： NORMAL（默认值，重要信息） LOW
  pushConfigs.HW.image	String	否	华为推送自定义通知栏消息右侧的大图标 URL，若不设置，则不展示通知栏右侧图标。 URL 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png。 图标文件须小于 512KB，图标建议规格大小：40dp x 40dp，弧角大小为 8dp。 超出建议规格大小的图标会存在图片压缩或显示不全的情况。
  pushConfigs.HW.category	String	否	华为推送通道的消息自分类标识，category 取值必须为大写字母，例如 IM。App 根据华为要求完成自分类权益申请 或 申请特殊权限 后可传入该字段有效。详见华为推送官方文档消息分类标准。该字段优先级高于控制台为 App Key 下的应用标识配置的华为推送 Category。
  pushConfigs.MI.channelId	String	否	小米推送通知渠道的 ID，详细请参见 小米推送消息分类新规。
  pushConfigs.MI.large_icon_uri	String	否	（由于小米官方已停止支持该能力，该字段已失效）消息的右侧图标 URL，若不设置，则不展示通知栏右侧图标。 国内版仅 MIUI12 以上版本支持，以下版本均不支持；国际版支持。 图片要求：大小 120 * 120px，格式为 png 或者 jpg 格式。
  pushConfigs.OPPO.channelId	String	否	OPPO 推送通知渠道的 ID，详细请参见 OPPO PUSH 通道升级说明。
  pushConfigs.VIVO.classification	Number	否	vivo 推送通道类型。0：运营消息。1：系统消息。默认使用 App Key 在控制台 vivo 推送中设置的推送通道类型。详见 vivo 官方文档消息分类功能说明。
  pushConfigs.APNs.thread-id	String	否	iOS 平台通知栏分组 ID。相同的 thread-id 推送分一组，单组超过 5 条推送会折叠展示。
  pushConfigs.APNs.apns-collapse-id	String	否	适用于 iOS 平台。设置后设备收到有相同 ID 的消息，会合并成一条。 仅支持 iOS 10.0 及以上版本。
  pushConfigs.APNs.richMediaUri	String	否	适用于 iOS 平台。iOS 推送自定义的通知栏消息右侧图标 URL，需要 App 自行解析 richMediaUri 并实现展示。仅支持 iOS 10.0 及以上版本。
  pushConfigs.APNs.interruption-level	String	否	适用于 iOS 15 及之后的系统。取值为 passive，active（默认），time-sensitive，或 critical，取值说明详见对应的 APNs 的 interruption-level 字段。在 iOS 15 及以上版本中，系统的 “定时推送摘要”、“专注模式” 都可能导致重要的推送通知（例如余额变化）无法及时被用户感知的情况，可考虑设置该字段。
  pushConfigs.FCM.channelId	String	否	FCM 推送通知渠道的 ID。应用程序必须先创建一个具有此频道 ID 的频道，然后才能收到具有此频道 ID 的任何通知。更多信息请参见安卓官方文档。
  pushConfigs.FCM.collapse_key	String	否	适用于 Android 平台。可以折叠的一组消息的标识符，以便在可以恢复传递时仅发送最后一条消息。
  pushConfigs.FCM.imageUrl	String	否	适用于 Android 平台。FCM 推送自定义的通知栏消息右侧图标 URL，如果不设置，则不展示通知栏右侧图标。 图片的大小上限为 1MB。 要求控制台 FCM 推送配置为证书与通知消息方式。

• pushExt 结构示例

   
  {
     "title":"you have a new message.",
     "templateId":"123456",
     "forceShowPushContent":0,
     "pushConfigs": [
         {
             "HW": {
               "channelId": "hw-123",
               "importance": "NORMAL",
               "image":"https://example.com/image.png"
             }
         },
         {
             "MI": {
               "channelId": "mi-123",
               "large_icon_uri":"https://example.com/image.png"
             }
         },
         {
             "OPPO": {"channelId": "oppo-123"}
         },
         {
             "VIVO" : {"classification": "0"}
         },
         {
             "APNs": {
                 "thread-id": "123",
                 "apns-collapse-id":"123456",
                 "richMediaUri":"https://example.com/image.png"
             }
         },
         {
             "FCM": {
              "channelId":"rongcloud_channelid",
              "collapse_key":"1234",
              "imageUrl":"https://example.com/image.png"
              }
         }
     ]
  }
                
  
                  
  已复制
                  复制代码
                
                
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  
  
  

请求示例

 
POST /message/ultragroup/publish.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "fromUserId":"why456",
    "objectName":"RC:TxtMsg",
    "content":"{\"content\":\"hh0217890\",\"mentionedInfo\":{\"type\":2,\"userIdList\":[\"123\",\"456\"],\"mentionedContent\":\"有人@你\"}}",
    "toGroupIds":["why66-ultra"],
    "isPersisted":1,
    "isMentioned":1}
}
              

                
已复制
                复制代码
              
              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回结果示例

 
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
              

                
已复制
                复制代码
              
              
1
2
3
4