IM 即时通讯
服务端
服务端集成新手指南
接口及业务限制
更新日志
平台服务
第三方回调
第三方回调概述
消息相关回调
用户信息相关回调
高级群相关回调
超大群相关回调
聊天室相关回调
音视频1.0相关回调
登录相关回调
圈组相关回调
消息抄送
消息抄送服务概述
开通消息抄送
IM会话相关抄送
IM 会话已读数据抄送
IM其他抄送
圈组相关抄送
音视频和白板相关抄送
安全通
安全通概述
开通 IM 安全通
最佳实践
聊天室重要消息投递
IM 平滑迁移方案
API 参考
API调用方式
状态码
云信 IM 账号管理
注册云信IM账号
刷新Token
封禁账号
账号全局禁言
设置移动端是否需要推送(桌面端在线时)
登录鉴权
消息功能
发送消息
消息撤回
发送广播消息
文件上传
删除单条消息
删除漫游消息
历史消息与记录
云端历史消息查询
广播消息查询
IM 登录/登出记录查询
自定义系统通知
用户名片
用户关系管理
好友关系管理
黑名单/静音管理
群组
高级群
创建高级群
拉人入群
发送群消息
添加管理员
移除管理员
转让群主
禁言群组
禁言指定群成员
踢人出群
主动退群
修改群昵称
修改群组信息
设置群消息提醒开关
解散群组
获取群组详细信息
获取群组禁言列表
获取群消息已读未读详情
获取用户已加入的群组信息
获取用户已加入的群组的所有群成员信息
获取群组的在线成员列表
批量获取群组信息与成员列表
批量获取群组的在线成员数量
超大群
创建超大群
拉人入群
发送超大群消息
发送超大群自定义系统通知
撤回超大群消息
添加管理员
移除管理员
转让群主
禁言超大群
禁言指定超大群成员
踢人出群
主动退群
修改超大群昵称
修改超大群信息
修改超大群成员信息
解散超大群
修改超大群人数级别
获取超大群信息
获取超大群成员信息
获取超大群禁言成员信息
获取已加入的超大群信息
查询超大群云端历史消息
聊天室
创建聊天室
获取聊天室地址
更新聊天室信息
查询聊天室信息
修改聊天室开放/关闭状态
设置聊天室定时关闭
开启/关闭进出聊天室事件通知
管理聊天室用户角色
获取聊天室成员列表
聊天室消息管理
发送聊天室消息
批量发送聊天室消息
撤回聊天室消息
发送聊天室定向消息
批量发送聊天室定向消息
发送聊天室全服广播消息
管理聊天室机器人
聊天室禁言
聊天室标签
管理聊天室队列
管理聊天室队列元素
查询聊天室统计指标
圈组
获取圈组连接地址
服务器相关
创建服务器
修改服务器信息
删除服务器
批量查询服务器信息
分页查询服务器列表
服务器成员相关
邀请服务器成员
接受邀请
拒绝邀请
申请加入服务器
接受申请
拒绝申请
生成邀请码
通过邀请码加入
踢出成员
主动退出服务器
修改自己的成员信息
修改他人的成员信息
分页查询服务器成员列表
批量查询服务器成员信息
查询服务器的申请和邀请记录
查询个人的申请和邀请记录
更新成员封禁状态
分页查询封禁成员列表
频道相关
创建频道
修改频道基础信息
修改频道分组相关信息
删除频道
分页查询频道列表
批量查询频道信息
分页查询频道成员列表
修改频道黑白名单成员
修改频道黑白名单身份组
分页查询频道黑白名单成员列表
分页查询频道黑白名单身份组列表
批量查询频道黑白名单成员
批量查询频道黑白名单身份组
频道分组相关
身份组相关
服务器身份组
身份组成员管理
频道身份组
频道用户定制权限
频道分组身份组
频道分组用户定制权限
身份组自定义权限项
查询用户拥有的权限
圈组消息相关
发送消息
更新消息
查询云端历史消息
查询 Thread 聊天历史
批量查询Thread聊天meta 信息
更新快捷评论
查询快捷评论
系统通知相关
圈组系统通知概述
发送自定义系统通知
更新自定义系统通知
搜索结果自定义排序
修改服务器自定义排序值
修改频道自定义排序值
在线状态订阅
文本翻译

聊天室管理(已不再维护))

更新时间: 2022/12/20 14:57:42

本文已不再维护,请前往创建聊天室及其同级目录查看聊天室相关服务端 API 文档。

创建聊天室

URL

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

请求中Headers的设置请参考接口概述

接口描述

创建聊天室

参数说明

参数类型必须说明
creator String 聊天室属主的账号accid
name String 聊天室名称,长度限制128个字符
announcement String公告,长度限制4096个字符
broadcasturl String 直播地址,长度限制1024个字符
ext String 扩展字段,最长4096字符
queuelevel int 队列管理权限:0:所有人都有权限变更队列,1:只有主播管理员才能操作变更。默认0
bid String 反垃圾业务ID,JSON字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置

curl请求示例

curl -X POST -H "CheckSum: fc040248923c881f2fe7cc39602b79565230155c" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217360" -H "Content-Type: application/x-www-form-urlencoded" -d 'name=mychatroom&announcement=&broadcasturl=xxxxxx&creator=zhangsan' 'https://api.netease.im/nimserver/chatroom/create.action'

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "chatroom": {
    "roomid": 66,
    "valid": true,
    "announcement": null,
    "name": "mychatroom",
    "broadcasturl": "xxxxxx",
    "ext": "",
    "creator": "zhangsan"
  },
  "code": 200
}

主要的返回码

200、403、414、416、419、431、500

具体请参考code状态表


查询聊天室信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查询聊天室信息

参数说明

参数类型必须说明
roomid long 聊天室id
needOnlineUserCount String 是否需要返回在线人数,true或false,默认false

curl请求示例

curl -X POST -H "CheckSum: fc040248923c881f2fe7cc39602b79565230155c" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217360"  -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&needOnlineUserCount=true' 'https://api.netease.im/nimserver/chatroom/get.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "chatroom": {
    "roomid": 66,
    "valid": true,
    "muted":false, //聊天室是否处于全体禁言状态,全体禁言时仅管理员和创建者可以发言 
    "announcement": null,
    "name": "mychatroom",
    "broadcasturl": "xxxxxx",
    "onlineusercount": 1,
    "ext": "",
    "creator": "zhangsan",
    "queuelevel": 0,
    "ionotify": true	// 聊天室进出通知是否开启
  },
  "code": 200
}

主要的返回码

200、403、404、414、416、431、500

具体请参考code状态表


批量查询聊天室信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查询聊天室信息

参数说明

参数类型必须说明
roomids String 多个roomid,格式为:["6001","6002","6003"](JSONArray对应的roomid,如果解析出错,会报414错误),限20个roomid
needOnlineUserCount String 是否需要返回在线人数,true或false,默认false

curl请求示例

curl -X POST -H "CheckSum: fc040248923c881f2fe7cc39602b79565230155c" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217360"  -H "Content-Type: application/x-www-form-urlencoded" -d 'roomids=["6001","6002","6003"]&needOnlineUserCount=true' 'https://api.netease.im/nimserver/chatroom/getBatch.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
    "noExistRooms": [ //不存在的聊天室id列表
        6001
    ],
    "succRooms": [
        {
            "roomid": 6002,
            "valid": true,
            "announcement": "hi,this is announcement",
            "muted": false,
            "name": "6002 chatroom",
            "broadcasturl": "",
            "onlineusercount": 0,
            "ext": "6002 ext",
            "creator": "zhangsan",
            "queuelevel": 0,
    				"ionotify": true	// 聊天室进出通知是否开启
        }
    ],
    "failRooms": [ //失败的聊天室id,有可能是查的时候有500错误
	6003
    ],
    "code": 200
}

主要的返回码

200、403、404、414、416、431、500

具体请参考code状态表


更新聊天室信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

更新聊天室信息

参数说明

参数类型必须说明
roomid long 聊天室id
name String 聊天室名称,长度限制128个字符
announcement String 公告,长度限制4096个字符
broadcasturl String 直播地址,长度限制1024个字符
ext String 扩展字段,长度限制4096个字符
needNotify String true或false,是否需要发送更新通知事件,默认true
notifyExt String 通知事件扩展字段,长度限制2048
queuelevel int 队列管理权限:0:所有人都有权限变更队列,1:只有主播管理员才能操作变更
bid String 反垃圾业务ID,JSON字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置

curl请求示例

curl -X POST -H "CheckSum: 95a26060d002a473057a71cb7d949d6e91d6d167" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451214690" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&name=mynewchatroom&announcement=mynewchatroom' 'https://api.netease.im/nimserver/chatroom/update.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "chatroom": {
    "roomid": 66,
    "valid": true,
    "announcement": "这是聊天室",
    "name": "mychatroom",
    "broadcasturl": "xxxxxx",
    "ext": "",
    "creator": "zhangsan"
  },
  "code": 200
}

主要的返回码

200、403、404、414、416、431、500、13002

具体请参考code状态表


修改聊天室开/关闭状态

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

修改聊天室开/关闭状态

参数说明

参数类型必须说明
roomid long 聊天室id
operator String 操作者账号,必须是创建者才可以操作
valid String true或false,false:关闭聊天室;true:打开聊天室

curl请求示例

curl -X POST -H "CheckSum: 95a26060d002a473057a71cb7d949d6e91d6d167" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451214690"  -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&operator=zhangsan&valid=true' 'https://api.netease.im/nimserver/chatroom/toggleCloseStat.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "roomid": 13,
    "valid": true,
    "announcement": "这是聊天室",
    "name": "myChatroom",
    "broadcasturl": "http://www.xxxx.com/xxxxxx",
    "ext": "",
    "creator": "zhangsan"
  },
  "code": 200
}

主要的返回码

200、403、404、414、416、417、419、431、500

具体请参考code状态表


设置聊天室内用户角色

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

设置聊天室内用户角色

参数说明

参数类型必须说明
roomid long 聊天室id
operator String 操作者账号accid
target String 被操作者账号accid
opt int 操作:
1: 设置为管理员,operator必须是创建者
2:设置普通等级用户,operator必须是创建者或管理员
-1:设为黑名单用户,operator必须是创建者或管理员
-2:设为禁言用户,operator必须是创建者或管理员
optvalue String true或false,true:设置;false:取消设置;
执行“取消”设置后,若成员非禁言且非黑名单,则变成游客
notifyExt String 通知扩展字段,长度限制2048,请使用json格式

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&operator=zhangsan&target=lisi&opt=2&optvalue=true' 'https://api.netease.im/nimserver/chatroom/setMemberRole.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "roomid": 16,
    "level": 10,
    "accid": "zhangsan",
    "type": "COMMON"
  },
  "code": 200
}

备注:
返回的type字段可能为:
        LIMITED,          //受限用户,黑名单+禁言 
        COMMON,           //普通固定成员
        CREATOR,          //创建者 
        MANAGER,          //管理员 
        TEMPORARY,        //临时用户,非固定成员

主要的返回码

200、403、404、414、416、417、419、431、500、13002

具体请参考code状态表


请求聊天室地址

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

请求聊天室地址与令牌

参数说明

参数类型必须说明
roomid long 聊天室id
accid String 进入聊天室的账号
clienttype int 1:weblink(客户端为web端时使用); 2:commonlink(客户端为非web端时使用);3:wechatlink(微信小程序使用), 默认1
clientip String客户端ip,传此参数时,会根据用户ip所在地区,返回合适的地址

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f1234540c12345673123456847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&accid=zhangsan&clienttype=1' 'https://api.netease.im/nimserver/chatroom/requestAddr.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "addr": [
    "testchat.netease.im:6666",
    "testchat.netease.im:8888"
  ],
  "code": 200
}

主要的返回码

200、403、414、416、431、500、514、13002

具体请参考code状态表


发送聊天室消息

接口调用限制

1秒内默认最多可调用该接口100次。如需上调上限,请在官网首页通过微信、在线消息或电话等方式咨询商务人员。

  • 为保证用户体验(如避免服务器过载),目前针对消息接收,有两套流控机制。第一套针对普通消息,聊天室用户每秒至多可接收20条,超过部分会因为流控随机丢弃。第二套针对高优先级消息,每秒至多接收10条,超过部分无法保证不丢失。
  • 为避免丢失重要消息(通常为服务端消息),可将发送聊天室消息的 HighPriority 参数设置为 true 实现高优先级接收服务端消息,进而保证高优先级消息流控上限内(每秒10条)的重要消息不丢失。详情请参见本节参数说明中的 HighPriority 参数说明。

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

往聊天室内发消息

参数说明

参数类型必须说明
roomid long 聊天室id
msgId String 客户端消息id,使用uuid等随机串,msgId相同的消息会被客户端去重
fromAccid String 消息发出者的账号accid
msgType int 消息类型:
0: 表示文本消息,
1: 表示图片,
2: 表示语音,
3: 表示视频,
4: 表示地理位置信息,
6: 表示文件,
10: 表示Tips消息,
100: 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
subType int 自定义消息子类型,大于0
resendFlag int 重发消息标记,0:非重发消息,1:重发消息,如重发消息会按照msgid检查去重逻辑
attach String 文本消息:填写消息文案;
其它类型消息,请参考 消息格式示例
长度限制4096字符
ext String 消息扩展字段,内容可自定义,请使用JSON格式,长度限制4096字符
skipHistory int 是否跳过存储云端历史,0:不跳过,即存历史消息;1:跳过,即不存云端历史;默认0
abandonRatio int 可选,消息丢弃的概率。取值范围[0-9999];
其中0代表不丢弃消息,9999代表99.99%的概率丢弃消息,默认不丢弃;
注意如果填写了此参数,下面的highPriority参数则会无效;
此参数可用于流控特定业务类型的消息。
highPriority Boolean 可选,true表示是高优先级消息,云信会优先保障投递这部分消息;false表示低优先级消息。默认false。
强烈建议应用恰当选择参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置,单个聊天室最多支持每秒10条的高优先级消息,超过的会转为普通消息。 高优先级消息可以设置进入后重发,见needHighPriorityMsgResend参数
needHighPriorityMsgResend Boolean 可选,true表示会重发消息,false表示不会重发消息。默认true。注:若设置为true, 用户离开聊天室之后重新加入聊天室,在有效期内还是会收到发送的这条消息,目前有效期默认30s。在没有配置highPriority时needHighPriorityMsgResend不生效。
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾而是使用通用反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 可选,易盾反垃圾增强反作弊专属字段,限制json,长度限制1024字符(详见易盾反垃圾接口文档反垃圾防刷版专属字段
bid String 可选,反垃圾业务ID,实现“单条消息配置对应反垃圾”,若不填则使用原来的反垃圾配置
antispam String 对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测的内容(antispamCustom)。
true或false, 默认false。
只对消息类型为:100 自定义消息类型 的消息生效。
notifyTargetTags String 可选,标签表达式,最长128个字符
antispamCustom String 在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式,长度限制同body字段,不能超过5000字符,要求antispamCustom格式如下:

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

字段说明:
1. type: 1:文本,2:图片。
2. data: 文本内容or图片地址。
env String 所属环境,根据env可以配置不同的抄送地址

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&fromAccid=zhangsan&msgType=0&attach=This+is+test+msg&msgId=c9e6c306-804f-4ec3-b8f0-573778829419' 'https://api.netease.im/nimserver/chatroom/sendMsg.action'

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "desc":{
    "time": "1456396333115", 
    "fromAvator":"http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV84NDU4OF8xNDU1ODczMjA2NzUwX2QzNjkxMjI2LWY2NmQtNDQ3Ni0E2LTg4NGE4MDNmOGIwMQ==",
    "msgid_client": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "fromClientType": "REST",
    "attach": "This+is+test+msg",
    "roomId": "36",
    "fromAccount": "zhangsan",
    "fromNick": "张三",
    "type": "0",
    "ext": "",
    "highPriorityFlag":1, //高优先级消息标记,不带此标记表示非高优先级
    "msgAbandonFlag":"1" //消息被丢弃标记,传abandonRatio参数时才会返回此标记,不返回此标记代表未被丢弃
  } 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


往聊天室内添加机器人

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

往聊天室内添加机器人,机器人过期时间为24小时。

参数说明

参数类型必须说明
roomid long 聊天室id
accids JSONArray 机器人账号accid列表,必须是有效账号,账号数量上限100个
roleExt String 机器人信息扩展字段,请使用json格式,长度4096字符
notifyExt String 机器人进入聊天室通知的扩展字段,请使用json格式,长度2048字符

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70&accids=["zhangsan","lisi"]' 'https://api.netease.im/nimserver/chatroom/addRobot.action'

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "failAccids": "[\"hzzhangsan\"]",
    "successAccids": "[\"hzlisi\"]",
    "oldAccids": "[\"hzwangwu\"]"
  },
  "code": 200
}

主要的返回码

200、403、414、416、417、419、431、500、13003

具体请参考code状态表


从聊天室内删除机器人

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

从聊天室内删除机器人

参数说明

参数类型必须说明
roomid long 聊天室id
accids JSONArray 机器人账号accid列表,必须是有效账号,账号数量上限100个

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70&accids=["zhangsan","lisi"]' 'https://api.netease.im/nimserver/chatroom/removeRobot.action'

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "failAccids": "[\"hzzhangsan\"]",
    "successAccids": "[\"hzlisi\"]"
  },
  "code": 200
}

主要的返回码

200、403、404、414、416、419、431、500

具体请参考code状态表


清空聊天室机器人

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

删除聊天室内全部机器人

参数说明

参数类型必须说明
roomid long 聊天室id
notify boolean 是否发送退出聊天室通知消息,默认为false

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=70&notify=false' 'https://api.netease.im/nimserver/chatroom/cleanRobot.action'

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、500

具体请参考code状态表


设置临时禁言状态

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

将聊天室内成员设置为临时禁言

参数说明

参数类型必须说明
roomid long 聊天室id
operator String 操作者accid,必须是管理员或创建者
target String 被禁言的目标账号accid
muteDuration long 0:解除禁言;>0设置禁言的秒数,不能超过2592000秒(30天)
needNotify String 操作完成后是否需要发广播,true或false,默认true
notifyExt String 通知广播事件中的扩展字段,长度限制2048字符

curl请求示例

curl -X POST -H "CheckSum: 66dc1ad0166a37037abcdfeb749bhh049c937777" -H "AppKey: acd7y640c85j8kf734219e1847aggggg" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=123&operator=zhangsan&target=lisi&muteDuration=300&notifyExt=这是扩展字段' "https://api.netease.im/nimserver/chatroom/temporaryMute.action"

返回说明

http 响应:json


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

主要的返回码

200、403、404、414、416、417、419、431、500、13002

具体请参考code状态表


将聊天室整体禁言

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

设置聊天室整体禁言状态(仅创建者和管理员能发言)

参数说明

参数类型必须说明
roomid long 聊天室id
operator String 操作者accid,必须是管理员或创建者
mute String true或false
needNotify String true或false,默认true
notifyExt String 通知扩展字段

curl请求示例

curl -X POST -H "CheckSum: 32dc17d0190f37037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=4235&operator=zhangsan&mute=true'  "https://api.netease.im/nimserver/chatroom/muteRoom.action"

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


查询聊天室统计指标TopN

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1、根据时间戳,按指定周期列出聊天室相关指标的TopN列表
2、当天的统计指标需要到第二天才能查询
3、仅支持查询最近30天的统计指标

参数说明

参数类型必须说明
topn int topn值,可选值 1~500,默认值100
timestamp long 需要查询的指标所在的时间坐标点,不提供则默认当前时间,单位秒/毫秒皆可
period String 统计周期,可选值包括 hour/day, 默认hour
orderby String 取排序值,可选值 active/enter/message,分别表示按日活排序,进入人次排序和消息数排序, 默认active

curl请求示例

curl -X POST -H "CheckSum: 32dc17d0190f37037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'timestamp=1471781873&period=hour&topn=3&orderby=enter'  "https://api.netease.im/nimserver/stats/chatroom/topn.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": [
    {
      "activeNums": 5955,       // 该聊天室内的活跃数
      "datetime": 1471712400,   // 统计时间点,单位秒,按天统计的是当天的0点整点;按小时统计的是指定小时的整点
      "enterNums": 18621,       // 进入人次数量
      "msgs": 2793,             // 聊天室内发生的消息数
      "period": "HOUR",         // 统计周期,HOUR表示按小时统计;DAY表示按天统计
      "roomId": 3571337         // 聊天室ID号
    },
    {
      "activeNums": 6047,
      "datetime": 1471708800,
      "enterNums": 15785,
      "msgs": 2706,
      "period": "HOUR",
      "roomId": 3573737
    },
    {
      "activeNums": 5498,
      "datetime": 1471708800,
      "enterNums": 14590,
      "msgs": 2258,
      "period": "HOUR",
      "roomId": 3513774
    }
  ]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页获取成员列表

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

分页获取成员列表

参数说明

参数类型必须说明
roomid long 聊天室id
type int 需要查询的成员类型,0:固定成员;1:非固定成员;2:仅返回在线的固定成员
endtime long 单位毫秒,按时间倒序最后一个成员的时间戳,0表示系统当前时间
limit long 返回条数,<=100

curl请求示例

curl -X POST -H "CheckSum: 32dc17d0190f37037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=4235&type=0&endtime=0&limit=20'   "https://api.netease.im/nimserver/chatroom/membersByPage.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "data": [
       {
          "roomid": 111,
          "accid": "abc",
          "nick": "abc",
          "avator": "http://nim.nos.netease.com/MTAxMTAwMg==/bmltYV8xNzg4NTA1NF8xNDU2Mjg0NDQ3MDcyX2E4NmYzNWI5LWRhYWEtNDRmNC05ZjU1LTJhMDUyMGE5MzQ4ZA==",
          "ext": "ext",
          "type": "MANAGER",
          "level": 2,
          "onlineStat": true,
          "enterTime": 1487145487971,
          "blacklisted": true,
          "muted": true,
          "tempMuted": true,
          "tempMuteTtl": 120,
          "isRobot": true,
          "robotExpirAt":120
       }
    ]
  },
  "code": 200
}

返回结果中字段说明

字段类型说明
roomid long 聊天室id
accid String 用户accid
nick String 聊天室内的昵称
avator String 聊天室内的头像
ext String 开发者扩展字段
type String 角色类型:
UNSET(未设置),
LIMITED(受限用户,黑名单或禁言),
COMMON(普通固定成员),
CREATOR(创建者),
MANAGER(管理员),
TEMPORARY(临时用户,非固定成员)
level int 成员级别(若未设置成员级别,则无此字段)
onlineStat Boolean 是否在线
enterTime long 进入聊天室的时间点
blacklisted Boolean 是否在黑名单中(若未被拉黑,则无此字段)
muted Boolean 是否被禁言(若未被禁言,则无此字段)
tempMuted Boolean 是否被临时禁言(若未被临时禁言,则无此字段)
tempMuteTtl long 临时禁言的解除时长,单位秒(若未被临时禁言,则无此字段)
isRobot Boolean 是否是聊天室机器人(若不是机器人,则无此字段)
robotExpirAt int 机器人失效的时长,单位秒(若不是机器人,则无此字段)

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


根据角色获取固定成员列表

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

根据角色获取固定成员列表信息

参数说明

参数类型必须说明
roomid long 聊天室id
roles String 设置需要获取的角色,格式示例:
{"creator": true,"manager": true,"blacklist": false,"mute": false}

字段说明:
1、creator:聊天室创建者
2、manager:聊天室管理员
3、blacklist:黑名单用户
4、mute:被禁言用户
说明:设置为false或不设置表示不获取相应的角色信息

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&roles=%7B%22creator%22%3A%20true%2C%20%22manager%22%3A%20true%2C%22blacklist%22%3A%20true%2C%22mute%22%3A%20true%7D' 'https://api.netease.im/nimserver/chatroom/queryMembersByRole.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "desc":
    {
        "data":
        [
            {
                "accid": "user01",
                "nick": "nick01",
                "ext": "",
                "level": 0,
                "avator": "avator01.png",
                "type": "CREATOR", //创建者
                "roomid": 72,
                "onlineStat": true
            },
            {
                "accid": "user02",
                "nick": "nick02",
                "ext": "",
                "level": 0,
                "avator": "avator02.png",
                "type": "MANAGER",  //管理员
                "roomid": 72,
                "onlineStat": false
            },
            {
                "accid": "user03",
                "nick": "nick03",
                "ext": "",
                "blacklisted": true, //黑名单
                "level": 0,
                "avator": null,
                "type": "LIMITED",
                "roomid": 72,
                "onlineStat": false
            },
            {
                "accid": "user04",
                "nick": "nick04",
                "ext": "",
                "level": 0,
                "avator": null,
                "type": "LIMITED",
                "muted": true,  //禁言
                "roomid": 72,
                "onlineStat": false
            }
        ]
    }
}

返回结果中字段说明

字段类型说明
roomid long 聊天室id
accid String 用户accid
nick String 聊天室内的昵称
avator String 聊天室内的头像
ext String 开发者扩展字段
type String 角色类型:
UNSET(未设置),
LIMITED(受限用户,黑名单或禁言),
COMMON(普通固定成员),
CREATOR(创建者),
MANAGER(管理员),
TEMPORARY(临时用户,非固定成员)
level int 成员级别(若未设置成员级别,则无此字段)
onlineStat Boolean 是否在线
enterTime long 进入聊天室的时间点
blacklisted Boolean 是否在黑名单中(若未被拉黑,则无此字段)
muted Boolean 是否被禁言(若未被禁言,则无此字段)
tempMuted Boolean 是否被临时禁言(若未被临时禁言,则无此字段)
tempMuteTtl long 临时禁言的解除时长,单位秒(若未被临时禁言,则无此字段)
isRobot Boolean 是否是聊天室机器人(若不是机器人,则无此字段)
robotExpirAt int 机器人失效的时长,单位秒(若不是机器人,则无此字段)

主要的返回码

200、403、404、414、416、500

具体请参考code状态表


批量获取在线成员信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

批量获取在线成员信息

参数说明

参数类型必须说明
roomid long 聊天室id
accids JSONArray \["abc","def"\], 账号列表,最多200条

curl请求示例

curl -X POST -H "CheckSum: 32dc17d0190f37037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=4235&accids=["abc","def"]' "https://api.netease.im/nimserver/chatroom/queryMembers.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "data": [
      {
        "roomid": 111,
        "accid": "abc",
        "nick": "cba",
        "type": "CREATOR", //COMMON:普通成员(固定成员);CREATOR:聊天室创建者;MANAGER:聊天室管理员;TEMPORARY:临时用户(非聊天室固定成员);ANONYMOUS:匿名用户(未注册账号);LIMITED:受限用户(黑名单+禁言)
        "onlineStat": true
      }
    ]
  },
  "code": 200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


变更聊天室内的角色信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

变更聊天室内的角色信息

参数说明

参数类型必须说明
roomid long 聊天室id
accid String 需要变更角色信息的accid
save boolean 变更的信息是否需要持久化,默认false,仅对聊天室固定成员生效
needNotify boolean 是否需要做通知
notifyExt String 通知的内容,长度限制2048
nick String 聊天室室内的角色信息:昵称,不超过64个字符
avator String 聊天室室内的角色信息:头像
ext String 聊天室室内的角色信息:开发者扩展字段
bid String 反垃圾业务ID,JSON字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: he516640c8e8a72734219eh847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&accid=hzyangfeng201403&save=true&needNotify=true&nick=myNick' "https://api.netease.im/nimserver/chatroom/updateMyRoomRole.action"

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


查询用户创建的开启状态聊天室列表

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

批量更新聊天室队列元素

参数说明

参数类型必须说明
creator String 聊天室创建者accid

curl请求示例

curl -X POST  -H 'appkey: fe416640c8e8a72734219e1847ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf287af9150ad608797f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'creator=xiaoming01' "https://api.netease.im/nimserver/chatroom/queryUserRoomIds.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "desc":{
    "roomids": [
        "1015",
        "2016",
        "2017",
        "5062",
        "23037398"
    ]
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


关闭指定聊天室进出通知

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

关闭指定聊天室进出通知

参数说明

参数类型必须说明
roomid long 聊天室ID
close boolean true/false, 是否关闭进出通知

curl请求示例

curl -X POST  -H 'appkey: fe416640c8e8a72734219e1847ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf287af9150ad608797f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'close=false&roomid=3001' "https://api.netease.im/nimserver/chatroom/updateInOutNotification.action"

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、500

具体请参考code状态表

标签禁言

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

标签禁言

参数说明

参数类型必须说明
roomid long聊天室ID
operator string操作者accid,必须是创建者或者管理员
targetTag string目标标签
needNotify booleantrue/false,是否发送禁言通知,默认true
notifyExt string禁言通知通知扩展字段
muteDuration int禁言时长,单位秒,最长30天,若等于0表示取消禁言
notifyTargetTags string禁言通知的目标标签表达式,若缺失则发送给设置了targetTag的人

curl请求示例

curl -X POST  -H 'appkey: fe416640c8e8a72734219e1847ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf287af9150ad608797f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'targetTag=abc&roomid=3001&operator=xxx&muteDuration=123' "https://api.netease.im/nimserver/chatroom/tagTemporaryMute.action"

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "desc": {
        "muteDuration": 100   //禁言时长,若取消禁言,则返回上次禁言的剩余禁言时长
    }
} 

主要的返回码

200、403、414、416、500

具体请参考code状态表

查询某个标签下的在线用户数

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查询某个标签下的在线人数,注意单个账号多端登录情况下,在线用户数算1

参数说明

参数类型必须说明
roomid long聊天室ID
tag string标签

curl请求示例

curl -X POST  -H 'appkey: fe416640c8e8a72734219e1847ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf287af9150ad608797f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'tag=abc&roomid=3001' "https://api.netease.im/nimserver/chatroom/tagMembersCount.action"

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "data": {
    "tag": "abc",
    "onlineUserCount":222
  },
  "code": 200
}

主要的返回码

200、403、414、416、500

具体请参考code状态表

根据标签查询在线成员列表

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

根据标签查询在线成员列表,注意多端登录情况下会返回多条记录

参数说明

参数类型必须说明
roomid long聊天室ID
tag string标签
endTime long起始时间,逆序查询,若传0则表示从当前时间往前查
limit int条数,最多100

curl请求示例

curl -X POST  -H 'appkey: fe416640c8e8a72734219e1847ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf287af9150ad608797f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'tag=abc&roomid=3001&endTime=0&limit=100' "https://api.netease.im/nimserver/chatroom/tagMembersQuery.action"

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
    "data": [
      {
        "roomid": 111,
        "accid": "abc",
        "nick": "zlw",
        "avator": "http://nim.nos.netease.com/MTAxMTAwMg==xxx==",
        "ext": "ext",
        "type": "MANAGER",
        "level": 2,
        "onlineStat": true,
        "enterTime": "1487145487971",
        "blacklisted": true,
        "muted": true,
        "tempMuted": true,
        "tempMuteTtl": 120,
        "isRobot": true,
        "robotExpirAt": 120,
        "tags": "aaa",
        "notifyTargetTags": "{\"tag\": \"abc\"} and {\"tag\": \"def\"}"
      }
    ]
  },
  "code": 200
}

主要的返回码

200、403、414、416、500

具体请参考code状态表

聊天室全服广播消息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1、聊天室全服广播消息,会广播给该应用下所有聊天室的所有成员
2、注意广播消息只能在线广播,不会存历史
3、聊天室全服广播消息1分钟最多发送10条
4、本功能需要开通,请联系商务

参数说明

参数类型必须说明
msgId String 客户端消息id,使用uuid等随机串,msgId相同的消息会被客户端去重
fromAccid String 消息发出者的账号accid
msgType int 消息类型:
0: 表示文本消息,
1: 表示图片,
2: 表示语音,
3: 表示视频,
4: 表示地理位置信息,
6: 表示文件,
10: 表示Tips消息,
100: 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
subType int 自定义消息子类型,大于0
resendFlag int 重发消息标记,0:非重发消息,1:重发消息,如重发消息会按照msgid检查去重逻辑
attach String 文本消息:填写消息文案;
其它类型消息,请参考 消息格式示例
长度限制4096字符
ext String 消息扩展字段,内容可自定义,请使用JSON格式,长度限制4096字符
highPriority Boolean 可选,true表示是高优先级消息,云信会优先保障投递这部分消息;false表示低优先级消息。默认false。
强烈建议应用恰当选择参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置,单个聊天室最多支持每秒10条的高优先级消息,超过的会转为普通消息,此外全服广播的高优先级消息不支持重发。
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾而是使用通用反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 可选,易盾反垃圾增强反作弊专属字段,限制json,长度限制1024字符(详见易盾反垃圾接口文档反垃圾防刷版专属字段
bid String 可选,反垃圾业务ID,实现“单条消息配置对应反垃圾”,若不填则使用原来的反垃圾配置
antispam String 对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测的内容(antispamCustom)。
true或false, 默认false。
只对消息类型为:100 自定义消息类型 的消息生效。
notifyTargetTags String 可选,标签表达式,最长128个字符
antispamCustom String 在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式,长度限制同body字段,不能超过5000字符,要求antispamCustom格式如下:

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

字段说明:
1. type: 1:文本,2:图片。
2. data: 文本内容or图片地址。
env String 所属环境,根据env可以配置不同的抄送地址

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'fromAccid=zhangsan&msgType=0&attach=This+is+test+msg&msgId=c9e6c306-804f-4ec3-b8f0-573778829419' 'https://api.netease.im/nimserver/chatroom/broadcast.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "desc":{
    "time": "1456396333115", 
    "fromAvator":"http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV84NDU4OF8xNDU1ODczMjA2NzUwX2QzNjkxMjI2LWY2NmQtNDQ3Ni0E2LTg4NGE4MDNmOGIwMQ==",
    "msgid_client": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "fromClientType": "REST",
    "attach": "This+is+test+msg",
    "roomId": "36",
    "fromAccount": "zhangsan",
    "fromNick": "张三",
    "type": "0",
    "ext": "",
    "highPriorityFlag":1 //高优先级消息标记,不带此标记表示非高优先级
  } 
}

主要的返回码

200、403、414、416、500

具体请参考code状态表

聊天室消息撤回

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

撤回聊天室内发送的消息,撤回后对应消息的云端历史记录也将一并删除,需要云信IM SDK升级到8.7.0及以上版本。

参数说明

参数类型必须说明
roomid long 聊天室id
msgTimetag long 被撤回消息的时间戳
fromAcc String 被撤回消息的消息发送者accid
msgId String 被撤回消息的消息id
operatorAcc String 消息撤回的操作者accid
notifyExt String 消息撤回的通知扩展字段,最长1024字符

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799&fromAcc=acc01&" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=123&msgId=c9e6c306573778829419&msgTimetag=1212121&operatorAcc=acc01&fromAcc=acc02' 'https://api.netease.im/nimserver/chatroom/recall.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、500

具体请参考code状态表

发送聊天室定向消息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

往聊天室内某些人发消息
备注:聊天室定向消息不会存历史

参数说明

参数类型必须说明
roomid long 聊天室id
msgId String 客户端消息id,使用uuid等随机串,msgId相同的消息会被客户端去重
fromAccid String 消息发出者的账号accid
toAccids JSONArray 消息接收者accid列表,最大100个
msgType int 消息类型:
0: 表示文本消息,
1: 表示图片,
2: 表示语音,
3: 表示视频,
4: 表示地理位置信息,
6: 表示文件,
10: 表示Tips消息,
100: 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
subType int 自定义消息子类型,大于0
resendFlag int 重发消息标记,0:非重发消息,1:重发消息,如重发消息会按照msgid检查去重逻辑
attach String 文本消息:填写消息文案;
其它类型消息,请参考 消息格式示例
长度限制4096字符
ext String 消息扩展字段,内容可自定义,请使用JSON格式,长度限制4096字符
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾而是使用通用反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 可选,易盾反垃圾增强反作弊专属字段,限制json,长度限制1024字符(详见易盾反垃圾接口文档反垃圾防刷版专属字段
bid String 可选,反垃圾业务ID,实现“单条消息配置对应反垃圾”,若不填则使用原来的反垃圾配置
antispam String 对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测的内容(antispamCustom)。
true或false, 默认false。
只对消息类型为:100 自定义消息类型 的消息生效。
antispamCustom String 在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式,长度限制同body字段,不能超过5000字符,要求antispamCustom格式如下:

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

字段说明:
1. type: 1:文本,2:图片。
2. data: 文本内容or图片地址。
env String 所属环境,根据env可以配置不同的抄送地址

curl请求示例

curl -X POST -H "CheckSum: 51eb13ea5ee3a2c00e8388e48e61c65c7866c366" -H "AppKey: f541664055e557244421661866ad7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&fromAccid=zhangsan&msgType=0&attach=This+is+test+msg&msgId=c9e6c306-804f-4ec3-b8f0-573778829419&toAccids=["acc1","acc2"]' 'https://api.netease.im/nimserver/chatroom/sendMsgToSomeone.action'

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "desc":{
    "time": "1456396333115", 
    "fromAvator":"http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV84NDU4OF8xNDU1ODczMjA2NzUwX2QzNjkxMjI2LWY2NmQtNDQ3Ni0E2LTg4NGE4MDNmOGIwMQ==",
    "msgid_client": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "fromClientType": "REST",
    "attach": "This+is+test+msg",
    "roomId": "36",
    "fromAccount": "zhangsan",
    "fromNick": "张三",
    "type": "0",
    "ext": ""
  } 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


此文档是否对你有帮助?
有帮助
我要吐槽
  • 创建聊天室
  • URL
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 查询聊天室信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 批量查询聊天室信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 更新聊天室信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 修改聊天室开/关闭状态
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 设置聊天室内用户角色
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 请求聊天室地址
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 发送聊天室消息
  • 接口调用限制
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 往聊天室内添加机器人
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 从聊天室内删除机器人
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 清空聊天室机器人
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 设置临时禁言状态
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 将聊天室整体禁言
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 查询聊天室统计指标TopN
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页获取成员列表
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 返回结果中字段说明
  • 主要的返回码
  • 根据角色获取固定成员列表
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 返回结果中字段说明
  • 主要的返回码
  • 批量获取在线成员信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 变更聊天室内的角色信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 查询用户创建的开启状态聊天室列表
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 关闭指定聊天室进出通知
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 标签禁言
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 查询某个标签下的在线用户数
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 根据标签查询在线成员列表
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 聊天室全服广播消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 聊天室消息撤回
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 发送聊天室定向消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码