网易云信服务端支持发送自定义的系统通知。目前支持用户在单聊会话、高级群会话以及超大群会话中发送自定义系统通知。

功能描述

自定义系统通知区别于普通消息，主要方便开发者进行业务逻辑的通知。例如：某用户给另一用户发送好友请求，您可自定义该请求的具体内容（建议 JSON 格式）。

• 支持收发在线和离线的自定义系统通知，且支持接收方多端同步接收自定义系统通知。
• 不支持漫游且不支持保存为云端历史记录。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求信息

请求 URL

POST https://{endpoint}/im/v2/custom_notification

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

请求体参数

参数名称	类型	是否必选	描述
sender_id	String	是	发送者 IM 账号 ID。
type	Integer	是	自定义系统通知类型。1：单聊系统通知。2：高级群系统通知。3：超大群系统通知。
receiver_id	String	是	系统通知接收者 ID。type =1 时，该参数接收者账号 ID。type = 2 或 3 时，该参数为接收的群 ID（创建群组时服务器生成并返回的 ID）。
content	String	是	自定义系统通知的内容，由开发者自行组装的 JSON 格式字符串，长度上限 4096 位字符。
sound	String	否	指定的客户端本地的声音文件名，长度上限 30 位字符。
- notification_config	Object	否	通知配置项，不填则采用默认值。
offline_enabled	Boolean	否	是否需要存离线消息，默认为 true（存离线）。
unread_enabled	Boolean	否	是否计入未读数，默认为 true（计入）。
- push_config	Object	否	推送相关配置项。
push_enabled	Boolean	否	该消息是否需要 APNs 推送或 Android 系统通知栏推送，默认为 true（推送）。只有该字段为 true 时，推送相关参数才会生效。
push_nick_enabled	Boolean	否	推送文案是否需要带上昵称，默认为 true（带昵称）。
push_content	String	否	推送文案，长度上限 500 位字符。若未设置 push_content 字段，则不会触发推送服务，但会将 push_payload 字段内容下发给客户端。
push_payload	String	否	推送对应的 payload，必须是 JSON 格式，长度上限 2048 位字符。详情请参考 推送 payload 配置。
push_forcepush_enable	Boolean	否	该消息（群消息）是否强制推送（@操作），默认为 false。只有该字段为 true 时强制推送相关参数才会生效。
push_forcepush_all	Boolean	否	该消息（群消息）是否强制推送（@操作）给群组中所有有效成员（除消息发送者），默认为 false。
push_forcepush_ids	Array of strings	否	该消息（群消息）的强推（@操作）账号列表，格式为 JSONArray，如["account1","account2"]。若 push_forcepush_all 为 true，则该字段无效，该消息会强制推送（@操作）给群组中所有有效成员（除消息发送者）。最多可强推 100 个用户。
push_forcepush_content	String	否	强制推送的文案，仅针对强推列表 push_forcepush_ids 中的账号，长度上限 500 位字符。
- route_config	Object	否	抄送相关配置项。
route_enabled	Boolean	否	该消息是否需要抄送至指定的应用服务器（需要为应用开通消息抄送功能），默认为 true（抄送）。
route_environment	String	否	当前消息需要抄送到的环境的名称，对应您在 网易云信控制台 中配置的自定义抄送的环境名称。

请求体示例

JSON{
  "sender_id": "sender123456",
  "type": 1,
  "receiver_id": "receiver123456",
  "content": "string",
  "push_config": {
    "push_enabled": true,
    "push_nick_enabled": true,
    "push_content": "string",
    "push_payload": null,
    "push_forcepush_enable": false,
    "push_forcepush_all": false,
    "push_forcepush_ids": [
      "56"
    ],
    "push_forcepush_content": "string"
  },
  "sound": "string",
  "route_config": {
    "route_enabled": true,
    "route_environment": "string"
  },
  "notification_config": {
    "offline_enabled": true,
    "unread_enabled": true
  }
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {}
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
108404	群不存在	team not exist
108302	非高级群	not advanced team
108311	超大群服务未开通	super team service disabled
109404	群成员不存在	team member not exist
500	服务器内部错误	internal server error
503	服务器繁忙	server busy