Операции с устройствами (device)
Содержание
Обзор
Производит управление зарегистрированными SIP-устройствами путем отправки соответствующих SIP-запросов.
Запросы
| HTTP verb | Endpoint | Описание |
|---|---|---|
|
|
Отправка приглашения
Выполняется администратором домена.
Инициация отправки команды на устройства, зарегистрированные под учетной записью.
Поддерживаемые команды:
-
sync - принудительная отправка на синхронизацию настроек autoprovision.
-
restart - отправка устройства на перезагрузку.
Для указанных операций используется расширение Broadworks - отправка SIP-NOTIFY с заголовком 'Event: check-sync'. Некоторые виды устройств не поддерживают синхронизацию без перезагрузки, тем самым эти команды неразличимы.
Запрос
Пример запроса
POST /rest/v1/uc/sipusers/abcdabcd-abcd-abcd-abcd-abcdabcdabcd/device HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"operation": "sync"
}Ответ
Пример успешного ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"result": "true"
}Примеры неудачного ответа
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'"
}