Оглавление
1.2 Требования совместимости и список поддерживаемых протоколов 8
1.4 Лимиты количества запросов к API 9
1.4.1 О неверных запросах к API. Ошибка 401 9
1.4.4 Что делать, если получили ошибку 503 и/или 5008? 10
2 Общие положения о взаимодействии систем 11
2.3 Работа с услугами Виртуальной АТС 13
2.4 Уникальный код вашей ВАТС, ключ для создания подписи и параметр "sign " 14
2.4.1 Уникальный код вашей ВАТС 14
2.4.2 Ключ создания подписи 14
2.4.5 Как узнать свой уникальный код ВАТС и ключ создания подписи? 15
2.5 Эмулятор API Виртуальной АТС 15
3 Описание методов API Виртуальной АТС MANGO OFFICE 16
3.1.3 Уведомление о результате отправки SMS 22
3.1.4 Уведомление о записи разговора 22
3.1.5 Уведомление о нажатиях DTMF клавиш 26
3.1.6 Уведомление о завершении вызова 27
3.1.7 Событие о завершении процесса распознавания тематик в разговорах 31
3.1.8 Событие о помещении записи разговора в облачное хранилище 32
3.2.1 Инициирование вызова от имени сотрудника 33
3.2.2 Инициирование вызова от имени группы 36
3.2.5 Включение записи разговора 41
3.2.6 Включение воспроизведения звукового файла 43
3.2.9 Соединение вызова в режиме OnHold и вызова в режиме Connected 55
3.2.10 Отмена перевода вызова 57
3.2.11 Постановка вызова на удержание 58
3.3 Методы работы с правилами переадресации 59
3.3.1 Получить список правил переадресации 59
3.3.2 Добавление нового правила переадресации 62
3.3.3 Изменение правила переадресации 64
3.3.4 Удаление правила переадресации 65
3.4.1 Запрос базовой статистики 66
3.4.2 Запрос расширенной статистики 71
3.5 API Записи разговоров, Речевая Аналитика 84
3.5.1 Получение записи разговора посредством POST запроса 85
3.5.2 Получение записи разговора посредством GET запроса без авторизации 86
3.5.3 Прямая ссылка на запись разговора с авторизацией через Личный кабинет 87
3.5.4 Получение тематик разговора (Speech2Text) 87
3.5.5 Получение списка расшифровок распознанных разговоров 89
3.5.6 Запрос информации о конспекте разговора 91
3.5.7 Запрос записей с расшифровками звонков 92
3.6.1 Запрос информации о посетителе сайта по динамическому номеру 93
3.6.2 Запрос истории навигации посетителя сайта по динамическому номеру 94
3.7.1 Запрос списка сотрудников ВАТС 96
3.7.2 Получить список групп 103
3.7.4 Редактировать группу 108
3.7.7 Получение списка номеров ВАТС 112
3.7.8 Получение списка мелодий и звуковых сообщений 113
3.7.9 Получение списка схем переадресаций 114
3.7.10 Установить схему на входящем номере 116
3.7.11 Получить список ролей 118
3.7.13 Редактировать сотрудника 121
3.7.15 Получить список индивидуальных правил автосекретаря для сотрудников 124
3.7.16 Изменить статус индивидуальных правил автосекретаря сотрудника 127
3.7.17 Получить sip учетные записи сотрудников 128
3.7.18 Получить настроенные домены 129
3.7.19 Создать sip- учетку 129
3.7.20 Редактировать sip -учетку 130
3.7.21 Удалить sip -учетку 131
3.7.22 Запрос номеров sip - trunk 'ов 132
3.8 API запрещенных направлений вызова 133
3.8.2 Ограничение входящих коммуникаций 133
3.8.3 Ограничение исходящих коммуникаций 137
3.9 API для работы с адресной книгой 146
3.9.4 Уведомление об операциях с адресной книгой 184
3.9.5 Получение набора пользовательских полей 189
3.10 API для работы с записями и метаданными, полученными из оффлайн-источников 191
3.10.1 Загрузка и распознавание речи в WAV -файле с привязкой к сотруднику 192
3.10.3 Событие о завершении распознавания речи в WAV -файле 196
3.10.4 Получение результата распознавания речи в WAV -файле 197
4 Описание методов API Контакт - центра MANGO OFFICE 200
4.2 Подключение и настройка API КЦ 201
4.3 Управление задачей на автоперезвон 203
4.3.1 Создание задачи на автоперезвон 203
4.3.2 Изменение задачи на автоперезвон 204
4.3.3 Получение задачи по ID 206
4.3.4 Получение списка задач 208
4.4 Управление статусами и сессиями пользователя 211
4.5.3 Получение сделки по ID 223
4.5.4 Получение списка сделок 224
4.5.5 Получение списка пользовательских полей 227
4.5.6 Получение списка документов сделки 230
4.5.7 Добавление документов к сделке 231
4.5.8 Получение списка воронок 232
4.6 Кампании исходящего обзвона 234
4.6.2 Получение списка задач и подзадач кампаний 234
4.6.3 Получение списка кампаний ИО 238
4.6.4 Получение информации о кампании 247
4.6.7 Добавление нескольких заданий в кампанию (асинхронный метод) 260
4.6.8 Добавление одного задания в кампанию (синхронный метод) 262
4.6.12 Получение информации для генерации отчёта исходящего обзвона 266
4.6.13 Получение информации о задаче кампании ИО 270
4.6.14 Запуск задания кампании ИО 272
4.6.17 Обновление задания кампании ИО 274
4.6.18 Получение информации о завершенных заданиях кампании ИО 275
4.6.19 Сброс попыток выполнения задания кампании ИО 279
4.6.20 Получение списка пользовательских полей 279
4.7 Данные Контакт-центра для звонка 280
4.7.1 Получение данных Контакт-центра для звонка 280
4.7.2 Получение списка тематик по продукту 284
4.7.3 Метод получения информации по скрипту(сценарию) КЦ 286
4.7.4 Вопрос для оценки качества работы операторов по обработке вызовов 287
4.8 Работа с обращениями в Контакт-центре 288
4.8.2 Создание закрытого обращения 289
4.10 API Мобильное приложение 304
4.10.4 Как найти channelId 313
Инициирование исходящего вызова 322
Перевод вызова с консультацией 327
Перевод вызова без консультации 330
Обработка нажатий DTMF-клавиш 333