Hotel Checkout
Perform checkout for hotel guests.
Note: 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 alarm.
- Reset the extension's Last Name, First Name, Email Address, Mobile Number, User Password, and Presence.
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.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
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"
}