Skip to content

Create Room

API Address:/v2/family/enduserapi/addFamilyRoom

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Create room

Request Parameters:

Parameter NameDescriptionRequest TypeRequiredData TypeSchema
fidHome IDquerytruestring
roomNameRoom namequerytruestring

Response Status:

Status CodeDescriptionSchema
200Room created successfullyReturn registration code response«AddRoomVO»
5041No permission
5618Please enter home ID
5620Failed to create room
5635Home mode not enabled
5640Please enter room name
5641Room name too long, please enter within 30 characters
5642Room name already exists, please re-enter
6049Insufficient permissions, current user is a regular member

Response Parameters:

Parameter NameDescriptionTypeSchema
codeResponse codeinteger(int32)integer(int32)
dataResponse dataAddRoomVOAddRoomVO
  fridRoom IDstring
  roomNameRoom namestring
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"frid": "",
		"roomName": ""
	},
	"extMsg": "",
	"msg": ""
}