服务端
API 参考
圈组

更新消息

更新时间: 2024/05/24 15:57:51

更新消息的相关信息,包括消息状态(删除、撤回或自定义状态)、是否需要抄送(即同步至客户端服务器)、是否经由安全通(易盾反垃圾)进行内容审核等。

URL

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

请求参数

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

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

    参数

    类型

    是否必填

    说明

    operatorAccid

    String

    操作者的 IM 账号(accid)

    operatorMsg

    string

    更新操作的附言

    operatorExt

    string

    更新操作的扩展字段

    operatorPushContent

    String

    更新操作的推送文案,最大500字符(暂不支持)

    operatorPushPayload

    JSON Array

    更新操作的推送扩展字段,最大2,048字符(暂不支持)

    serverId

    long

    服务器 ID

    channelId

    long

    频道ID

    msgIdServer

    long

    云信服务端生成的消息 ID

    time

    long

    消息发送时间

    body

    String

    消息内容,最大5,000字符

    ext

    String

    扩展字段,最大1,024字符

    status

    int

    消息状态:

  • 0是消息默认状态
  • 1表示撤回,默认只能在消息发送后 2 分钟内撤回。可在云信控制台配置“可撤回时长”(在云信控制台选择应用,进入IM 即时通讯 > 功能配置 > 圈组 > 子功能配置 > 圈组消息可撤回时长即可配置)。
  • 2表示删除
  • 支持设置大于等于 10,000 的数字作为自定义状态

    env

    String

    当前消息需要抄送到的环境的名称,对应您在云信控制台中配置的自定义抄送的环境名称(如下图),最大 32 个字符

    routeEnable

    String

    是否需要抄送, 0: 不需要, 1: 需要, 默认1

    antispam

    String

     对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测(antispamCustom)。

     true或false, 默认false。

    只对消息类型为:100 自定义消息类型 的消息生效。

    antispamCustom

    String

    在 antispam 参数为 true 时生效。

    自定义的反垃圾检测内容, JSON 格式,长度限制同 body 字段,不能超过 5,000 字符,要求 antispamCustom 格式如下:

    {"type":1,"data":"custom content"}

    字段说明:

    type: 1-文本,2-图片。

    data: 文本内容或图片 URL地址

    bid

    String

    可选,易盾反垃圾业务ID,实现“单条消息配置对应的反垃圾业务规则”,若不填则使用原来的反垃圾配置

    useYidun

    String

    0:(在开通易盾的情况下)不使用易盾反垃圾,包括自定义消息。

    若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断

    yidunAntiCheating

    String

    可选,易盾反垃圾含圈组反作弊专属字段,限制 JSON 格式,长度限制 1,024 字符

    yidunAntiSpamExt

    String

    可选,易盾反垃圾扩展字段,限制 JSON 格式,长度限制1,024

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49**el1kglw0803mgq3" -H "Nonce: 4tgg**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'operatorAccid=zhangsan&msgIdServer=1&serverId=1&channelId=1&time=123&body=abc' 'https://api.netease.im/nimserver/qchat/updateMsg.action'

返回示例

HTTP 响应:JSON

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

状态码

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

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