Hotel Check Out

Perform checkout for the hotel customers.

After checking out through this interface, PBX will do the following operations for the hotel extension:

  • Empty the extension's voicemail box.
  • Delete the extension's outbound route permissions.
  • Delete the extension's alarms.
  • Reset the extension's Caller ID name.

Request URL

{base_url}/{api_path}/hotel/checkout?token={token}

Request parameters

Parameter Required Type Description
number Yes String Extension number of the room to be checked out.

Valid values:

  • An extension number: Perform checkout for the room to which the specified extension is assigned.

    Example: "number":"1000"

  • Multiple extension numbers: Perform checkout for multiple rooms to which the specified extensions are assigned. Separate multiple extension numbers with ,.

    Example: "number":"1000,1001"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Perform checkout for the room with extension 4000.

POST /api/v2.0.0/hotel/checkout?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "4000"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}