Александр Мисюрин
12.08.2020
375245

Интеграция по API с Zadarma

В данной статье рассмотрим интеграцию с телефонией от Zadarma, на примере получения информации о звонке. Записывать информацию будем в базу, для ее дальнейшего использования. У системы Zadarma уже есть готовая библиотека классов для PHP на GIT. Скачиваем и распаковываем через git: git clone cd user-api-v1 composer install Полученные файлы (autoload.php, папки vendor/, lib/) копируем в […]

Интеграция по API с Zadarma

В данной статье рассмотрим интеграцию с телефонией от Zadarma, на примере получения информации о звонке. Записывать информацию будем в базу, для ее дальнейшего использования.

Для работы с API необходимо иметь учетную запись Zadarma, а также хотя бы 1 номер (можно бесплатный, для исходящей связи).

У системы Zadarma уже есть готовая библиотека классов для PHP на GIT.

Скачиваем и распаковываем через git:

git clone

cd user-api-v1

composer install

Установка библиотеки от Zadarma

Полученные файлы (autoload.php, папки vendor/, lib/) копируем в папку, в которой лежит исполняемый скрипт (можно не копировать, а подключать как есть, если нужно).

Для работы с API необходимо иметь работающую виртуальную АТС, а также запросить ключ API. Есть ограничение на включение АТС, если вы не пополняли счет более чем три месяца, также после пополнения может потребоваться перелогиниться в личном кабинете.

Получение API ключа и пароля: https://my.zadarma.com/api/

Включение виртуальной АТС: https://my.zadarma.com/mypbx/

Набросаем простой скрипт получения баланса от API:

#!/usr/bin/php -q
<?php
include_once 'vendor/autoload.php';
use Zadarma_API\Api;

define('USE_SANDBOX', true);
define('KEY', 'YOUR_KEY');
define('SECRET', 'YOUR_SECRET');

$api = new Api(KEY, SECRET, USE_SANDBOX);

$result = $api->getBalance();
echo print_r($result);
?>
Возврат баланса

Информацию о цене за звонок будем получать по его завершению, поскольку API отдает цену за минуту и Zadarma использует посекундную тарификацию, будем считать цену за звонок скриптом и вносить ее в базу данных.

API Zadarma имеет ограничение на количество запросов в момент времени: Общие ограничения — 100 запросов в минуту, на методы статистики — 10 запросов в минуту.

Следовательно, если у вас много более звонков в единицу времени, то имеет смысл запрашивать информацию о звонке уже из базы, с помощью скрипта в кроне, ограничив одновременное число запросов, либо ограничивать запросы самим скриптом.

Получим стоимость звонка по номеру телефона и длительности разговора, которые будем отправлять в скрипт:

$price = $result->price;
$price = $price / 60 * $argv[2];
echo $price;

где $argv[2] это время разговора в секундах. Его можно получать в диалплане из переменной ${CDR(billsec)}

Запрос стоимости будем совершать по завершении вызова, с помощью переписывания контекста macro-hangupcall (если у вас используется «чистый» Asterisk, можно переписать exten h в контексте исходящих вызовов.
[macro-hangupcall]
include => macro-hangupcall-custom
exten => s,1(start),GotoIf($["${USE_CONFIRMATION}"="" | "${RINGGROUP_INDEX}"="" | "${CHANNEL}"!="${UNIQCHAN}"]?theend)
exten => s,n(delrgi),Noop(Deleting: RG/${RINGGROUP_INDEX}/${CHANNEL} ${DB_DELETE(RG/${RINGGROUP_INDEX}/${CHANNEL})})
exten => s,n(theend),ExecIf($["${ONETOUCH_RECFILE}"!="" & "${CDR(recordingfile)}"=""]?Set(CDR(recordingfile)=${ONETOUCH_RECFILE}))
;Price change start
exten => s,n,ExecIf($["${OUTNUM}"!="" & ${CDR(billsec)} > 0]?Set(price=${SHELL(php -f /usr/src/test/index.php ${OUTNUM} ${CDR(billsec)})}))
exten => s,n,Set(CDR(userfield)=price: ${price})
;Price change end
exten => s,n,Hangup
exten => s,n,MacroExit()

Запрашиваем сумму за один звонок, Задарма не округляет стоимость, потому мы тоже не будем. Полученное значение вносим в userfield, для отображения в статистике.

Обязательно добавляем проверку того, что вызов исходящий, также при наличии на АТС нескольких провайдеров телефонии добавляем проверку на провайдера, чтобы не создавать лишние запросы в API.
Вызов и отображение его стоимости в CDR Reports

Остальную информацию о звонке можно получить в разрезе общей статистики через API Zadarma, с помощью метода statistics.

Подписаться
Уведомление о
guest
0 Комментарий
Inline Feedbacks
View all comments

Остались вопросы?

Я - Кондрашин Игорь, менеджер компании Voxlink. Хотите уточнить детали или готовы оставить заявку? Укажите номер телефона, я перезвоню в течение 3-х секунд.

VoIP оборудование

ближайшие курсы

ближайшие Вебинары

ONLINE

10 доводов в пользу Asterisk

Распространяется бесплатно.

Asterisk – программное обеспечение с открытым исходным кодом, распространяется по лицензии GPL. Следовательно, установив один раз Asterisk вам не придется дополнительно платить за новых абонентов, подключение новых транков, расширение функционала и прочие лицензии. Это приближает стоимость владения станцией к нулю.

Безопасен в использовании.

Любое программное обеспечение может стать объектом интереса злоумышленников, в том числе телефонная станция. Однако, сам Asterisk, а также операционная система, на которой он работает, дают множество инструментов защиты от любых атак. При грамотной настройке безопасности у злоумышленников нет никаких шансов попасть на станцию.

Надежен в эксплуатации.

Время работы серверов некоторых наших клиентов исчисляется годами. Это значит, что Asterisk работает несколько лет, ему не требуются никакие перезагрузки или принудительные отключения. А еще это говорит о том, что в районе отличная ситуация с электроэнергией, но это уже не заслуга Asterisk.

Гибкий в настройке.

Зачастую возможности Asterisk ограничивает только фантазия пользователя. Ни один конструктор шаблонов не сравнится с Asterisk по гибкости настройки. Это позволяет решать с помощью Asterisk любые бизнес задачи, даже те, в которых выбор в его пользу не кажется изначально очевидным.

Имеет огромный функционал.

Во многом именно Asterisk показал какой должна быть современная телефонная станция. За многие годы развития функциональность Asterisk расширилась, а все основные возможности по-прежнему доступны бесплатно сразу после установки.

Интегрируется с любыми системами.

То, что Asterisk не умеет сам, он позволяет реализовать за счет интеграции. Это могут быть интеграции с коммерческими телефонными станциями, CRM, ERP системами, биллингом, сервисами колл-трекинга, колл-бэка и модулями статистики и аналитики.

Позволяет телефонизировать офис за считанные часы.

В нашей практике были проекты, реализованные за один рабочий день. Это значит, что утром к нам обращался клиент, а уже через несколько часов он пользовался новой IP-АТС. Безусловно, такая скорость редкость, ведь АТС – инструмент зарабатывания денег для многих компаний и спешка во внедрении не уместна. Но в случае острой необходимости Asterisk готов к быстрому старту.

Отличная масштабируемость.

Очень утомительно постоянно возвращаться к одному и тому же вопросу. Такое часто бывает в случае некачественного исполнения работ или выбора заведомо неподходящего бизнес-решения. С Asterisk точно не будет такой проблемы! Телефонная станция, построенная на Asterisk может быть масштабируема до немыслимых размеров. Главное – правильно подобрать оборудование.

Повышает управляемость бизнеса.

Asterisk дает не просто набор полезных функций, он повышает управляемость организации, качества и комфортности управления, а также увеличивает прозрачность бизнеса для руководства. Достичь этого можно, например, за счет автоматизации отчетов, подключения бота в Telegram, санкционированного доступа к станции из любой точки мира.

Снижает расходы на связь.

Связь между внутренними абонентами IP-АТС бесплатна всегда, независимо от их географического расположения. Также к Asterisk можно подключить любых операторов телефонии, в том числе GSM сим-карты и настроить маршрутизацию вызовов по наиболее выгодному тарифу. Всё это позволяет экономить с первых минут пользования станцией.