Пользователи личного кабинета
Возможные значения type
Значение |
Описание |
all |
Все пользователи |
business |
Бизнес пользователи (пользователи с внутренним номером) |
simple |
Частные пользователи |
certain |
Конкретный пользователь |
Получение списка пользователей
Наименование метода в API: lk-user/list. Список передаваемых параметров:
Параметр |
Описание |
Пример |
type |
Тип пользователей |
all |
i_account |
id аккаунта пользователя (передается если type=certain) |
1234 |
В случае успеха возвращается массив со следующими параметрами:
Параметр |
Описание Пример |
|
id |
ID пользователя |
1234 |
email |
email пользователя |
user@mail.ru |
phone |
телефонный номер пользователя |
79261111111 |
customer_id |
id Кастомера |
1234 |
role |
Роль пользователя |
10 |
userInfo |
Массив с прочей информацией |
|
Добавление пользователя
Наименование метода в API: lk-user/add. Список передаваемых параметров:
Параметр |
Описание |
Пример |
firstname |
Имя |
Алексей |
lastname |
Фамилия |
Петров |
midinit |
Отчество |
Иванович |
city |
Город |
Москва |
email |
email пользователя |
|
note |
Должность |
|
role |
Роль |
10 |
ext |
Внутренний номер (Только для бизнес) |
|
phone1 |
Телефон пользователя |
79261111111 |
phones |
массив с дополнительными телефонами |
|
type_user |
Тип пользователя |
|
recipient |
Для sip-trunk
(1- переадресация на ip, 2 на sip) |
1 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
Пользоваатель создался |
-1 |
Не удалось создать номер |
Обновление пользователя
Наименование метода в API: lk-user/update. Список передаваемых параметров:
Параметр |
Описание |
Пример |
i_account |
id аккаунта пользователя |
1234 |
firstname |
Имя |
Алексей |
lastname |
Фамилия |
Петров |
midinit |
Отчество |
Иванович |
city |
Город |
Москва |
subscriber_email |
email пользователя |
|
note |
Должность |
|
role |
Роль |
10 |
ext |
Внутренний номер (Только для бизнес) |
|
phone1 |
Телефон пользователя |
79261111111 |
phones |
массив с дополнительными телефонами |
|
type_user |
Тип пользователя |
|
recipient |
Для sip-trunk
(1- переадресация на ip, 2 на sip) |
1 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
Пользователь создался |
-1 |
Не удалось создать пользователя |
Удаление пользователя
Наименование метода в API: lk-user/delete. Список передаваемых параметров:
Параметр |
Описание |
Пример |
i_account |
id аккаунта телефонии пользователя |
1234 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
Пользователь удалился |
-1 |
Не удалось удалить пользователя |
Добавление внутреннего номера пользователю
Наименование метода в API: lk-user/add-ext. Список передаваемых параметров:
Параметр |
Описание |
Пример |
ext |
Внутренний номер |
202 |
i_account |
id аккаунта пользователя |
1234 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
внутренний номер создался |
-1 |
Не удалось создать внутренний номер |
Обновление внутреннего номер пользователя
Наименование метода в API: lk-user/update-ext. Список передаваемых параметров:
Параметр |
Описание |
Пример |
i_c_ext |
id внутреннего номера |
2345 |
ext |
Внутренний номер |
202 |
i_account |
id аккаунта пользователя |
1234 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
внутренний номер обновился |
-1 |
Не удалось обновить внутренний номер |
Удаление внутреннего номера пользователя
Наименование метода в API: lk-user/delete-ext. Список передаваемых параметров:
Параметр |
Описание |
Пример |
i_account |
id аккаунта пользователя |
1234 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
внутренний номер удалился |
-1 |
Не удалось удалить внутренний номер |
Установка номера АОН
Наименование метода в API: lk-user/update-cli. Список передаваемых параметров:
Параметр |
Описание |
Пример |
i_account |
id аккаунта пользователя |
1234 |
number |
номер телефона |
74951082211 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение |
Описание |
1 |
АОН установился |
-1 |
Не удалось установить АОН |