API для телефонии — различия между версиями

Версия 13:04, 23 ноября 2016

Общие сведения об API

API позволяет подключить к ПланФикс любую вашу собственную Облачную АТС.

Интеграция ПланФикс и Облачной АТС решает несколько бизнес-задач:

• получение имени звонящего по номеру телефона, для того, чтобы его можно было отобразить на экране телефона или sip-клиента;
• автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;
• отображение информации о входящем звонке непосредственно внутри ПланФикс (всплывающее окно при звонке)
• сохранение в ПланФиксе истории всех звонков и записей разговоров;
• совершение исходящих звонков сразу из интерфейса ПланФикса.

Интеграция должна быть двухсторонней. Поэтому часть запросов ПланФикс посылает в сторону Облачной АТС на указанные точки входа, а часть запросов, наоборот, Облачная АТС посылает в сторону ПланФикса на единую точку входа.

Взаимодействие производится по протоколу HTTPS. Авторизация осуществляется по адресу ПланФикса или Облачной АТС соответственно и авторизационному ключу, полученному в процессе настройки интеграции.

Принцип авторизации и взаимодействия

HTTPS:

• Запросы к ПланФикс принимаются только по протоколу HTTPS. Это обеспечивает достаточный уровень безопасности для общения систем через Интернет.
• В целях безопасности ваших данных, пожалуйста, реализуйте прием запросов на стороне АТС также с использованием HTTPS.

Ключ (token):

• Дополнительно для авторизации каждого запроса к ПланФикс используется специальный ключ (token). Получить его можно в настройках интеграции.
• Пожалуйста, реализуйте прием запросов на стороне АТС также с использованием ключа (token). Сгенерируйте ключ и вставьте его в соответствующее поле в разделе настройки интеграции.
• Ключи создаются один раз при настройке интеграции. При необходимости, вы можете сменить ключ на своей стороне и обновить его интерфейсе ПланФикса.

Запросы от Облачной АТС к ПланФиксу:

• Запросы необходимо отправлять на указанный в настройках интеграции адрес для приема уведомлений.
• В теле запроса в специальном поле «token» необходимо всегда передавать специальный ключ.

Запросы от ПланФикса к Облачной АТС:

• ПланФикс будет отправлять все запросы на указанный в настройках интеграции адрес.
• В теле сообщений ПланФикс будет передавать указанный вами в веб-кабинете ключ (token).

Ответы

• Все ответы на запросы Облачной АТС ПланФикс присылает в формате JSON в теле ответа.
• Все ответы на запросы ПланФикса Облачная АТС должна присылать в формате JSON в теле ответа.

Список команд API

От ПланФикса к Облачной АТС:

• makeCall (POST)

От Облачной АТС к ПланФикс:

• contact (POST)
• event (POST)
• record (POST)

Команды API и примеры доступных сценариев

Команды от ПланФикса к Облачной АТС

makeCall

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

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

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

POST https://domain/planfix_api.php
cmd=makeCall
from=101
to=79101234567
token=202cb962ac59075b964b07152d234b70

Варианты ответа:

Команды от Облачной АТС к ПланФиксу

contact

Команда для получения информации о названии клиента и ответственном за него сотруднике по номеру его телефона.

Команда может используется для отображения на экране IP-телефона или в коммуникаторе на ПК сотрудника названия клиента. Также она может использоваться для перенаправления звонков от клиентов ответственному сотруднику, указанному в ПланФиксе

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

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

POST https://test.planfix.ru/tel/api
cmd=contact
phone=79101234567
planfix_token=303cb962ac59075b964b07152d234b70
callid=D12D0EB124F4E64AF4EA-1511

Варианты ответа:

event

record