更新聊天室信息
更新时间: 2024/07/17 17:57:35
网易云信 IM 服务端支持更新已创建的聊天室的信息,包括聊天室名称、公告、直播地址、扩展字段、事件通知扩展字段、聊天室队列管理权限、反垃圾配置等。
URL
httpPOST https://api.netease.im/nimserver/chatroom/update.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
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请求示例
curlcurl -X POST -H "CheckSum: 95a26060**cb7d949d6e91d6d167" -H "AppKey: f1234540c1**56847aaaaaa" -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'
返回示例
请求成功的返回示例如下:
json"Content-Type": "application/json; charset=utf-8"
{
"chatroom": {
"roomid": 66,
"valid": true,
"announcement": "这是聊天室",
"name": "mychatroom",
"broadcasturl": "xxxxxx",
"ext": "",
"creator": "zhangsan"
},
"code": 200
}
状态码
该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?