Device operations (device)
Table of Contents
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
Sending an invitation
Executed by the domain administrator.
Initiate sending a command to devices registered under the account.
Supported commands:
-
sync - forced sending for synchronization of settings autoprovision.
-
restart - sending the device to reboot.
Broadworks extension is used for the above operations - sending SIP-NOTIFY with header 'Event: check-sync'. Some types of devices do not support synchronization without rebooting, thus these commands are indistinguishable.
Request
Request example
POST /rest/v1/uc/sipusers/abcdabcd-abcd-abcd-abcd-abcdabcdabcd/device HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"operation": "sync"
}Response
Example of a successful response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"result": "true"
}Examples of a failed response
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
"error_code": 1506,
"error_message": "Access denied. Only administrator is allowed to perform request.",
"error_details": {
"msg_code":"10038"
}
}{
"error_code":1413,
"error_message":"Invalid params. Sipuser not found: 'abcdabcd-abcd-abcd-abcd-abcdabcdabcd'"
}