Общая информация
Данный документ описывает программный интерфейс (API) виртуальной АТС «Теледисконт» (ВАТС).
API ВАТС может быть использован любой внешней системой CRM для автоматизации и облегчения работы операторов этой системы.
Для интеграции необходимо:
- Получить от Теледисконт уникальный ключ для вашей CRM (api_key).
- Для того чтобы получать автоматические уведомления(пункты 2 и 3) необходимо реализовать их обработку и сообщить в Теледисконт url-адреса обработчиков.
- Каждый клиент CRM должен быть зарегистрирован в ВАТС.
В Теледисконт необходимо сообщить названия этих клиентов.
В CRM должен хранится ключ каждого такого клиента (abonent_api_key).
Ключ можно скопировать из личного кабинета ВАТС в разделе «личные данные».
- Инициация исходящего звонка
- Получение уведомления о начале входящего звонка
- Получения уведомления при окончании звонка.
- Выгрузка статистики по звонкам
- Скачивание записанного разговора
Осуществление исходящих вызовов.
CRM-отправляет GET-запрос в облачную АТС, в ответ получает ID вызова, по которому впоследствии получит ссылку на запись звонка и его продолжительность. Формат запроса
https://my.telediscount.ru/api.php/telephony/outcome?num_a=xxx&num_b=yyy&abonent_api_key=FFFF
num_a - номер sip-учетки(внутренний номер), например SIP/0000000672
num_b - может быть как номер sip-учетки так и обычным номером телефонной сети в формате universal, например 74951234567
abonent_api_key – ключ абонента.
Уведомление о начале входящего вызова.
В момент вызова АТС отправляет GET-запрос в CRM систему.
Пример запроса:
http://my_super_crm.ru/script/telediscount/income.php?num_a=79039998877&num_m=79037778899&setup_time=98798798797897&api_call_id=c1f926a8f5727b77f9cbf39d8f35d061
num_a - номер с которого звонят
num_m - номер на который звонят
api_call_id - id звонка
setup_time - время начала вызова в UNIX формате
Уведомление об окончании звонка.
После окончания звонка АТС отправляет GET-запрос в CRM систему.
Пример запроса:
num_a - номер с которого звонят
num_m - номер на который звонят
num_b - номер или SIP-учетка на который пошла переадресация (если звонок не отвечен, num_b пустой)
api_call_id - id звонка
setup_time - время начала вызова в UNIX формате
connection_time - время соединения в секундах
waiting_time - время ожидания снятия трубки в секундах
Получение статистики по звонкам.
С сервера my.telediscount.ru можно получить данные по состоявшимся звонкам. Для получения статистики нужно отправить запрос вида
https://my.telediscount.ru/api.php/telephony/get_calls?api_key=345jf201kmn4bc6r72mn7cvu&api_call_id=xxx&num_a=yyy$num_m=qqq&num_b=zzz
api_call_id, num_a, num_m, num_b - параметры для определения статистки по звонкам, в запросе должен присутствовать хотя бы один параметр.
api_key – ключ вашей crm
Ответ придет в виде массива в json формате.
Получение записи разговора.
Для получения записи разговора нужно отправить запрос вида
api_key – ключ вашей crm
api_call_id – id звонка