服务端
API 参考
圈组

删除漫游消息

更新时间: 2024/03/15 14:27:33

本文介绍如何通过云信服务端 API 删除漫游消息。

功能描述

网易云信服务端支持按会话类型(单聊、高级群、超大群)删除漫游消息。

使用场景

漫游消息中包含涉黄、涉政等敏感信息时:

  • 应用管理员调用本接口删除违规消息。
  • 应用服务器通过本接口自动触发违规消息删除。

API 使用限制

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

URL

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

请求参数

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

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

参数类型必填说明
type int 会话类型,1-单聊,2-高级群,3-超大群,其他返回 414
from String 发送者的云信 IM 账号(accid),最大长度 32 个字符
to String 消息接收方。
  • 如果 type=1 则需传入消息接收者的云信 IM 账号(accid)。
  • 如果 type=2 则需传入高级群 ID (tid)。
  • 如果 type=3 则需传入超大群 ID (tid)。
  • 示例

    cURL请求示例

    curlcurl -X POST -H "AppKey: go9dnk4**0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'type=2&from=cs4&to=2775725369' 'https://api.netease.im/nimserver/msg/delRoamSession.action'
    

    请求成功返回示例

    http 响应:json

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

    请求失败返回示例

    "Content-Type": "application/json; charset=utf-8"
    {
        "code":414,
        "desc":"type must be 1 or 2"  // type值不合法
    }
    

    状态码

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

    状态码 说明 处理建议
    403 请求失败原因可能为:
    • 应用专属集群检查不通过
    • 应用不可用
    查看对应提示信息做出处理
    414 参数错误 根据提示信息,检查传入参数的格式和限制条件
    500 服务出错 -
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 使用场景
    • API 使用限制
    • URL
    • 请求参数
    • 示例
    • cURL请求示例
    • 请求成功返回示例
    • 请求失败返回示例
    • 状态码