发送群组消息

POST

https://zim-api.zego.im/

发送群组消息，并推送给群组内的所有在线用户。

客户端将通过 ZIM SDK 的回调接口，接收群组消息的通知。

说明

开通内容审核功能后，默认情况下服务端发送的消息会进行审核。如果服务端发送的消息不需要审核，请联系 ZEGO 技术支持进行配置。

iOS	Android	macOS	Windows
groupMessageReceived	onGroupMessageReceived	groupMessageReceived	onGroupMessageReceived

Web	小程序	Flutter	React Native
groupMessageReceived	groupMessageReceived	onGroupMessageReceived	groupMessageReceived

Unity3D	uni-app \| uni-app x	HarmonyOS
onReceiveGroupMessage	groupMessageReceived	groupMessageReceived

说明

参数 FromUserId、GroupId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

说明

如果发送方使用的 SDK 版本（版本说明请参考发布日志）低于 2.0.0，ZIM 服务端对应的仅支持 MessageType 为 2 的 Command 类型消息，不支持其他类型。
为了给开发者带来更好的体验，ZEGO 推荐开发者使用最新版本的 SDK。

如果发送方请求发送 MessageType 为 1 的文本消息，则发送方对应的客户端（SDK 版本需为 2.7.0 或以上）也会收到该消息。

对于发送和接收 MessageType 为 200 的自定义消息，发送方和接收放对应的客户端的 SDK 版本需为 2.8.0 或以上。

如果接收端的 SDK 版本介乎 [2.0.0, 2.8.0) 区间，可以收到自定义消息时，但会显示此消息类型为未知，且无法获取信息内容。如需获取此条消息，请将 SDK 升级为 2.8.0 或以上版本。

如果接收端的 SDK 版本为 1.x.x 版本，则无法收到自定义消息，也不会收到未知消息。

说明

调用频率限制：10 次/秒。

Request

Query Parameters

Action string必填

可选值: [SendGroupMessage]

接口原型参数

https://zim-api.zego.im/?Action=SendGroupMessage

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

发送方的用户 ID（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册）。

GroupId string必填

可选值: <= 32 characters

群组 ID。

MessageType int32必填

消息类型，群组会话的适用类型请参考 MessageBody 说明。

Priority int32必填

可选值: [1, 2, 3]

消息优先级（详情请参考基本概念介绍 - 消息优先级），取值如下：

1：低。
2：中。
3：高。

MessageBody object必填

消息内容，具体参数格式请参考 MessageBody 说明。

SubMsgType number

具体的自定义类型。值由开发者定义，取值范围为 [0,200]。当 MessageType 为自定义消息时，才需赋值此参数。

SearchedContent string

自定义消息的检索字段。当 MessageType 为自定义消息时，才可填写此字段，长度上限默认为 64 字节。此字段作用于客户端，除非填写了此字段，否则无法通过客户端搜索到关联的自定义消息。

SendMsgOptions object

可选配置项。

NoUnread boolean

此消息是否会增加接收方的消息未读数。

false: （默认值）会。
true：不会。

TargetOption object

群定向消息的配置项。

注意
如果配置了 TargetOption 参数， NoUnread 无论设置为 false 还是 true 此消息都不会计入未读数。

ReceiverUserIds string[]

用户 ID 列表。

Inclusive boolean

指向类型。

false：（默认）反向指向，即 ReceiverUserIds 列明的用户不会收到此消息。
true：正向指向，即仅 ReceiverUserIds 列明的用户会收到此消息。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660000025	MessageBody 中 IsBase64 传入 1 后，发送经 base64 编码的信令消息失败。	请确认：请确认 IsBase64 是否需要为 1，即是否需要发送二进制类型信令消息。请确认消息内容是否经 base64 编码。
660400001	输入的消息大小超出限制。	请检查输入的消息大小。
660500002	消息发送者未登录过 SDK。	请用户先登录后再发送消息。
660600001	输入的 GroupId 不存在。	请确认输入的 GroupId 是否正确。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

MsgSeq number

消息 Seq。当消息类型为信令消息时，此字段为空。可用于撤回群聊消息。

MsgId number

消息 ID。

AuditInfos object[]

审核结构数组，当数组不为空时，说明存在审核失败的消息，可以通过该结构查看审核失败原因。

Array[

Index number

此参数可能出现以下几种情况：

当您已启用 ZIM 内容审核服务，且未通过发送消息前回调拒绝该消息时：
- 对于组合消息，此参数表示未通过审核的 Item 在组合消息中的索引，从 0 开始。
- 对于其他类型消息，则此参数始终为 0。
当您收到发送消息前回调后拒绝了此消息，则不论消息类型，此参数始终为 0。

Reason string

拒绝原因。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "MsgSeq": 1,
  "MsgId": 1,
  "AuditInfos": [
    {
      "Index": 0,
      "Reason": "reason"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "MsgSeq": 1,
  "MsgId": 1,
  "AuditInfos": [
    {
      "Index": 0,
      "Reason": "reason"
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。