本文介绍如何调用服务端接口更新房间的名称和密码。

请求信息

请求 URI

HTTPPOST https://roomkit.yunxinapi.com/neroom/v4/rooms/{room_archive_id}

如果您的应用主要服务于海外用户，请将 roomkit.yunxinapi.com 域名设置修改为海外数据中心域名 roomkit-sg.yunxinapi.com。

请求头参数

请求 Header 的参数说明请参考 请求结构。

请求路径参数

参数名称	类型	是否必选	说明
room_archive_id	String	是	房间 ID。

请求体参数

参数名称	类型	是否必选	示例	说明
ext	string	否	custom	您自定义的扩展信息，最大长度为 2048 个字符。
room_name	string	是	Name***	房间名。最大长度为 64 个字符。
password	string	否	123456	房间密码，最大长度 64 个字符

请求体示例

JSON{
    "room_name":"Name***",
    "password":"123456",
    "ext":"custom"
}

响应信息

响应参数

参数名称	类型	示例	说明
code	int	0	状态码，0 表示成功，具体请参考下文 错误码。
msg	String	Success	业务结果描述，Success 表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
cost	String	48ms	处理该请求所消耗的时间，单位为毫秒。

响应示例

JSON{
    "code": 0,
    "msg": "Success",
    "ts": 1648038869677,
    "cost": "16ms",
    "request_id": "7c23f617319***515551b8296eed1",
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理。
400	Invalid parameter.	参数错误	检查接口传参。
1004	The room does not exist.	房间号不存在	更换 room_archive_id。