Child pages
  • API телефонии

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Общая информация

Данный документ описывает программный интерфейс (API) виртуальной АТС «Теледисконт» (ВАТС).

API  ВАТС может API  ВАТС "ТЕЛЕДИСКОНТ" может быть использован любой внешней системой CRM для автоматизации и облегчения работы операторов этой системы.

Для интеграции необходимо:

  1. Получить от Теледисконт уникальный ключ для вашей CRM (api_key).
  2. Для того чтобы получать автоматические уведомления(пункты 2 и 3) необходимо реализовать их обработку и сообщить в Теледисконт url-адреса обработчиков.
  3. Каждый клиент CRM должен быть зарегистрирован в ВАТС.

В Теледисконт необходимо сообщить названия этих клиентов.

В CRM должен хранится ключ каждого такого клиента (abonent_api_key).

Ключ можно скопировать из личного кабинета ВАТС в разделе «личные данные».

...

совершения исходящих звонков и отображения о входящих.

Запросы к ВАТС от вашей системы и от ВАТС к вам идут по протоколу HTTP. 

Реализованы следующие api-запросы:
  1. Инициация исходящего звонка
  2. Получение уведомления о начале входящего звонка
  3. Получения уведомления при об окончании звонка.
  4. Выгрузка статистики по звонкам
  5. Скачивание записанного разговора

 Уведомления о входящих звонках приходит на URL которые вы можете самостоятельно прописать в личном кабинете, в разделе "интеграция с CRM"->"Вебхуки".

Image Added

Осуществление исходящих вызовов.

CRM-отправляет Для инициации исходящего звонка ваша система должна отправить GET-запрос в облачную АТС, в ответ на адрес https://my.telediscount.ru. В ответ она получает ID вызова, по которому впоследствии получит ссылку на запись звонка и его продолжительность. Формат запроса  

...

abonent_api_key – ключ абонента .из личного кабинета

 

Уведомление о начале входящего вызова.

В момент вызова АТС отправляет GET-запрос в CRM системувашу систему по тому URL который вы прописали в разделе "Вебхуки".
Пример запроса:

http://my_super_crm.ru/script/telediscount/income.php?num_a=79039998877&num_m=79037778899&setup_time=98798798797897&api_call_id=c1f926a8f5727b77f9cbf39d8f35d061

...

После окончания звонка АТС отправляет GET-запрос в CRM системув вашу систему по тому URL который вы прописали в разделе "Вебхуки".

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

http://my_super_crm.ru/script/telediscount/call_finished.php?num_a=79039998877&num_m=79037778899&num_b=SIP/0000000672&setup_time=98798798797897&connection_time=12&waiting_time=5&api_call_id=c1f926a8f5727b77f9cbf39d8f35d061

num_a - номер с которого звонят

code_name_num_a - Название направления или оператора с которого был сделан звонок

num_m - номер на который звонят

num_b - номер или SIP-учетка на который пошла переадресация (если звонок не отвечен, num_b пустой)

code_name_num_b - Название направления или оператора на который был сделан звонок

api_call_id - id звонка

setup_time - время начала вызова в UNIX формате

...

waiting_time - время ожидания снятия трубки в секундах

price - цена звонка


Получение статистики по звонкам.

...

https://my.telediscount.ru/api.php/telephony/get_calls?abonent_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 - параметры для определения статистки по звонкам, в запросе должен присутствовать хотя бы один параметр.

abonent_api_key – ключ вашей crmинтеграции с CRM из вашего личного кабинета

Ответ придет в виде массива в json формате. Список полей

              "abonent_id"=> уникальный номер абонента
              "setup_time"=>время начала соединения в формате UNIX TIMESTAMP
              "service_name"=> сервис от которого пришел звонок, возможные значения - ivr (входящий), sip_outcome (исходящий на внешний номер), sip_internal (исходящий на внутренний номер)
              "num_a"=> номер с которго был звонок
              "code_name_num_a"=> Название направления или оператора с которого был сделан звонок
              "num_m"=>=> номер на который пришел звонок
              "num_b" номер на который был переадресован звонок
              "code_name_num_b"=> Название направления или оператора на который был сделан звонок
              "num_a_connection_time"=> время соединения "num_a" в секундах
              "num_b_connection_time"=> время соединения "num_b" в секундах
              "connection_time"=> время разговора "num_a" с "num_b" 
              "num_a_waiting_time"=>время ожидания "num_a" в секундах
              "num_b_waiting_time"=>время ожидания "num_b" в секундах
              "recorder_file"=>имя файла с записью разговоров
              "price"=>цена звонка
              "api_call_id"=>id Звонка

 

Получение записи разговора.

...

https://my.telediscount.ru/api.php/telephony/get_record?abonent_api_key=345jf201kmn4bc6r72mn7cvu&api_call_id=xxx

abonent_api_key – ключ вашей crmинтеграции с CRM из вашего личного кабинета

api_call_id – id звонка