调用该接口更新房间的基本信息。允许更新房间的名称。单个家下房间名称不允许重名。房间的名称规则:支持字母、数字、空格和汉字,长度最大支持20个字符(中文算一个字符)。
路径 | /living/home/room/update |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
homeId | String | 是 | 50f5op1556f65de314b983fd5bca4f2f2810**** | 家的ID,生活物联网平台赋予家的唯一标识符。 |
roomId | String | 是 | 50f5op1556f65de314b983fd5bca4f2f2810**** | 房间的ID,生活物联网平台赋予房间的唯一标识符。 |
name | String | 否 | switch 游戏室 | 房间的名称。长度为1-40个字符,可以包含大小写英文字母、汉字、数字和空格。 |
backgroudImage | String | 否 | https://xxx/xxx.png | 房间的背景图标标识。比如图标的URL地址。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误信息。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"homeId": "50f5op1556f65de314b983fd5bca4f2f2810****",
"roomId": "50f5op1556f65de314b983fd5bca4f2f2810****",
"name": "switch 游戏室",
"backgroudImage": "https://xxx/xxx.png"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止"
}