PUT /wakeup
Update a wakeup call.
| Authentication | Required |
| URI Path | /rest/wakeup/<id> |
| Version | 6.1.0 |
Method Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | yes | string | ID number. |
Put Parameters
| Parameter | Type | Description |
|---|---|---|
| result | int | Result to set. -1 = Unknown, typically has not been attempted yet. 0 = Wakeup call performed successfully. 1 = Call answered and finished. 2 = Call answered; guest opted to snooze the call. 3 = Call not answered: No answer (RNA). 4 = Call not answered: Busy. 5 = Call not answered: Covered to voice mail. 6 = Call failed: No ring or no dialtone on the line. 7 = Call failed: Invalid number (operator intercept or fax tone). 8 = Call canceled. 9 = All active calls purged and log entries marked as archived. 10 = Scheduling attempt failed. 11 = Call halted due to exceeding the max number of call attempts allowed. |
Resource Errors
| HTTP Code | Description |
|---|---|
| 200 | Success. |
| 401 | Not authorized. |
| 404 | Wakeup ID not found. |
| 405 | Method specified is not supported. |
Response Parameters
| Name | Type | Description |
|---|---|---|
| error | int | Error code. |
| description | string | Description of the error code. |
| id | string | Unique wakeup call id if created. |
Example
PUT /rest/wakeup/ca04723c-ba58-11e6-9198-902b34db254e result=3