服务端
API 参考
圈组

更新自定义系统通知

更新时间: 2024/03/15 14:31:53

云信服务端支持更新部分类型的系统通知。只有存离线的系统通知支持更新,并且只有系统通知接收方可更新。可更新的信息包括通知内容、通知扩展字段、通知状态等。

功能介绍

接收方可更新的系统通知类型如下表所示:

系统通知分类 相关限制
内置系统通知 邀请服务器成员
SERVER_MEMBER_INVITE(1)
默认自动存离线。这四种通知每月总共至多存 1000 条离线,超限后将无法更新通知的信息
拒绝邀请
SERVER_MEMBER_INVITE_REJECT(2)
申请加入服务器
SERVER_MEMBER_APPLY(3)
拒绝申请
SERVER_MEMBER_APPLY_REJECT(4)
自定义系统通知
CUSTOM(100)
只有存离线的自定义系统通知才能更新。每月至多存 1000 条离线,超限后将无法更新通知的信息

URL

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

请求参数

  • POST 请求中的 Headers 的设置请参考接口概述
  • POST 请求中的 Body 的设置如下:
参数类型必填说明
operatorAccidString操作者的 IM 账号
operatorMsgString更新操作的附言,最多 128 字符
operatorExtString更新操作的扩展字段,最多 128 字符
serverIdLong服务器 ID
channelIdLong频道 ID
msgIdServerString服务端给出的消息 ID
timeString通知发送时间
typeString通知类型
bodyString通知 body 内容,最多 5,000 字符
routeEnableString是否需要抄送, 0-不需要, 1-需要, 默认 1
extString通知扩展字段,最多 1,024 字符
statusString通知状态
0 是通知默认状态
支持设置大于等于 10,000 的数字作为自定义状态
envString当前的自定义系统通知需要抄送到的环境的名称,对应您在云信控制台中配置的自定义抄送的环境名称(如下图),最大 32 个字符

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dn***03mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***c55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'operatorAccid=zhangsan&msgIdServer=1&serverId=1&channelId=1&time=123&type=100&body=abc' 'https://api.netease.im/nimserver/qchat/updateAttachMsg.action'

返回示例

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

状态码

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

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