添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接
更新日志
服务端集成新手必看
接口及业务限制
平台服务
第三方回调
回调说明
用户信息相关回调
消息相关回调
高级群相关回调
超大群相关回调
聊天室相关回调
音视频1.0相关回调
消息抄送
消息抄送服务概述
开通和配置消息抄送
IM 会话相关抄送
IM 会话已读数据抄送
IM 其他抄送
安全通
最佳实践
使用 Postman 调试
API 参考
API 调用方式
API 概览与频控
状态码/错误码
云信 IM 账号管理
注册云信 IM 账号
刷新Token
封禁账号
账号全局禁言
账号功能模块禁言
登录鉴权
消息功能
发送消息
批量发送单聊消息
发送单聊已读回执
发送群聊已读回执
消息撤回
发送广播消息
文件上传
历史消息与记录
云端历史消息查询
自定义系统通知
用户名片
用户关系管理
群组
高级群
创建高级群
拉人入群
发送群消息
添加管理员
移除管理员
转让群主
禁言群组
禁言指定群成员
踢人出群
修改群成员昵称
修改群组信息
设置群消息免打扰
主动退群
解散群组
获取群组详细信息
获取群组禁言列表
获取群消息已读未读详情
获取用户已加入的群组信息
获取用户已加入的群组的所有群成员信息
获取群组的在线成员列表
超大群
创建超大群
拉人入群
发送超大群消息
发送超大群自定义系统通知
撤回超大群消息
添加管理员
移除管理员
转让群主
禁言超大群
禁言指定超大群成员
踢人出群
主动退群
修改超大群成员昵称
修改超大群信息
修改超大群成员信息
解散超大群
修改超大群人数级别
获取超大群信息
聊天室
创建聊天室
获取聊天室地址
更新聊天室信息
查询聊天室信息
开放/关闭聊天室
查询开放状态的聊天室
设置聊天室定时关闭
开启/关闭进出聊天室事件通知
聊天室踢人
管理聊天室用户角色
获取聊天室成员列表
聊天室消息管理
发送聊天室消息
批量发送聊天室消息
撤回聊天室消息
发送聊天室定向消息
管理聊天室机器人
聊天室禁言
聊天室标签
圈组
圈组 API 概览
获取圈组连接地址
服务器相关
创建服务器
修改服务器信息
删除服务器
服务器成员相关
邀请服务器成员
接受邀请
拒绝邀请
申请加入服务器
接受申请
拒绝申请
生成邀请码
通过邀请码加入
踢出成员
主动退出服务器
修改自己的成员信息
查询个人的申请和邀请记录
更新成员封禁状态
分页查询封禁成员列表
修改他人的成员信息
分页查询服务器成员列表
频道相关
创建频道
修改频道基础信息
修改频道分组相关信息
删除频道
分页查询频道列表
查询未在频道分组中的频道信息
批量查询频道信息
分页查询频道成员列表
修改频道黑白名单成员
修改频道黑白名单身份组
分页查询频道黑白名单成员列表
分页查询频道黑白名单身份组列表
频道分组相关
创建频道分组
修改频道分组信息
删除频道分组
批量查询频道分组信息
分页查询频道分组列表
分页查询频道分组下的频道列表
修改频道分组黑白名单身份组
修改频道分组黑白名单成员
分页查询频道分组的黑白名单身份组列表
分页查询频道分组的黑白名单成员列表
身份组相关
服务器身份组
身份组成员管理
频道身份组
频道用户定制权限
频道分组身份组
频道分组用户定制权限
圈组消息相关
发送消息
更新消息
查询云端历史消息
查询 Thread 聊天历史
批量查询Thread聊天meta 信息
更新快捷评论
系统通知相关
圈组系统通知概述
搜索结果自定义排序
临时禁言相关

发送自定义系统通知

更新时间: 2024/07/17 17:57:34

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

自定义系统通知区别于普通消息,方便开发者进行业务逻辑的通知。目前支持两种自定义系统通知类型: 点对点类型 群类型 (仅限高级群),通过 msgType 参数进行区分。

典型应用场景:某个用户给另一个用户发送好友请求,开发者可自定义该请求的具体内容(建议是 JSON 格式)。

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

    单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

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

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

    POST 请求中 Body 的设置如下:

    参数类型必填说明 fromString是发送者accid,用户帐号,最大32字符,APP内唯一 msgtypeint是0:点对点自定义通知,1:群消息自定义通知,其他返回414 toString是msgtype=0 时需填入接收系统通知的用户的的云信 IM 账号(accid),msgtype=1 时需填入接收系统通知的群的 ID(即 tid),最大 32 字符 attachString是自定义系统通知的具体内容,开发者组装的字符串,建议 JSON 格式,最大长度 4096 字符 pushcontentString否推送文案,最长 500 个字符。更多推送说明请参见 推送配置参数详解。若未设置 pushcontent 字段,则不会触发推送服务,但会将 payload 字段内容下发给客户端。 payloadString否推送对应的 payload,必须是 JSON 格式,不能超过 2048 字符。更多说明请参见 推送 payload 配置 soundString否如果有指定推送,此属性指定为客户端本地的声音文件名,长度不要超过 30 个字符,如果不指定,会使用默认声音 saveint否只能传入 1 或 2,1 表示只发在线,2 表示会存离线,传入其他值将报错(状态码:414)。默认会存离线 option String否发消息时特殊指定的行为选项,JSON 格式,可用于指定该自定义系统通知是否计入未读数等特殊行为。option 中字段如果不填,则自动使用默认值
    option 示例:
    {"badge":false,"needPushNick":false,"route":false}
    字段说明:
    • badge:该系统通知是否需要计入到未读计数中,默认 true
    • needPushNick: 推送文案是否需要带上昵称,不设置该参数时默认 false (注意默认值与sendMsg.action 接口的 needPushNick 有别)
    • route: 该消息是否需要抄送至您指定的应用服务器;默认true (需要应用开通消息抄送功能)
    isForcePush boolean 否 发自定义系统通知时,是否强制推送,默认 false forcePushContent String 否 发自定义系统通知时,强制推送的文案,最长 500 个字符 forcePushAll boolean 否 发群自定义系统通知时,强推列表是否为群里除发送者外的所有有效成员,默认 false forcePushList String 否 发群自定义系统通知时的强推列表,格式为 JSONArray,示例:["accid1","accid2"],列表内最多 100 个用户 env String 否系统通知需要抄送到的环境的名称,对应您在云信控制台中配置的自定义抄送的环境名称(如下图),最大 32 个字符
    自定义抄送环境
    checkAccidAsyncEnable boolean 否 是否 异步 检查用户账号 ID。默认为 false。
    若设为 true,表示开启异步检查。开启后,无效账号不会再返回返回结果中不会包含 unregister 字段当发送对象较多,且耗时较长时,建议开启该配置。

    cURL请求示例

    curlcurl -X POST -H "AppKey: go9dnk49***lw0803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&msgtype=0&to=lisi&attach={"myattach":"test"}' 'https://api.netease.im/nimserver/msg/sendAttachMsg.action'
    

    请求成功返回示例

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

    请求失败返回示例

    "Content-Type": "application/json; charset=utf-8"
        "code":414
        "desc":"check msgType"  // msgType参数不是"0""1"
    

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