开发集成云信IM小程序聊天室流程

最新推荐文章于 2023-09-09 13:07:10 发布
最新推荐文章于 2023-09-09 13:07:10 发布
阅读量4.6k 收藏 3
点赞数 1
分类专栏： 微信小程序 文章标签： 小程序聊天室
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_35713752/article/details/84579526
版权

微信小程序开发交流qq群   173683895

   承接微信小程序开发。扫码加微信。

请求白名单的设置

地址：点击跳转

调用聊天室API

创建聊天室

请求说明

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

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

接口描述

创建聊天室

参数说明

 

参数类型必须说明
creatorString是聊天室属主的账号accid
nameString是聊天室名称，长度限制128个字符
announcementString否公告，长度限制4096个字符
broadcasturlString否直播地址，长度限制1024个字符
extString否扩展字段，最长4096字符
queuelevelint否队列管理权限：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的设置请参考接口概述

接口描述

查询聊天室信息

参数说明

参数类型必须说明
roomidlong是聊天室id
needOnlineUserCountString否是否需要返回在线人数，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的设置请参考接口概述

接口描述

查询聊天室信息

参数说明

参数类型必须说明
roomidsString是多个roomid，格式为：["6001","6002","6003"]（JSONArray对应的roomid，如果解析出错，会报414错误），限20个roomid
needOnlineUserCountString否是否需要返回在线人数，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的设置请参考接口概述

接口描述

更新聊天室信息

参数说明

参数类型必须说明
roomidlong是聊天室id
nameString否聊天室名称，长度限制128个字符
announcementString否公告，长度限制4096个字符
broadcasturlString否直播地址，长度限制1024个字符
extString否扩展字段，长度限制4096个字符
needNotifyString否true或false,是否需要发送更新通知事件，默认true
notifyExtString否通知事件扩展字段，长度限制2048
queuelevelint否队列管理权限：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的设置请参考接口概述

接口描述

修改聊天室开/关闭状态

参数说明

参数类型必须说明
roomidlong是聊天室id
operatorString是操作者账号，必须是创建者才可以操作
validString是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的设置请参考接口概述

接口描述

设置聊天室内用户角色

参数说明

参数类型必须说明
roomidlong是聊天室id
operatorString是操作者账号accid
targetString是被操作者账号accid
optint是操作：
1: 设置为管理员，operator必须是创建者 
2:设置普通等级用户，operator必须是创建者或管理员 
-1:设为黑名单用户，operator必须是创建者或管理员 
-2:设为禁言用户，operator必须是创建者或管理员
optvalueString是true或false，true:设置；false:取消设置
notifyExtString否通知扩展字段，长度限制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的设置请参考接口概述

接口描述

请求聊天室地址与令牌

参数说明

参数类型必须说明
roomidlong是聊天室id
accidString是进入聊天室的账号
clienttypeint否1:weblink（客户端为web端时使用）; 2:commonlink（客户端为非web端时使用）;3:wechatlink(微信小程序使用), 默认1
clientipString否客户端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的设置请参考接口概述

接口描述

往聊天室内发消息

参数说明

参数类型必须说明
roomidlong是聊天室id
msgIdString是客户端消息id，使用uuid等随机串，msgId相同的消息会被客户端去重
fromAccidString是消息发出者的账号accid
msgTypeint是消息类型：
0: 表示文本消息， 
1: 表示图片， 
2: 表示语音， 
3: 表示视频， 
4: 表示地理位置信息，
6: 表示文件，
10: 表示Tips消息，
100: 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）
resendFlagint否重发消息标记，0：非重发消息，1：重发消息，如重发消息会按照msgid检查去重逻辑
attachString否消息内容，格式同消息格式示例中的body字段,长度限制4096字符
extString否消息扩展字段，内容可自定义，请使用JSON格式，长度限制4096字符
antispamString否对于对接了易盾反垃圾功能的应用，本消息是否需要指定经由易盾检测的内容（antispamCustom）。
true或false, 默认false。
只对消息类型为：100 自定义消息类型 的消息生效。
antispamCustomString否在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式，长度限制同body字段，不能超过5000字符，要求antispamCustom格式如下：

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

字段说明：
1. type: 1：文本，2：图片。
2. data: 文本内容or图片地址。
skipHistoryint否是否跳过存储云端历史，0：不跳过，即存历史消息；1：跳过，即不存云端历史；默认0
bidString否可选，反垃圾业务ID，实现“单条消息配置对应反垃圾”，若不填则使用原来的反垃圾配置
highPriorityBoolean否可选，true表示是高优先级消息，云信会优先保障投递这部分消息；false表示低优先级消息。默认false。
强烈建议应用恰当选择参数，以便在必要时，优先保障应用内的高优先级消息的投递。若全部设置为高优先级，则等于没有设置。
useYidunint否可选，单条消息是否使用易盾反垃圾，可选值为0。 
0：（在开通易盾的情况下）不使用易盾反垃圾而是使用通用反垃圾，包括自定义消息。

若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断
needHighPriorityMsgResendBoolean否可选，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小时。

参数说明

参数类型必须说明
roomidlong是聊天室id
accidsJSONArray是机器人账号accid列表，必须是有效账号，账号数量上限100个
roleExtString否机器人信息扩展字段，请使用json格式，长度4096字符
notifyExtString否机器人进入聊天室通知的扩展字段，请使用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的设置请参考接口概述

接口描述

从聊天室内删除机器人

参数说明

参数类型必须说明
roomidlong是聊天室id
accidsJSONArray是机器人账号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的设置请参考接口概述

接口描述

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

参数说明

参数类型必须说明
roomidlong是聊天室id
operatorString是操作者accid,必须是管理员或创建者
targetString是被禁言的目标账号accid
muteDurationlong是0:解除禁言;>0设置禁言的秒数，不能超过2592000秒(30天)
needNotifyString否操作完成后是否需要发广播，true或false，默认true
notifyExtString否通知广播事件中的扩展字段，长度限制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的设置请参考接口概述

接口描述

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

参数说明

参数类型必须说明
roomidlong是聊天室id
keyString是elementKey,新元素的UniqKey,长度限制128字符
valueString是elementValue,新元素内容，长度限制4096字符
operatorString否提交这个新元素的操作者accid，默认为该聊天室的创建者，若operator对应的帐号不存在，会返回404错误。
若指定的operator不在线，则添加元素成功后的通知事件中的操作者默认为聊天室的创建者；若指定的operator在线，则通知事件的操作者为operator。
transientString否这个新元素的提交者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的设置请参考接口概述

接口描述

从队列中取出元素

参数说明

参数类型必须说明
roomidlong是聊天室id
keyString否目前元素的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的设置请参考接口概述

接口描述

排序列出队列中所有元素

参数说明

参数类型必须说明
roomidlong是聊天室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的设置请参考接口概述

接口描述

删除清理整个队列

参数说明

参数类型必须说明
roomidlong是聊天室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的设置请参考接口概述

接口描述

初始化队列

参数说明

参数类型必须说明
roomidlong是聊天室id
sizeLimitlong是队列长度限制，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的设置请参考接口概述

接口描述

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

参数说明

参数类型必须说明
roomidlong是聊天室id
operatorString是操作者accid，必须是管理员或创建者
muteString是true或false
needNotifyString否true或false，默认true
notifyExtString否通知扩展字段

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

参数说明

参数类型必须说明
topnint否topn值，可选值 1~500，默认值100
timestamplong否需要查询的指标所在的时间坐标点，不提供则默认当前时间，单位秒/毫秒皆可
periodString否统计周期，可选值包括 hour/day, 默认hour
orderbyString否取排序值,可选值 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的设置请参考接口概述

接口描述

分页获取成员列表

参数说明

参数类型必须说明
roomidlong是聊天室id
typeint是需要查询的成员类型,0:固定成员;1:非固定成员;2:仅返回在线的固定成员
endtimelong是单位毫秒，按时间倒序最后一个成员的时间戳,0表示系统当前时间
limitlong是返回条数，<=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
}

返回结果中字段说明

字段类型说明
roomidlong聊天室id
accidString用户accid
nickString聊天室内的昵称
avatorString聊天室内的头像
extString开发者扩展字段
typeString角色类型：
UNSET（未设置），
LIMITED（受限用户，黑名单或禁言），
COMMON（普通固定成员），
CREATOR（创建者），
MANAGER（管理员），
TEMPORARY（临时用户,非固定成员）
levelint成员级别（若未设置成员级别，则无此字段）
onlineStatBoolean是否在线
enterTimelong进入聊天室的时间点
blacklistedBoolean是否在黑名单中（若未被拉黑，则无此字段）
mutedBoolean是否被禁言（若未被禁言，则无此字段）
tempMutedBoolean是否被临时禁言（若未被临时禁言，则无此字段）
tempMuteTtllong临时禁言的解除时长,单位秒（若未被临时禁言，则无此字段）
isRobotBoolean是否是聊天室机器人（若不是机器人，则无此字段）
robotExpirAtint机器人失效的时长，单位秒（若不是机器人，则无此字段）

主要的返回码

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的设置请参考接口概述

接口描述

批量获取在线成员信息

参数说明

参数类型必须说明
roomidlong是聊天室id
accidsJSONArray是["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的设置请参考接口概述

接口描述

变更聊天室内的角色信息

参数说明

参数类型必须说明
roomidlong是聊天室id
accidString是需要变更角色信息的accid
saveboolean否变更的信息是否需要持久化，默认false，仅对聊天室固定成员生效
needNotifyboolean否是否需要做通知
notifyExtString否通知的内容，长度限制2048
nickString否聊天室室内的角色信息：昵称
avatorString否聊天室室内的角色信息：头像
extString否聊天室室内的角色信息：开发者扩展字段

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的设置请参考接口概述

接口描述

批量更新聊天室队列元素

参数说明

参数类型必须说明
roomidlong是聊天室id
operatorString是操作者accid,必须是管理员或创建者
elementsString是更新的key-value对，最大200个，示例：{"k1":"v1","k2":"v2"}
needNotifyboolean否true或false,是否需要发送更新通知事件，默认true
notifyExtString否通知事件扩展字段，长度限制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的设置请参考接口概述

接口描述

批量更新聊天室队列元素

参数说明

参数类型必须说明
creatorString是聊天室创建者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状态表

a_靖
关注
专栏目录
uni-app 写了一个网易云微信小程序
m0_68271787的博客
06-28 76
优化内容 ①修复list.vue接口问题；②优化detail部分样式，增加网易云logo；③代码各个地方都有详细注释；④增加index.vue登录功能；⑤增加dateil.vue底部播放栏；防止丢失，github点个Follow 关注我、点个Star支持我 就行！3.5. 安装好后 components下会多出个文件。可以拿真实的网易云微信小程序做个对比。3.4. 选择要导入的项目。
网易云信-IM即时通讯 微信小程序端实现
weixin_44104659的博客
05-07 2658
小程序端的需求，使用网易云信的即时通讯作为咨询沟通的工具。 这里介绍怎么把云信小程序demo中 聊天部分剥离出来。 云信小程序demo地址 先看效果，点击咨询记录进入到和客服聊天页面 咨询页面： 第一步：引入必须文件 将云信demo中的这些文件拷贝到你的小程序项目： 这个文件夹将demo中这两个文件拷贝即可： 第二步：初始化IM 在保证文件都引入且没有路径之类的问题后，进行初始化IM操作，在...
加入云信聊天室
m0_63266890的博客
02-11 929
参考聊天室 - IM 即时通讯 (163.com)
网易云信IM即时通讯PHP接口开发
JunChow
04-09 1838
网易云信：https://www.163yun.com 注册地址：https://app.netease.im/regist 登录地址：https://app.netease.im/login 架构设计 架构设计 操作流程 注册账号登录后台 创建网易云IM应用，获取AppKey和AppSecret。 服务端接口封装 客户端接口开发 高级群开发 简单描述下需...
接入网易云信IM即时通讯的微信小程序聊天室
a_靖的博客
12-29 6692
微信小程序开发交流qq群 173683895 承接微信小程序开发。扫码加微信。 接入流程： 初次接触网易云通信IM服务，您可以通过以下产品介绍文档了解我们的产品功能、相关概念、业务限制： 产品简介 主要功能 帐号集成与登录 接口及业务限制 1. 创建帐号 如果您还没有网易云帐号，请访问注册：https://app.netease.im/regist 如果您已经有网易云帐...
网易云信直播聊天室：无上限人数&系统不卡顿，是不是鱼与熊掌不能兼得？
heua5555的博客
12-08 1700
1.直播聊天室的形式和应用场景 　　在一般人的理解中，直播聊天室应该就是直播画面旁边配一个聊天窗口，众多观看者在 　　里面发表自己的评论（如图1）。Oh, NO！这样的场景是不是太Low啦！随着互联网技术和消费者群体的转移，这种简单的聊天室根本就满足不了广大网民的需求。比如小明平时就爱网红视频直播，来了就点亮自己，视频弹幕自己想对网红说的话，高兴的时候要送礼，还要和粉丝积极互动。小军热
IM云信第三方回调服务器端拦截DEMO
qq_35956992的博客
09-07 782
@RequestMapping(value = "/interceptHandleMsg", method = {RequestMethod.POST, RequestMethod.GET}) public JSONObject interceptHandleMsg(HttpServletRequest request) { JSONObject result = new JSONObject(); result.put("errCode", 1); result.put("...
基于Vue3的个人博客聊天室IM设计源码
最新发布
04-16
本源码项目是基于Vue3的个人博客聊天室IM设计，包含63个文件，主要使用JavaScript、Vue、CSS和HTML编程语言。该项目旨在创建一个具有聊天室功能的个人博客，使用SpringBoot和Vue技术栈。系统提供了博客文章的发布、...
网易云信Im即时通信服务端
03-28
【网易云信Im即时通信服务端】是一款专为开发者设计的即时通讯服务，它提供了丰富的API接口和SDK，便于开发者快速构建聊天、群组管理等社交功能。在服务端实现中，开发者通常需要关注以下几个核心知识点： 1. **API...
Android集成网易云IM实现单聊和群聊
03-28
总的来说，集成网易云信IM并实现单聊和群聊功能，需要对Android开发有深入理解，同时也需要熟悉网易云信IM的API和工作流程。通过以上步骤，开发者可以为自己的Android应用构建出稳定、高效的即时通讯功能。
reactnativechatdemo网易云信IM示例
08-10
网易云信IM服务提供了丰富的功能，如单聊、群聊、消息推送、文件传输等。在React Native Chat Demo中，你将看到如何使用其SDK进行以下操作： 1. 用户注册与登录：通过调用网易云信的API，实现用户的注册和登录功能...
图片、文字、录音（mp3）、视频、位置（定位）
qq_36617310的博客
07-29 3084
[{ "from": "p_66710934266241832", "type": "text", "text": "Hello world！Hello 云信开发者。我是你在云信Demo上的第一个好友。如果还没添加其他好友进行消息收发测试，那就发给我试试吧！", "time": "1562168470369", "sendOrReceive": "receive", ...
shell jq 迭代处理json数组
可克技术
09-09 738
【代码】shell jq 迭代处理json数组。
手机端图片预览查看
adai19850204的博客
04-25 369
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta http-equiv=X-UA-Compatible content="IE=edge"> <meta name=viewport conten...
20130828可注册域名列表
热门推荐
落寞红尘
08-28 39万+
aabkx.com aapun.com abmrw.com abnks.com acphq.com acsgq.com actcL.com aderz.com adjni.com adojj.com adyjy.com afabd.com afcfx.com afrhi.com afubd.com ahscp.com aihtt.com aimfp.com ai
万维网之父Tim Berners-Lee 获得2016年度图灵奖
Just for fun的专栏
12-11 2359
作者：硅谷密探 链接：https://www.zhihu.com/question/58037961/answer/155413736 来源：知乎 著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。 这个拒绝成为比尔盖茨的“互联网之父”，今天拿下了计算机届的诺贝尔奖！ 也许你还依稀记得2012年伦敦奥运会开幕式上，那个坐在复古的NeXT电脑前，在自己发明的万维网
requests请求douban.com获得网页源代码
qq_44807908的博客
09-01 2220
7. 将响应内容保存到文件中：使用`open()`函数创建一个名为"mydouban.html"的文件，以写入模式打开（如果文件不存在则创建），并将响应内容写入到这个文件中。3. 使用`requests.get()`函数发送GET请求：这个函数发送了一个HTTP GET请求到指定的URL（在这里是豆瓣网站的首页），并返回一个响应对象。5. 响应对象存储在变量`resp`中：`resp`是一个包含响应内容和各种属性的对象，用于获取从服务器返回的数据。"：打印"over!"表示程序执行完毕。
微信小程序接入云信
Bue_Sky的博客
12-16 1555
微信小程序 Demo 介绍 环信准备了微信小程序 Demo，该 Demo 基于 Web IM SDK，并在其基础之上进行了修改。如果您想在您的微信小程序中添加即时通讯的功能，可以参考以下方式集成。 小程序运行效果 Demo源码下载 GitHub下载地址：https://github.com/easemob/webim-weixin-xcx.git 或者，执行如下命令： ...
网易云信小程序单人聊天
07-28
网易云信小程序支持单人聊天功能。通过使用网易云信IM SDK和IM UIKit，可以快速集成包含UI界面的即时通讯应用。在单人聊天中，可以发送文本消息、图片、语音、视频等多种类型的消息。同时，还支持消息的离线推送、已读回执、消息漫游等功能。可以通过调用相应的API来实现单人聊天功能，例如使用sendMsg方法发送消息。\[1\] #### 引用[.reference_title] - *1* *2* [网易云信IM即时通讯聊天源码SDK 并发高轻松万人并发稳定不丢消息 后端PHP 前端 安卓Java](https://blog.csdn.net/qq_31856653/article/details/127441013)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down28v1,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [网易云IM小程序聊天室集成。PHP版SDK API使用示例](https://blog.csdn.net/weixin_30135925/article/details/115514440)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down28v1,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

a_靖

对你有帮助吗？打赏鼓励一下？

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值