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

Материал из ПланФикс
Перейти к: навигация, поиск
(Новая страница: «1. Общие сведения об API API позволяет подключить к ПланФикс любую вашу собственную Облачну…»)
 
Строка 1: Строка 1:
−
1. Общие сведения об API
+
== Общие сведения об API ==
 
API  позволяет подключить к ПланФикс любую вашу собственную Облачную АТС.
 
API  позволяет подключить к ПланФикс любую вашу собственную Облачную АТС.
 +
 
Интеграция ПланФикс и Облачной АТС решает несколько бизнес-задач:
 
Интеграция ПланФикс и Облачной АТС решает несколько бизнес-задач:
 +
 
- получение  имени звонящего  по  номеру  телефона,  для  того, чтобы его можно  было отобразить на экране телефона или sip-клиента;
 
- получение  имени звонящего  по  номеру  телефона,  для  того, чтобы его можно  было отобразить на экране телефона или sip-клиента;
 +
 
- автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;
 
- автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;
 +
 
- отображение информации о входящем звонке непосредственно внутри ПланФикс (всплывающее окно при звонке)
 
- отображение информации о входящем звонке непосредственно внутри ПланФикс (всплывающее окно при звонке)
 +
 
- сохранение в ПланФиксе истории всех звонков и записей разговоров;
 
- сохранение в ПланФиксе истории всех звонков и записей разговоров;
 +
 
- совершение исходящих звонков сразу из интерфейса ПланФикса.  
 
- совершение исходящих звонков сразу из интерфейса ПланФикса.  
 +
 
Интеграция  должна  быть  двухсторонней.  Поэтому  часть  запросов ПланФикс посылает в сторону Облачной АТС на указанные точки входа, а часть запросов, наоборот, Облачная АТС посылает в сторону ПланФикса на единую точку входа.  
 
Интеграция  должна  быть  двухсторонней.  Поэтому  часть  запросов ПланФикс посылает в сторону Облачной АТС на указанные точки входа, а часть запросов, наоборот, Облачная АТС посылает в сторону ПланФикса на единую точку входа.  
 +
 
Взаимодействие производится по протоколу HTTPS. Авторизация осуществляется по адресу ПланФикса или Облачной АТС соответственно и авторизационному ключу, полученному в процессе настройки интеграции.
 
Взаимодействие производится по протоколу HTTPS. Авторизация осуществляется по адресу ПланФикса или Облачной АТС соответственно и авторизационному ключу, полученному в процессе настройки интеграции.
  
−
2. Принцип авторизации и взаимодействия
+
 
 +
== Принцип авторизации и взаимодействия ==
 
HTTPS:
 
HTTPS:
−
- Запросы к ПланФикс принимаются только по протоколу HTTPS. Это обеспечивает достаточный уровень безопасности для общения систем через Интернет.
+
* Запросы к ПланФикс принимаются только по протоколу HTTPS. Это обеспечивает достаточный уровень безопасности для общения систем через Интернет.
−
- В целях безопасности ваших данных, пожалуйста, реализуйте  прием запросов на стороне АТС также с использованием HTTPS.
+
* В целях безопасности ваших данных, пожалуйста, реализуйте  прием запросов на стороне АТС также с использованием HTTPS.
 
Ключ (token):
 
Ключ (token):
−
- Дополнительно для авторизации каждого запроса к ПланФикс используется специальный ключ (token). Получить его можно в настройках интеграции.  
+
* Дополнительно для авторизации каждого запроса к ПланФикс используется специальный ключ (token). Получить его можно в настройках интеграции.  
−
- Пожалуйста,  реализуйте  прием  запросов  на  стороне АТС также  с  использованием ключа (token). Сгенерируйте  ключ и вставьте его в  соответствующее поле в  разделе настройки интеграции.
+
* Пожалуйста,  реализуйте  прием  запросов  на  стороне АТС также  с  использованием ключа (token). Сгенерируйте  ключ и вставьте его в  соответствующее поле в  разделе настройки интеграции.
−
- Ключи создаются один раз при настройке интеграции. При необходимости, вы можете сменить ключ на своей стороне и обновить его интерфейсе ПланФикса.
+
* Ключи создаются один раз при настройке интеграции. При необходимости, вы можете сменить ключ на своей стороне и обновить его интерфейсе ПланФикса.
 
Запросы от Облачной АТС к ПланФиксу:
 
Запросы от Облачной АТС к ПланФиксу:
−
- Запросы  необходимо  отправлять на указанный в настройках интеграции адрес для приема уведомлений.  
+
* Запросы  необходимо  отправлять на указанный в настройках интеграции адрес для приема уведомлений.  
−
- В  теле  запроса  в  специальном  поле  «token»  необходимо всегда  передавать специальный ключ.  
+
* В  теле  запроса  в  специальном  поле  «token»  необходимо всегда  передавать специальный ключ.  
 
Запросы от ПланФикса к Облачной АТС:
 
Запросы от ПланФикса к Облачной АТС:
−
- ПланФикс будет отправлять все запросы на указанный в настройках интеграции адрес.  
+
* ПланФикс будет отправлять все запросы на указанный в настройках интеграции адрес.  
−
- В  теле  сообщений ПланФикс будет  передавать  указанный  вами  в  веб-кабинете ключ (token).  
+
* В  теле  сообщений ПланФикс будет  передавать  указанный  вами  в  веб-кабинете ключ (token).  
 
Ответы
 
Ответы
−
- Все  ответы  на  запросы Облачной АТС ПланФикс присылает  в формате JSON в  теле  ответа.
+
* Все  ответы  на  запросы Облачной АТС ПланФикс присылает  в формате JSON в  теле  ответа.
−
- Все ответы на запросы ПланФикса Облачная АТС должна присылать в формате JSON в теле ответа.
+
* Все ответы на запросы ПланФикса Облачная АТС должна присылать в формате JSON в теле ответа.
−
3. Список команд API
+
 
 +
== Список команд API ==
 
От Облачной АТС к ПланФикс:
 
От Облачной АТС к ПланФикс:
−
- contact (POST)
+
* contact (POST)
−
- event (POST)
+
* event (POST)
−
- record (POST)
+
* record (POST)
 
От ПланФикса к Облачной АТС:
 
От ПланФикса к Облачной АТС:
−
- makeCall (POST)
+
* makeCall (POST)

Версия 12:36, 23 ноября 2016

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

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

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

- получение имени звонящего по номеру телефона, для того, чтобы его можно было отобразить на экране телефона или sip-клиента;

- автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;

- отображение информации о входящем звонке непосредственно внутри ПланФикс (всплывающее окно при звонке)

- сохранение в ПланФиксе истории всех звонков и записей разговоров;

- совершение исходящих звонков сразу из интерфейса ПланФикса.

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

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


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

HTTPS:

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

Ключ (token):

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

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

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

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

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

Ответы

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

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

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

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

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

  • makeCall (POST)
Источник — «http://planfix.ru/wiki/index.php?title=API_для_телефонии&oldid=10350»