Интеграция API Yeastar Cloud

Разработчики могут использовать API для разработки или подключения к серверам приложений, таким как колл-центр, отель, CRM (управление взаимоотношениями с клиентами), OA (автоматизация офиса), биллинговая система и т. д.

Категория: Разное (Miscellaneous) | Работает с: Телефонной системой Yeastar Cloud

Быстрый старт

Обзор интеграции АТС Yeastar по API

После подключения сервера приложений к Yeastar Cloud АТС устанавливается двусторонняя связь, обе стороны могут работать как сервер и клиент.

Подробное описание методов связи и процесса см. в разделах Обзор запросов API и События API.

Сервер приложений вызывает API для выполнения настроек на АТС:

Параметры запроса, состояние запроса, параметры настройки, управление вызовами и т. д.

АТС отправляет события на сервер приложений в режиме реального времени:

Изменение состояния системы, изменение состояния внутреннего номера, изменение состояния соединительной линии, изменение состояния вызова, отчет DTMF, отчет CDR и т. д.

Разработано: Yeastar

Требования (АТС)

Необходимо обновить прошивку АТС до версии, которая применима к API 2.0.0.
Версия АТС: версия прошивки 81.13.0.30 или более поздняя.

Требования (API)

По умолчанию функция API на АТС отключена. Перед использованием функции API необходимо включить API в настройках API на АТС и настроить соответствующие параметры.

Основные характеристики API Yeastar

С помощью API Yeastar Cloud АТС вы можете получить следующие функции:

Запрос параметров и статуса
Конфигурация параметров
Управление вызовами
Монитор событий

Методы аутентификации

Запросы и события API используют токен для аутентификации.

Запросы API: Сервер приложений должен получить API-токен от АТС, используя имя пользователя и пароль API (32-значная строчная строка, зашифрованная в MD5). Действительный токен должен добавляться каждый раз, когда сервер приложений вызывает интерфейс API.

Примечание: обновите API-токен, чтобы убедиться в его действительности.

HTTP-события: Сервер приложений должен получить API-токен от АТС, используя имя пользователя и пароль API (32-значная строчная строка, зашифрованная в MD5), и обеспечить действительность токена, чтобы АТС могла отправлять события на сервер приложений.

Примечание: обновите API-токен, чтобы убедиться в его действительности.

Истечение срока действия токена

Токен истекает через 30 минут.
Если серверу приложений требуется доступ к API АТС через 30 минут, вам необходимо обновить API-токен. Обновленный токен позволяет серверу приложений получить новый токен.