1. Главная
  2. Документация MANGO OFFICE
  3. API и разработка
  4. API MANGO OFFICE
  5. API Виртуальной АТС MANGO OFFICE
  6. 3.7 API Конфигурация

3.7.2 Получить список групп

POST /vpbx/groups

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

№ Параметры Тип Обяза-тель-ный Описание
1 group_id Нет Если указано, то возвращается информаци о данной группе
2 operator_id Нет id сотрудника. Если указан, то возвращается только список групп, куда включен сотрудник. Иначе - возвращаются все группы. Получить значение operator_id можно запросом Запрос списка сотрудников, в ответе на который возвращается параметр general.user_id
3 operator_extension Нет Внутренний номер сотрудника. Если указан, то возвращается только список групп, куда включен сотрудник. Иначе - возвращаются все группы
4 show_users Нет Признак, выводить ли в ответет сотрудников в группах/группе. Если указан (0 - нет / 1 - да), то в ответе возвращается вместе со списком сотрудников. Иначе - только список групп

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

POST https://app.mango-office.ru/vpbx/groups

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

{
    "show_users": 1
}

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

№ Параметры с уровнем вложенности Параметры с уровнем вложенности Тип Обяза-тель-ный Описание
№ 1 2 Тип Обяза-тель-ный Описание
1 result Код результата
2 groups
2.1 id ID группы
2.2 name Имя группы
2.3 description Примечание к группе
2.4 extension Короткий номер группы
2.5 dial_alg_group Алгоритм распределения звонков в группе, также см. Работа с услугами Виртуальной АТС: ■ 0: ALG_SERIAL_PRIOR - последовательный обзвон; ■ 1: ALG_PARALLEL_PRIOR - параллельный по приоритету (по квалификации); ■ 2: ALG_PARALLEL - одновременно всем свободным; ■ 3: ALG_RANDOM - судя из названия, в случайном порядке; ■ 5: ALG_MOST_IDLE - равномерный (наиболее свободному)
2.6 dial_alg_users Алгоритм дозвона до сотрудников в группе, также см. Работа с услугами Виртуальной АТС: ■ 1: ALG_M_ALL - на все контакты сотрудника одновременно; ■ 2: ALG_M_MAIN - на основные номера сотрудников; ■ 3: ALG_M_SIP - только на SIP-учетные записи сотрудника; ■ 4: ALG_M_LINE - на все контакты сотрудника по-очереди; ■ 5: ALG_M_CARD - как настроено в карточке сотрудника;
2.7 auto_redirect Статус опции "Переадресовывать звонки на "знакомого" сотрудника", также см. Работа с услугами Виртуальной АТС: 0 – Нет, 1 – Да.
2.8 auto_dial Статус опции "Автоматически перезванивать по пропущенным звонкам", также см. Работа с услугами Виртуальной АТС: ■ id кампании ИО, это же значение приходит в events/call в поле campaign_id
2.9 line_id id исходящей линии для автоперезвона, можно получить запросом Получение списка номеров ВАТС
2.10 use_dynamic_ivr Статус опции "До ответа оператора осталось... минут", также см. Работа с услугами Виртуальной АТС: 0 – Нет, 1 – Да.
2.11 use_dynamic_seq_num Статус опции "Ваш номер в очереди...", также см. Работа с услугами Виртуальной АТС: 0 – Нет, 1 – Да.
2.12 melody_id Идентификатор выбранной мелодии во время ожидания ответа. Можно получить запросом получение списка мелодий и звуковых сообщений. Если указано null - будет использована мелодия по умолчанию, которую можно настроить для всех групп в лк в разделе обработка звонков -> настройки ожидания ответа -> мелодия при удержании вызова в очереди
2.13 operators Массив сотрудников в группе: ■ id - id сотрудника; ■ name - имя сотрудника; ■ extension – внутренний номер сотрудника; ■ priority - приоритет в алгоритмах распределения звонков в группе использующих приоритет; ■ order - порядок в алгоритмах распределения звонков в группе использующих порядок.

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

{
    "result": 1000,
    "groups": {
        "id": 10051250,
        "name": "наименование 11",
        "description": "Примечание 11",
        "extension": "41",
        "dial_alg_group": 1,
        "dial_alg_users": 1,
        "auto_redirect": 1,
        "auto_dial": 18979,
        "line_id": 300029114,
        "use_dynamic_ivr": 1,
        "use_dynamic_seq_num": 1,
        "melody_id": null,
        "operators": [
            {
                "id": 300029116,
                "name": "Олег Николаев",
                "extension": "10",
                "priority": 1,
                "order": 1
            },
            {
                "id": 300039900,
                "name": "Олег Николаев 2",
                "extension": "15",
                "priority": 2,
                "order": 2
            }
        ]
    }
}
Предыдущая
3.7.1 Запрос списка сотрудников ВАТС
Следующая
3.7.3 Добавить группу