調用該接口在指定家下創建一個房間。
路徑 | /living/home/room/create |
版本號 | 1.0.1 |
協議 | HTTPS |
請求方法 | POST |
是否需要用戶身份鑒權 | 是 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
homeId | String | 是 | 50f5op1556f65de314b983fd5bca4f2f2810**** | 家的 ID,生活物聯網平臺賦予家的唯一標識符。 |
name | String | 是 | xBox 游戲室 | 房間的名稱。長度為1-40個字符,可以包含大小寫英文字母、漢字、數字和空格。 |
backgroudImage | String | 否 | https://xxx/xxx.png | 房間的背景圖標標識。比如圖標的 URL 地址。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回碼。200表示成功。 |
|
message | String |
調用失敗時,返回的出錯信息。 |
|
localizedMsg | String |
本地語言的錯誤信息。 |
|
data | String |
房間的 ID,生活物聯網平臺賦予房間的唯一標識符。 |
示例
請求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"homeId": "50f5op1556f65de314b983fd5bca4f2f2810****",
"name": "xBox 游戲室",
"backgroudImage": "https://xxx/xxx.png"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "50f5op1556f65de314b983fd5bca4f2f28104512"
}
異常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 28804,
"message": "Existed name, please rename.",
"localizedMsg": "該名稱已經存在,請重新命名。",
"data": null
}