Обновление данных SIP-пользователя

В этом разделе представлен API-метод для обновления данных SIP-пользователя.

PUT

/v1/apps/{appId}/calls/{userId}/call-settings

Авторизация

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

Authorization: Bearer <ACCESS_TOKEN>

Параметры

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

Справочник priority

Целое число в диапазоне от 1 до 10.
1 — наивысший приоритет, а 10 — наинизший.

Справочник status

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

Справочник perms

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

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

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

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

curl -X PUT \
  https://space.getloo.ru/api/v1/apps/{appId}/calls/{userId}/call-settings \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "priority": 5,
    "status": "AVAILABLE",
    "perms": 3
  }'

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

[
  {
    "priority": 5,
    "status": "AVAILABLE",
    "perms": 3
  }
]

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

{
  "uid": "123abc...",
  "uuid": "019d6dbe-df10-7066-96a6-178e712e0f78",
  "priority": 1,
  "perms": 0,
  "status": "OFFLINE",
  "created_at": 1781194391,
  "updated_at": 1781194391,
  "blocked": false
}

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

Параметр	Тип	Описание
uid	string	Уникальный идентификатор пользователя для конкретного приложения.
uuid	string	Уникальный идентификатор SIP-пользователя (UUID).
priority	number	Приоритет SIP-пользователя. См. справочник priority выше.
status	string	Статус SIP-пользователя. См. справочник status выше.
perms	number	Права SIP-пользователя в виде битовой маски. См. справочник perms выше.
created_at	number	Время создания записи в формате UNIX timestamp.
updated_at	number	Время последнего обновления записи в формате UNIX timestamp.
blocked	boolean	Статус блокировки пользователя.

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

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