Get Room Details

Last Updated on : 2023-06-21 07:12:58download

Get the details of a specified room based on the unique room ID.

API address

GET: /v1.0/osaas/rooms/{room_id}

Request parameter

Parameter nameTypeINRequiredDescription
roomIdStringuritrueThe unique ID of a specified room.

Return parameter

Parameter nameTypeDescription
roomIdStringThe unique ID of a specified room.
projectIdStringThe unique ID of a specified project.
roomNameStringThe name of a specified room.
roomNoStringThe number of a specified room.
telephoneStringThe mobile phone number.
descriptionStringThe description of a specified room.
gmtCreatelongThe 13-bit timestamp of the creation time.
gmtModifiedlongThe 13-bit timestamp of the modification time.
constructionStatusStringThe construction status. Valid values:
  • UNAUTHORIZED: unauthorized.
  • PENDING_CONSTRUCTION: pending for construction.
  • IN_CONSTRUCTION: under construction.
  • PENDING_ACCEPTANCE: pending for acceptance.
  • ACCEPTANCE_COMPLETE: acceptance completed.

    Request example

    GET: {url}/v1.0/osaas/rooms/1160823965053******

    Return example

        "result": {
            "room_id": "1160823965053******",
            "gmt_create": 1559707046000,
            "description": "Description of the room",
            "gmt_modified": 1559707046000,
            "room_name": "Test Room",
            "project_id": "11239994446505******",
            "construction_status": "UNAUTHORIZED",
            "room_no": "1001"
        "t": 1561381210234,
        "success": true

    Error code

    For more information, see error code.