3.7.12 Создать сотрудника

POST /vpbx/member/create

Метод позволяет добавлять сотрудников в Виртуальную АТС.

Обратите внимание, чтобы добавить дополнительных сотрудников, необходимо разрешить работать с услугами для API коннектора. Набор настроек идентичен настрокам в Личном кабинете.

Параметры запроса:

№ Параметры с уровнем вложенности Параметры с уровнем вложенности Параметры с уровнем вложенности Тип Обяза-тель-ный Описание
№ 1 2 3 Тип Обяза-тель-ный Описание
1 name Да ФИО сотрудника
2 email Адрес электронной почты
3 mobile Мобильный телефон
4 department Отдел
5 position Должность
6 login Логин обязательное, если указан password. Передаются login и password вместе либо ни одно из этих полей;
7 password Пароль обязательное, если указан login. Передаются login и password вместе либо ни одно из этих полей
8 use_status Учитывать статус сотрудника в Контакт-центре при распределении вызовов на него
9 use_cc_numbers Принимать вызовы на номер(а) выбранные в Контакт-центре
10 access_role_id Да id роли сотрудника
11 extension Да Внутренний номер сотрудника
12 line_id Исходящий номер (значение, id линии, можно использовать все линии, кроме линий с region = "sip")
13 trunk_number_id integer id номера sip-trunk'a исходящего (у номера поле options должно быть 4 или 6) номера SIP-TRUNK
14 dial_alg Алгоритм дозвона, 0..2
15 numbers Настройки средств дозвона, порядок определяет порядок использования
15.1 number string Зависит от protocol: PSTN-номер, sip-номер, FMC-номер
15.2 protocol Протокол номера телефона, возможные значения: tel – PSTN номер, sip – sip-номер, fmc – FMC номер
15.3 wait_sec Время ожидания ответа, специальное значение 0 – действуют общие ограничение платформы или оператора связи
15.4 status Статус номера, возможные значения: on – активен, off – выключен
15.5 schedule Расписание, опциональное
from string Дата начала, "2019-05-23 12:50:25" (UTC)
until string Дата окончания, "2019-05-23 17:25:45" (UTC)
items Расписание по критериям
type string Варианты дней 'alldays', 'workingdays', 'Holidays', 'specificdate', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'
from string Время начала (по московскому времени), формат: "12:25"
until string Время окончания (по московскому времени), формат: "18:25"
specific_date string Дата, "2019-05-23 14:25:45" (UTC), если type = SpecificDate.

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

POST https://app.mango-office.ru/vpbx/member/create

vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =

{
    "name": "Name",
    "email": "name@mail.ru",
    "department": "Department",
    "position": "Position",
    "access_role_id": "10451",
    "use_status": "1",
    "use_cc_numbers": "1",
    "extension": "30052",
    "dial_alg": "2",
    "line_id": "300049196",
    "login": "Login",
    "password": "Password"
}

В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:

№ Параметры Тип Обяза-тель-ный Описание
1 result Да Код результата
2 user_id Нет id созданного сотрудника

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

{
    "result": 1000,
    "user_id": 1234567
}