网易云信服务端支持发送超大群自定义系统通知。

本文介绍如何调用发送超大群自定义系统通知的接口。

功能描述

给超大群发送自定义系统通知，自定义系统通知区别于普通消息，方便开发者进行业务逻辑的通知。

API 使用限制

• 单个应用最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒，之后才可再次调用。
• 当超大群人数级别大于 2000 人时，还会根据 tid 做流控处理，10次/秒，超过返回 416 错误码。

URL

httpPOST https://api.netease.im/nimserver/superteam/sendAttachMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必填	说明
from	String	是	发送者账号，accid，最大长度 32 位字符
to	Long	是	接收系统通知的超大群 ID（即 tid），最大长度 64 位长整型
attach	String	是	自定义系统通知的具体内容，开发者组装的字符串，建议 JSON 格式，最大长度 4096 位字符
pushContent	String	否	iOS 推送内容，最大长度 500 位字符 更多推送说明请参见 推送配置参数详解
pushPayload	String	否	iOS 推送对应的 pushPayload，必须 JSON 格式，最大长度 2048 位字符 更多推送说明请参见 推送配置参数详解
sound	String	否	如果有指定推送，此属性指定为客户端本地的声音文件名，最大长度 30 位字符，如果不指定，会使用默认声音
save	Integer	否	1，只发在线系统通知；2，会存离线，默认会存离线，只在超大群人数范围生效
option	String	否	发通知时特殊指定的行为选项，JSON 格式，可用于指定该自定义系统通知是否计入未读数等特殊行为；option 中字段如果不填，则自动使用默认值 option 示例： {"badge":false,"needPushNick":false,"route":false} 字段说明： badge：该系统通知是否需要计入到未读计数中，默认 true needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认 false route: 该消息是否需要抄送至第三方；默认true（需要应用开通消息抄送功能）
isForcePush	String	否	发自定义系统通知时，是否强制推送，默认 false
forcePushContent	String	否	发自定义系统通知时，强制推送的文案，最大长度 500 位字符
forcePushAll	String	否	发群自定义系统通知时，强推列表是否为群里除发送者外的所有有效成员，默认 false
forcePushList	String	否	发群自定义系统通知时的强推列表，格式为 JSONArray，示例：["accid1","accid2"]，列表内最多 100 个用户如果不是强推所有人，也没有明确的强推账号列表，那么这种强推不生效

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dn**1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&to=123&attach=%7B%22myattach%22%3A%22test%22+%7D' 'https://api.netease.im/nimserver/superteam/sendAttachMsg.action'

请求成功返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "tid not exist!"  // 群不存在
}

状态码

该接口在 HTTPS Body 中返回请求的状态码，以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。

状态码	说明	处理建议
200	请求成功	-
403	禁止操作： 发送者不属于当前群成员 超大群功能未开通 通知信息未通过反垃圾	根据对应提示信息做出处理
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超出限制	降低访问频率
500	服务出错	-