REST API виртуальной АТС «Телфин.Офис»

REST API виртуальной АТС позволяет работать с функциями, доступными на уровне пользователя АТС. Целевая аудитория: программисты/системные администраторы, реализующие графический интерфейс (front-end) и различные скрипты автоматизации. Описание возможностей REST API может быть полезным пользователям, желающим сделать большее, чем позволяет имеющийся графический интерфейс.

Библиотека реализована в соответствии с архитектурой REST, передача данных осуществляется через протокол HTTPS, авторизация производится по протоколу OAuth 2.0 (RFC 6749).

Полная документация REST API виртуальной АТС «Телфин.Офис».

Документация включает в себя:

• Перечисление основных ресурсов системы;
• Порядок авторизации для выполнения действий от имени конкретного пользователя;
• Описание имеющихся функций и их параметров;
• Примеры использования.

Рекомендуем начать с «Быстрого старта работы с API».

Протестировать все методы REST API вы можете в «Специальном интерфейсе».

Для разработчиков интеграций

Рекомендованные действия / Первые шаги интеграции:

• ознакомиться с общей информацией, которую важно знать и понимать, работая над интеграцией с Телфин.Офисом;
• для инициации вызовов использовать метод Инициация вызова (/callback/);
• для умной маршрутизации вызовов из ИВР-а(Входящей маршрутизации) использовать метод Call Interactive;
• для получения данных о вызовах в режиме он-лайн использовать метод События внутреннего номера (/extension/.../event/);
• для получения записей разговоров по окончании вызова использовать метод Получение файлов записей разговора из хранилища;
• создание и авторизация приложений.

Информация по тестированию API серверов

Основной адрес сервера: apiproxy.telphin.ru

Резервный адрес сервера: altapi.telphin.ru

Тестирование интернет канала до API-сервера выполняется обязательно с того же внешнего IP адреса с которого работает интеграция.

Тестирование выполняется следующей командой:

• Для пользователей с операционной системой Linux: mtr -p 443 -T -w домен_из_указанных_ниже
• Для пользователей с операционной системой Windows необходимо скачать утилиту winMTR

Утилиту winMTR обязательно необходимо запускать с правами администратора.

В поле Host необходимо указать домен, нажать кнопку Start и подождать ~1 минуту.

Домены, которые обязательно необходимо проверить:

• apiproxy.telphin.ru
• altapi.telphin.ru

Результат тестирования по каждому домену необходимо экспортировать в HTML файл с помощью кнопки Export HTML, отправить на почту support@telphin.ru с обязательным указанием в теле письма внешнего IP адреса с которого работает интеграция.

Важно знать!

• Hostname API сервера: apiproxy.telphin.ru;
  • Hostname API сервера: apiproxy.telphin.ru; Имеет SRV-запись с информацией о резервном адресе altapi.telphin.ru (?)

    Можно делать запрос на основной домен (apiproxy.telphin.ru) с таймаутом. А в случае таймаута на запрос от основного домена делать запрос на альтернативный домен (altapi.telphin.ru).

    Таким образом теперь, в случае возникновения проблем на сети передачи данных от вашего сервера интеграции до нашего сервера API, вы можете использовать резервный канал для API запросов к АТС Телфин. Данное изменение повысит отказоустойчивость вашей интеграции.

    Важно: в случае получения ответа от основного адреса (apiproxy.telphin.ru) дублировать запрос на резервный адрес (altapi.telphin.ru) не нужно!

    Немного деталей:

    dig altapi.telphin.ru
    altapi.telphin.ru.      302     IN      A       46.229.221.93
     dig apiproxy.telphin.ru naptr
    apiproxy.telphin.ru.    599     IN      NAPTR   10 100 "s" "https+srv" "" _https._tcp.apiproxy.telphin.ru.
     dig _https._tcp.apiproxy.telphin.ru. srv
    _https._tcp.apiproxy.telphin.ru. 541 IN SRV     10 50 443 apiproxy.telphin.ru.
    _https._tcp.apiproxy.telphin.ru. 541 IN SRV     20 50 443 altapi.telphin.ru.

• Hostname http-хранилища: storage.telphin.ru;
• Адрес создания приложения для API: apiproxy.telphin.ru/app/;
• Логин и пароль для создания приложений — это логин и пароль для доступа к интерфейсу виртуальной АТС «Телфин.Офис»;
• extension ID и client ID не имеют ничего общего с SIP ID внутренних номеров и вашим логином и запрашиваются либо определяются соответствующими методами API;
• Ошибки 4XX — это ошибки передаваемого запроса, указание на которые можно увидеть, изучив такие ошибки. Просьба внимательно относиться к ответам сервера API — это ускорит решение Ваших вопросов в случае их возникновения;
• Если на вашем оборудовании настроена фильтрация по ip-адресам, то необходимо разрешить:
  • 213.170.84.96/27
  • 46.229.221.80/28
  • 79.175.9.160/28
  • 81.29.132.240/29
• При обращении в техническую поддержку в целях получения более оперативного ответа на Ваш вопрос рекомендуется делать это только по адресу support@telphin.ru, при этом сразу указывать используемый метод, все передаваемые параметры запроса, а также ответ, полученный на Ваш запрос!