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/);
• для получения записей разговоров по окончании вызова использовать метод Получение файлов записей разговора из хранилища;
• создание и авторизация приложений.

Важно знать!

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