Hotel Checkout

Perform checkout for hotel guests.

Note: After checking out through this interface, PBX will do the following operations for the hotel extension:
  • Clear the following data: first name, email address, mobile number, job title, personal contacts, chat history, voicemail message, call recording, call log, video conference, and wake-up call.
  • Reset Last Name to extension number.
  • Reset extension presence to Available.
  • Reset extension outbound call permission to PROHIBIT outbound calls.

Request URL

POST {base_url}/{api_path}/hotel/checkout?access_token={access_token}

Request parameters

Parameter Required Type Description
ext_id Yes Integer The unique ID of an extension.
Note: You can query extension's ID using Search Specific Extensions.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

POST /openapi/v1.0/hotel/checkout?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "ext_id":39
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}