聊天室

创建聊天室

请求说明

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

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
  },
  "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
        }
    ],
    "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:只有主播管理员才能操作变更

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&accidzhangsan&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状态表


发送聊天室消息

请求说明

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: 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
resendFlag int 重发消息标记,0:非重发消息,1:重发消息,如重发消息会按照msgid检查去重逻辑
attach String 消息内容,格式同消息格式示例中的body字段,长度限制4096字符
ext String 消息扩展字段,内容可自定义,请使用JSON格式,长度限制4096字符
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图片地址。
skipHistory int 是否跳过存储云端历史,0:不跳过,即存历史消息;1:跳过,即不存云端历史;默认0
bid String 可选,反垃圾业务ID,实现“单条消息配置对应反垃圾”,若不填则使用原来的反垃圾配置
highPriority Boolean 可选,true表示是高优先级消息,云信会优先保障投递这部分消息;false表示低优先级消息。默认false。
强烈建议应用恰当选择参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置。
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾而是使用通用反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
needHighPriorityMsgResend Boolean 可选,true表示会重发消息,false表示不会重发消息。默认true

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, //高优先级消息标记,不带此标记表示非高优先级
  } 
}

主要的返回码

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/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/queueOffer.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

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

接口描述

往聊天室有序队列中新加或更新元素

参数说明

参数类型必须说明
roomid long 聊天室id
key String elementKey,新元素的UniqKey,长度限制128字符
value String elementValue,新元素内容,长度限制4096字符
operator String 提交这个新元素的操作者accid,默认为该聊天室的创建者,若operator对应的帐号不存在,会返回404错误。
若指定的operator不在线,则添加元素成功后的通知事件中的操作者默认为聊天室的创建者;若指定的operator在线,则通知事件的操作者为operator。
transient String 这个新元素的提交者operator的所有聊天室连接在从该聊天室掉线或者离开该聊天室的时候,提交的元素是否需要删除。
true:需要删除;false:不需要删除。默认false。
当指定该参数为true时,若operator当前不在该聊天室内,则会返回403错误。

curl请求示例

curl -X POST -H "CheckSum: 35dc67d0890f67007abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=1111&value=66666'  "https://api.netease.im/nimserver/chatroom/queueOffer.action"

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


从队列中取出元素

请求说明

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

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

接口描述

从队列中取出元素

参数说明

参数类型必须说明
roomid long 聊天室id
key String 目前元素的elementKey,长度限制128字符,不填表示取出头上的第一个

curl请求示例

curl -X POST -H "CheckSum: 37dc19d0190007037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=333334444'   "https://api.netease.im/nimserver/chatroom/queuePoll.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": { 
    "value": "66666", 
    "key": "1111" 
  },
  "code": 200
}

主要的返回码

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

具体请参考code状态表


排序列出队列中所有元素

请求说明

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

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

接口描述

排序列出队列中所有元素

参数说明

参数类型必须说明
roomid long 聊天室id

curl请求示例

curl -X POST -H "CheckSum: 37dc87di0190037037900999b74kkbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=1111'    "https://api.netease.im/nimserver/chatroom/queueList.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "desc": { 
    "list": [ 
      { 
        "33333": "33333" 
      } 
    ] 
  },
  "code": 200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除清理整个队列

请求说明

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

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

接口描述

删除清理整个队列

参数说明

参数类型必须说明
roomid long 聊天室id

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=36&key=k2&value=v2'  "https://api.netease.im/nimserver/chatroom/queueDrop.action"

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


初始化队列

请求说明

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

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

接口描述

初始化队列

参数说明

参数类型必须说明
roomid long 聊天室id
sizeLimit long 队列长度限制,0~1000

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=38&sizeLimit=10'  "https://api.netease.im/nimserver/chatroom/queueInit.action"

返回说明

http 响应:json


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

主要的返回码

200、403、414、416、431、500

具体请参考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、当天的统计指标需要到第二天才能查询

参数说明

参数类型必须说明
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/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": 1, //0:普通成员(固定成员);1:聊天室创建者;2:聊天室管理员;3:临时用户(非聊天室固定成员);4:匿名用户(未注册账号);-1:受限用户(黑名单+禁言)
        "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 聊天室室内的角色信息:昵称
avator String 聊天室室内的角色信息:头像
ext String 聊天室室内的角色信息:开发者扩展字段

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/queueBatchUpdateElements.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

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

接口描述

批量更新聊天室队列元素

参数说明

参数类型必须说明
roomid long 聊天室id
operator String 操作者accid,必须是管理员或创建者
elements String 更新的key-value对,最大200个,示例:{"k1":"v1","k2":"v2"}
needNotify boolean true或false,是否需要发送更新通知事件,默认true
notifyExt String 通知事件扩展字段,长度限制2048

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 'roomid=18&operator=xiaoming01&elements=%7b%22k1%22%3a%22v1%22%2c%22k2%22%3a%22v2%22%7d' "https://api.netease.im/nimserver/chatroom/queueBatchUpdateElements.action"

返回说明

http 响应:json


"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "desc":{
        "noExistElementKey":[
            "k1"
        ]
    }
}

主要的返回码

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状态表