Состояния регистрации внутренних учетных записей (sipuser_states)

Обзор

Предоставляет информацию о состоянии регистрации - зарегистрировано ли устройство или нет. В качестве идентификатора сущности выступает идентификатор учетной записи sipuser.

Позволяет также подписаться на события об изменения (event: "modelevents.data_changed", classpath: "/rest/v1/uc/sipuser_states"). События поступают при регистрации первого контакта учетной записи, при отмене регистрации или таймауту регистрации последнего контакта или удалении всех контактов учетной записи. При очистке хранилища, при перезагрузке сервиса.

Поля объекта

Имя Описание

id

Идентификатор учетной записи sipuser

username

Username (он же основной логин) учетной записи sipuser

status

Статус регистрации: "online" или "offline"

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/uc/sipuser_states

Получение списка учетных записей с состояниями регистрации

GET

/rest/v1/uc/sipuser_states/<id>

Получение состояния регистрации учетной записи

DELETE

/rest/v1/uc/sipuser_states/<id>

Очистка списка регистраций учетной записи


Получение списка учетных записей с состояниями регистрации

Возвращает все учетные записи, и зарегистрированные и незарегистрированные.

Поддерживается фильтрация, сортировка.

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, username, status.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

Пример запроса
GET /rest/v1/uc/sipuser_states?filter=["==",["property","status"],"online"]&limit=2 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id":"57278625-5fa4-eb0c-fb53-f6fa26881f25",
    "status":"online",
    "username":"sip1"
  },
  {
    "id":"9e455549-017c-cb23-16b3-7cd30a921f58",
    "status":"online",
    "username":"sip2"
  }
]

Получение состояния регистрации учетной записи

Возвращает состояние регистрации одной конкретной учетной записи по идентификатору.

Пример запроса
GET /rest/v1/uc/sipuser_states/57278625-5fa4-eb0c-fb53-f6fa26881f25 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"id":"57278625-5fa4-eb0c-fb53-f6fa26881f25",
"status":"online",
"username":"sip1"
}

Очистка списка регистраций учетной записи

Автоматические регистрационные записи учетных записей "без регистрации" также будут удалены. При отсутствии регистрации позвонить на устройство невозможно, но звонок с устройства вполне может пройти.

В соответствующий период перерегистрации все устройства в ходе продления восстановят регистрацию, автоматические регистрации также восстановятся.

Запрос

Пример запроса
DELETE /rest/v1/uc/sipuser_states/abcdabcd-abcd-abcd-abcd-abcdabcdabcd HTTP/1.1

Ответ

Пример успешного ответа
HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8