Получение списка SIP-пользователей

В этом разделе представлен API-метод для получения списка SIP-пользователей.

GET

/v1/apps/{appId}/calls/sip-users

Авторизация

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры

Параметр	Расположение	Тип	Описание
appId	Path	string	Уникальный идентификатор приложения (UUID).
status	Query	string	Статус SIP-пользователя. См. справочник status ниже.
perms	Query	number	Права SIP-пользователя в виде битовой маски. См. справочник perms ниже.

Справочник status

Значение	Описание
AVAILABLE	Доступен
AWAY	Отошёл
BUSY	Занят
OFFLINE	Не в сети

Справочник perms

Параметр perms использует битовую маску. Права можно комбинировать сложением значений:

Значение	Двоичный вид	Описание
0	0000	Нет прав
1	0001	Входящие звонки
2	0010	Исходящие звонки
3	0011	Входящие и исходящие звонки

Например, значение 3 соответствует комбинации прав INBOUND | OUTBOUND.

Пример запроса

curl -X GET \
  https://space.getloo.ru/api/v1/apps/{appId}/calls/sip-users?status=AVAILABLE&perms=3 \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json"

Пример ответа

[
  {
    "user_id": "019d6dbe-df10-7066-96a6-178e712e0f78",
    "priority": 10,
    "status": "OFFLINE",
    "perms": 1
  }
]

параметры ответа

Параметр	Тип	Описание
user_id	string	Уникальный идентификатор SIP-пользователя (UUID).
priority	number	Приоритет SIP-пользователя.
status	string	Статус SIP-пользователя. См. справочник status выше.
perms	number	Права SIP-пользователя в виде битовой маски. См. справочник perms выше.

Коды состояния

Код	Описание
200	Запрос успешно выполнен
401	Неавторизованный запрос
403	Доступ запрещён
404	Приложение не найдено
500	Внутренняя ошибка сервера