圈组自定义系统通知支持用户主动发送，并可以指定发送给服务器全体成员或部分成员。

URL

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

请求参数

• POST 请求中的 Headers 的设置请参考接口概述。
• POST 请求中的 Body 的设置如下：

参数	类型	必填	说明
toType	int	必填	1：发送给指定服务器的全体成员。只能发送给在线账号，不支持存离线 2：发送给某个频道的全体成员。只能发送给在线账号，不支持存离线 3：发送给服务器的某些成员，支持存离线 4：发送给指定频道的某些成员，支持存离线
from	String	必填	发送者的 IM 账号
serverId	long	必填	服务器 ID
channelId	long	选填	频道 ID
msgIdClient	String	选填	客户端消息 ID
toAccids	JSON Array	选填	接收方 IM 账号列表，最多 100 个如果自定义系统通知需存离线，toAccids 不能为空。
attach	String	选填	通知附件，最多可包含 5000 字符
body	String	选填	通知内容，最多可包含 5,000 字符
ext	String	选填	通知扩展字段，最多可包含 1,024 字符
pushContent	String	选填	推送文案，最多可包含 500 字符，具体请参见 推送配置参数详解
pushPayload	JSON	选填	推送对应的 payload，必须是 JSON 格式，不能超过 2048 字符。更多说明请参见 推送 payload 配置
option	JSON	选填	发送自定义系统通知时特殊指定的行为选项，可用于指定系统通知是否存离线、离线推送等特殊行为；option 中字段不填时表示默认值，具体字段如下： push: 该消息是否需要 APNS 推送或安卓系统通知栏推送，默认 true persist：该消息是否存离线，只有不是发送给服务器或频道全员（即上文中 toType 为 3 或 4）的自定义系统通知支持存离线，默认 false。一个月内最多 1000 条存离线 badge：该消息是否需要计入到未读计数中，默认 true needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认 true routeEnable：是否需要抄送, 0-不需要, 1-需要, 默认 1 示例：{"push":false, "persist":false, "badge":false, "needPushNick":true, "routeEnable":1}
env	String	选填	当前的自定义系统通知需要抄送到的环境的名称，对应您在云信控制台中配置的自定义抄送的环境名称（如下图），最大 32 个字符

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk***gq3" -H "Nonce: 4tggg***3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&toType=1&serverId=1&channelId=1&body=abc' 'https://api.netease.im/nimserver/qchat/sendAttachMsg.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "data": {
        "type": 100,
        "time": 112121,
        "msgIdClient": "sasas",
        "msgIdServer": 123
     }
}

状态码

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

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能
404	对象不存在	检查是否存在必传参数为空的问题 检查传入的 IM 账号、服务器 ID、频道 ID、消息 ID 等是否存在
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低调用频率
431	HTTP 重复请求	-