Автоматическая телефонная станция •

Автоматическая телефонная станция от компании Evolvex. Обладает большим функционалом и надежностью. Имеет модульную архитектуру, что позволяет оперативно добавлять необходимый функционал.

Вводная документация

Вводная документация

История версий

Введение

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

Версия 9.1.2 от 12.11.2025

Версия 9.1.1 от 07.11.2025

Версия 9.1.0 от 05.11.2025

Версия 9.0.1 от 28.10.2025

Версия 9.0.0 от 09.10.2025

Версия 8.8.4 от 14.09.2025

Версия 8.8.3 от 26.08.2025

Версия 8.8.2 от 26.08.2025

Версия 8.8.1 от 19.08.2025

Версия 8.8.0 от 15.08.2025

Версия 8.7.4 от 13.08.2025

Версия 8.7.3 от 08.08.2025

Версия 8.7.2 от 29.07.2025

Версия 8.7.1 от 22.07.2025

Версия 8.7.0 от 11.07.2025

Версия 8.6.2 от 11.07.2025

Версия 8.6.1 от 10.07.2025

Версия 8.6.0 от 10.07.2025

Версия 8.5.0 от 03.07.2025

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

# mysql
> use pbx
> select * from static_pjsip;
> delete from static_pjsip;

Версия 8.4.17 от 03.07.2025

Версия 8.4.16 от 10.03.2025

Версия 8.4.15 от 07.03.2025

Версия 8.4.14 от 01.03.2025

Версия 8.4.13 от 25.02.2025

Версия 8.4.12 от 21.02.2025

Версия 8.4.11 от 18.02.2025

Версия 8.4.10 от 24.12.2024

Версия 8.4.9 от 03.12.2024

Версия 8.4.8 от 30.10.2024

Версия 8.4.7 от 30.10.2024

Версия 8.4.6 от 01.09.2024

Версия 8.4.5 от 25.08.2024

Версия 8.4.4 от 22.08.2024

Версия 8.4.3 от 18.08.2024

Версия 8.4.2 от 05.08.2024

Версия 8.4.1 от 05.08.2024

Версия 8.4.0 от 05.08.2024

Версия 8.3.3 от 04.08.2024

Версия 8.3.2 от 02.08.2024

Версия 8.3.1 от 01.08.2024

Версия 8.3.0 от 01.08.2024

Версия 8.2.10 от 12.07.2024

Версия 8.2.9 от 20.05.2024

Версия 8.2.8 от 08.04.2024

Версия 8.2.7 от 02.04.2024

Версия 8.2.6 от 27.03.2024

Версия 8.2.5 от 26.03.2024

Версия 8.2.4 от 25.03.2024

Версия 8.2.3 от 25.03.2024

Версия 8.2.2 от 23.03.2024

Версия 8.2.1 от 23.03.2024

Версия 8.2.0 от 23.03.2024

Документация администратора

Документация администратора

Групповой вызов абонентов

1. Пример группового вызова абонентов

Set : DIALGROUP(group_100,add)=PJSIP/user-101-domain
Set : DIALGROUP(group_100,add)=PJSIP/user-102-domain
Set : DIALGROUP(group_100,add)=PJSIP/user-103-domain
Set : DIALGROUP(group_100,add)=PJSIP/user-104-domain
Set : DIALGROUP(group_100,add)=PJSIP/user-105-domain
Dial : ${DIALGROUP(group_100)},60,tT

Документация администратора

Добавление нового абонента

1. Настройка адреса записи

Канальный драйвер - Адрес записи.
Добавить.

Наименование - Наименование адреса записи, Пример user-100-domain.
Описание - Произвольное описание адреса записи.
Идентификатор - Идентификатор адреса записи, является уникальным. Пример: user-100-domain.
Контакт - Можно закрепить постоянный контакт за адресом записи.
Истечение срока действия по умолчанию - Через какое время требовать регистрацию абонентского устройства. Пример 600.
Почтовые ящики - 
Максимальное количество контактов - Максимальное количество контактов закрепленные за адресом записи.
Минимальный срок действия - Минимальный срок действия регистрации.
Удалить существующий - При повторной регистрации удаляет существующий контакт и заменяется новым.
Частота квалификации - Время проверки абонентского устройства.
Аутентификация квалификаций - Требуется ли аутентификация при квалификации.
Максимальный срок действия - Максимальный срок действия регистрации.
Исходящий прокси - Исходящий прокси.
Квалификация контакта только при ответе со статусом 2xx - Квалификация контактов происходит если только ответ от другой стороны приходит со статусом 2xx.
Поддержка Path - Включает поддержку Path для запросов регистрации.
Таймаут квалификации - Время ожидания ответа от абонентского устройства.
Расширение голосовой почты -
Удалить недоступные - Удалить контакты если при проверке они являются не доступными.
Группа - Группа в которую входит адрес записи.

2. Настройка аутентификации

Канальный драйвер - Аутентификация
Добавить

Наименование - Наименование аутентификации. Пример user-100-domain.
Описание - Произвольное описание аутентификации.
Идентификатор - Идентификатор аутентификации. Пример user-100-domain.
Тип аутентификации - Какой тип аутентификации используется.
Хэш md5 - Пароль в виде хэша md5.
Пароль - Пароль
Область - Область передаваемая в заголовках.
Имя пользователя - Имя пользователя авторизации. Пример user-100-domain.
Группа - Группа в которую входит аутентификация.

3. Настройка конечной точки.

Канальный драйвер - Конечная точка.
Добавить.

Наименование - Наименование конечная точки. Пример user-100-domain.
Описание - Произвольное описание конечная точки.
Идентификатор - Идентификатор конечная точки. Пример user-100-domain.
Транспорт - Используемый транспорт
Адрес записи - Используемый адрес записи
Аутентификация - Используемая аутентификация.
Маршрутизация - Используемая маршрутизация.
Запрещенные кодеки - Запрещенные кодеки.
Разрешенные кодеки - Разрешенные кодеки.
Прямое медиа - Дает возможность соединять абонентов в обход станции.
Режим DTMF - Режим DTMF.
Использование обратного порта - Для инициализации звонка используется обратный порт.
Поддержка ICE -
Музыка на удержании - Музыка на удержании для абонента.
Исходящая аутентификация - Исходящая аутентификация.
Перезаписать контакт - 
Симметричный RTP - 
Заголовок P-Asserted-Identity - 
Заголовок Remote-Party-ID - 
Определитель номера - Определитель номера. Пример: User <100>
Группа перехвата - Группа перехвата в которую входит конечная точка.
Перехват групп - Какие группы может перехватывать конечная точка.
Обнаружение факса -
Поддержка T.38 -
От домена - От какого домена отправлять запросы.
От пользователя - От какого пользователя отправлять запросы.
Таймаут RTP - Количество секунд после которых канал считается мертвым.
Контроль доступа - IP адреса с которых разрешена регистрация абонентов.
Индикаторы статуса - 
Поддержка WebRTC -
Группа - Группа в которую входит конечная точка.

Документация администратора

Запись звонков в многоканальном режиме

Начиная с версии 8.3.4

Для настройки записи в многоканальном режиме необходимо изменить глобальную переменную MIXMONITOR_COMMAND в маршрутизации. Данный параметр можно изменить только в базе данных в таблице static_extensions.

Значение переменной по умолчанию:
/var/lib/asterisk/scripts/wavtompeg/script.php --uniqueid="^{UNIQUEID}"

Значение переменной для записи в многоканальном режиме:
/var/lib/asterisk/scripts/wavtostereompeg/script.php --uniqueid="^{UNIQUEID}"

Для записи разговора используется приложение MixMonitor с параметрами:
MixMonitor: ${UNIQUEID}.wav,,${MIXMONITOR_COMMAND}

Настройки приложения для записи в многоканальном режиме
MixMonitor: ${UNIQUEID}.wav,r(${UNIQUEID}_receive.wav)t(${UNIQUEID}_transmit.wav),${MIXMONITOR_COMMAND}

Для изменения параметра во всей телефонной станции необходимо выполнить запрос:

Выбрать строки:
SELECT * FROM `realtime_extensions` WHERE `app` = "MixMonitor";

Для записи в одноканальном режиме необходимо заменить строки выполнив следующий запрос:
UPDATE `realtime_extensions` SET `appdata` = "${UNIQUEID}.wav,,${MIXMONITOR_COMMAND}" WHERE `app` = "MixMonitor";

Для записи в многоканальном режиме необходимо заменить строки выполнив следующий запрос:
UPDATE `realtime_extensions` SET `appdata` = "${UNIQUEID}.wav,r(${UNIQUEID}_receive.wav)t(${UNIQUEID}_transmit.wav),${MIXMONITOR_COMMAND}" WHERE `app` = "MixMonitor";

Документация администратора

Настройка автоматического обзвона

1. Предварительно необходимо настроить две маршрутизации. Для исходящих вызовов и для приветствия.

2. Загрузите файл голосового приветствия на сервер через модуль Медиа -> Аудиофайлы.

Назовите файл demo-domain.

3. Настройка маршрутизации.

Пример маршрутизации проигрывания файла:

Маршрутизация: ivr-autodial-domain.

Расширение: s.

NoOp
Answer
Playback : demo-domain
Hangup

Маршрутизация: outgoing-71234567890-domain.

Добавить расширение: h в исходящей маршрутизации. 

NoOp : Переменные при завершении
AGI : autodial/dialstatus.php,--dialstatus="${DIALSTATUS}",--contact_uuid="${contact_uuid}"
Hangup

4. После настройки маршрутизации можно переходить к настройкам автоматического обзвона.

Документация администратора

Настройка уведомлений Телеграм

1. Авторизуемся на телефонной станции.

2. Поиск идентификатора чата сотрудника.

Для поиска идентификатора чата, необходимо что бы сотрудник отписался боту телеграм.
В телефонной станции заходим в меню Отладка - Телеграм.
Если сотрудник отписался боту, то можно увидеть сообщение от данного сотрудника и его идентификатор чата.
Данные об идентификаторе чата отображаются в течении последних 24 часов с момента написания телеграм боту.

3. Настройка контактов получателей сообщений.

Заходим в меню Модули - Телеграм.
Открываем список контактов получателей через Контакты в необходимой строке.
Добавляем сотрудника в список контактов получателей:
Наименование - Любое наименование.
Описание - Описание контакта.
Включен: Да.
Идентификатор чата - идентификатор чата скопированный из отладки.

Документация администратора

Переадресация на сотовые номера сотрудников

Переадресация при входящих вызовах

Для настройка вызова на сотовый, необходимо использовать приложение Dial. Добавляется в место где необходимо произвести вызов на сотовый.

Dial: SIP/<Номер>@<Транк>,<Время>

Номер - Номер абонента
Транк - Транк через который совершается вызов
Время - Время дозвона абонента

Пример:

NoOp: Входящий вызов
...
...
...
Dial: SIP/user-110-office,15,tT
Dial: SIP/81234567890@peer-71234567890-office,60
Hangup

Переадресация при добавочных вызовах

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

Пример маршрутизации добавочного номера 110 с переадресацией на сотовый:

NoOp: Вызов на добавочный номер
Dial: SIP/user-110-office,15,t
Dial: SIP/81234567890@peer-71234567890-office,60
Hangup

Переадресация при внутренних вызовах

Для настройки переадресации при наборе внутреннего номера необходимо добавить в маршрутизацию внутренних номеров расширение 110.

Пример маршрутизации внутреннего номера 110 с переадресацией на сотовый:

NoOp: Вызов на внутренний номер
...
...
...
Dial: SIP/user-110-office,15,tT
Dial: SIP/81234567890@peer-71234567890-office,60
Hangup

Документация администратора

Перевод транспорта на статическую конфигурацию

1. Отключение realtime для конфигурации транспорта.

update `static_sorcery` set `commented` = 1 where `filename` = "sorcery.conf" and `category` = "res_pjsip" and `var_name` = "transport";

2. Добавление статической конфигурации.

insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","type","transport");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","protocol","udp");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","bind","0.0.0.0:5060");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","local_net","192.168.0.0/24");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","external_media_address","1.1.1.1");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","external_signaling_address","1.1.1.1");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","external_signaling_port","5060");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-udp","allow_reload","yes");

insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","type","transport");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","protocol","tcp");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","bind","0.0.0.0:5061");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","local_net","192.168.0.0/24");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","external_media_address","1.1.1.1");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","external_signaling_address","1.1.1.1");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","external_signaling_port","5061");
insert into static_pjsip (cat_metric,var_metric,commented,filename,category,var_name,var_val) values (0,0,0,"pjsip.conf","transport-tcp","allow_reload","yes");

Документация администратора

Приложение Record

Краткое содержание

Запись в файл.

Описание

Если имя файла содержит «%d», эти символы будут заменены числом, увеличивающимся на единицу при каждой записи файла. Пользователь может нажать «#», чтобы прекратить запись и перейти к следующему приоритету. Если пользователь повесит трубку во время записи, все данные будут потеряны и приложение закроется.

Синтаксис

Record(filename.format,[silence,[maxduration,[options]]])

Аргументы

Документация администратора

Ручное резервное копирование автоматической телефонной станции

Заходим через putty на сервер.

Для удобства можно использовать приложение Midnight Commander.

# mc

Создаем во временной папке \tmp, папку куда будем заливать резервные копии, и в будущем заархивируем (например backup).

# mkdir /tmp/backup

Копируем в нее, сохраняя всю структуру, папки:

etc/asterisk
opt/evolvex
var/lib/asterisk
var/www/html

Ниже производим действие в консоли:

# cd /tmp/backup
# mysqldump -p pbx > pbx.sql (вводим пароль от базы)

В папке backup должен появиться файл pbx.sql

Теперь всю папку backup заархивируем - находясь в папке tmp пропишем в консоли:

# cd /tmp
# tar czf archive.tar.gz /tmp/backup/

Полученный архив закачиваем на обменник, можно по ftp (логин@адрес_фтп_сервера) и вводим пароль пользователя.

Документация администратора

Ручное создание резервной копии АТС

1. Запускается под администратором.

mkdir /tmp/backup
mysqldump -upbx -ppassword pbx > /tmp/backup/pbx.sql
mkdir /tmp/backup/etc
mkdir /tmp/backup/var
mkdir /tmp/backup/var/lib
mkdir /tmp/backup/var/www
mkdir /tmp/backup/var/www/html
cp -R /etc/asterisk /tmp/backup/etc/asterisk
cp -R /var/lib/asterisk /tmp/backup/var/lib/asterisk
cp -R /var/www/html/pbx /tmp/backup/var/www/html/pbx
cp -R /opt /tmp/backup
tar cfvz /tmp/backup.tar.gz /tmp/backup

2. Скопировать резервную копию backup.tar.gz на другой носитель.

Документация администратора

Синтез речи

Введение

Для оперативного создания голосовых приветствий и интерактивных голосовых меню в версии 8.0.0 была реализована возможность синтезировать речь через Web интерфейс телефонной станции. Данный модуль использует синтез от компании Яндекс. Для подключения данного модуля необходимо получить Yandex IAM Token. Полученный токен необходимо ввести в Настройки - Яндекс - Yandex IAM Token.

Синтез речи

Для работы с синтезом речи необходимо открыть меню Медиа - Синтез речи. Откроется окно настроек синтеза речи.

image.png

Для выбора голоса и амплуа необходимо воспользоваться таблицей ниже.

Голос Пол Амплуа
alena (по умолчанию)
 Ж (по умолчанию) нейтральная — neutral
радостная — good
filipp M —
ermil M (по умолчанию) нейтральный — neutral
радостный — good
jane Ж (по умолчанию) нейтральная — neutral
радостная — good
раздраженная — evil
madirus M —
omazh Ж (по умолчанию) нейтральная — neutral
раздраженная — evil
zahar M (по умолчанию) нейтральный — neutral
радостный — good
dasha Ж (по умолчанию) нейтральная — neutral
радостная — good
дружелюбная — friendly
julia Ж (по умолчанию) нейтральная — neutral
строгая — strict
lera Ж (по умолчанию) нейтральная — neutral
дружелюбная — friendly
masha Ж (по умолчанию) радостная — good
строгая — strict
дружелюбная — friendly
marina Ж (по умолчанию) нейтральная — neutral
шепот — whisper
дружелюбная — friendly
alexander M (по умолчанию) нейтральный — neutral
радостный — good
kirill M (по умолчанию) нейтральный — neutral
строгий — strict
радостный — good
anton M (по умолчанию) нейтральный — neutral
радостный — good

В текстовом поле добавить необходимый текст для синтеза и нажать кнопку "Синтезировать". Программа автоматически подготовит необходимый формат файла для телефонной станции, дополнительное конвертирование не нужно. В правой части окна в таблице "Список синтеза речи" добавится строка синтезированной речи.

synth-index-list.jpg

Для скачивания аудиофайла нажмите кнопку "Скачать".

Таблица заполняется по мере синтеза речи и хранит файлы за все время синтеза. При необходимости старые записи можно удалить.

Дополнительно

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

Документация администратора

Скрипт отслеживания службы

1. Скрипт отслеживания службы

#!/bin/sh
# Название процесса
DAEMON="asterisk"
# "Убираем" grep из вывода
EXCLUDE="grep"
# Минимальное количество процессов
PROC_NUM="0"
# Команда для перезапуска
RESTART="/etc/init.d/asterisk restart"
# Утилита ps
PS="/bin/ps"
# Утилита grep
GREP="/usr/bin/grep"
if [ `$PS -ax | $GREP $DAEMON | $GREP -v $EXCLUDE | wc -l` -le "$PROC_NUM" ]
then
   $RESTART
fi

Документация администратора

Смена исходящей маршрутизации для внутреннего номера

1. Меню - Канальный драйвер - Конечная точка

image.png

2. Нажимаем редактировать напротив нужной конечной точки.

3. Меняем параметр маршрутизация.

image.png

Документация администратора

Сообщение после звукового сигнала

Подготовка аудиофайла

Необходимо подготовить файл звукового приветствия, например "Оставьте сообщение после звукового сигнала".
Через меню Медиа - Аудиофайлы загрузите файл с наименованием "message-office".
Файл должен быть в формате wav (rate 8000 Hz, sample rate 16 bits, mono).

Настройка маршрутизации

Необходимо подготовить новую маршрутизацию, например "message-office"
В созданной маршрутизации добавить расширение "s"

NoOp : Сообщение после звукового сигнала
Answer
Playback : message-office
Record : /tmp/${UNIQUEID}.wav,,300,k
Hangup

Настройка отправки на электронную почту

Добавить в маршрутизацию расширение "h"

NoOp : Отправка сообщения на электронную почту
AGI : email/attachment.php,--source="${CALLERID(number)}",--destination="Номер",--emails="mail@example.com",--attachment="/tmp/${UNIQUEID}.wav"
Hangup

Настройка перенаправления

В нужном месте маршрутизации добавьте приложение "GoTo"

NoOp : Входящий вызов
...
...
...
Goto : message-office,s,1
Hangup

Документация пользователя

Документация пользователя

Авторизация пользователя

1. Авторизация пользователя

Для входа в Web интерфейс телефонной станции необходимо ввести IP адрес телефонной станции в Web браузере. Ссылка для входа будет иметь вид https://<IP>/pbx.

При правильном вводе откроется страница авторизации где необходимо ввести Логин и Пароль.

auth.jpg

2. Восстановление пароля

В случае утери пароля есть возможность восстановить его воспользовавшись кнопкой "Восстановление пароля". Для восстановления пароля у пользователя должен быть корректный почтовый адрес который был введен ранее администратором системы при добавлении пользователя.

password-recovery.jpg

После ввода почтового адреса и нажатия кнопки "Сбросить пароль", на почту придет имя пользователя и новый пароль для входа в систему.

Документация пользователя

Настройка автоматического обзвона

1. Предварительные настройки должны быть выполнены администратором телефонной станции.

2. Авторизуемся на автоматической телефонной станции.

3. Заходим в меню Модули -> Автоматический обзвон.

4. Нажимаем Добавить.

5. Заполняем форму справочника автоматического обзвона.

image.png

Наименование - Произвольное наименование справочника автоматического обзвона.
Описание - Произвольное описание справочника автоматического обзвона.
Статус - Статус автоматического обзвона, для активации обзвона необходимо выбрать "Активный".
Лимит - Количество звонков выполняемых за один обзвон. Необходимо установить значение менее количества доступных каналов.
Перерыв - Перерыв между обзвонами. Необходимо установить время в секундах. Время должно быть больше чем будет проигрываться приветствие и завершение вызова.
Количество попыток - Количество попыток дозвона до абонента.
Исходящая маршрутизация - Настраивается предварительно администратором телефонной станции, необходимо использовать исходящую маршрутизацию.
Маршрутизация - Маршрутизация с которой соединяется абонент, настраивается предварительно администратором станции.
Расширение - Расширение маршрутизации на который приходит вызов.
Группа - Группа за которой закреплен данный справочник.

Документация разработчика

Документация разработчика

Структура модуля телефонной станции

1. Веб интерфейс модуля

Контроллер модуля
pbx - application - controllers - module - Index.php

Модель модуля
pbx - application - models - module - Index_model.php

Вид модуля
pbx - application - view - module - add_page.php
pbx - application - view - module - edit_page.php
pbx - application - view - module - index_page.php

Русификация
pbx - language - russian - module - index_lang.php

2. Видимость в конфигурации

pbx - application - config - pbx_config.php

$config['module'] = 'yes';

3. Меню

pbx - application - view - template - sidebar.php

4. Сервисы
# /var/lib/asterisk/daemons/module/module_daemon.service
# /var/lib/asterisk/daemons/module/daemon.php

5. AGI скрипты

# /var/lib/asterisk/agi-bin/module/agi.php

6. Скрипты модуля

/var/lib/asterisk/scripts/module/script.php

7. База данных

Таблица module

uuid Первичный varchar(36)
name varchar(128)
description varchar(128)
group_uuid varchar(36)

Индекс uuid

8. Миграция модуля

pbx - application - migrations - timestamp_add_module.php

Документация API

Документация API

Evolvex API

Введение

Программный интерфейс разработанный компанией Evolvex. Позволяет взаимодействовать с телефонной станцией через HTTP запросы. Позволяет расширить функциональность стандартного Manager API.

Проверка доступа

Проверка доступа

GET /api/index/check

Параметр Тип Обязательный Описание
api_key String Да API Ключ
context String Нет Маршрутизация
uniqueid String Нет Уникальный идентификатор звонка

Ответ в Json:

{
  "data": {
    "api_user": {
      "uuid": "5485137a-3c6d-454e-9801-d3b875f7a5e0",
      "name": "API",
      "description": "",
      "enable": "yes",
      "api_key": "84f8fc34-82ad-46b0-b5f3-3cfd0462beeb",
      "group_uuid": "4c343af6-4a91-469a-a717-f682e52c830f"
    },
    "access": {
      "uuid": "0eb1bc58-b259-4c88-be02-a059d50cecc3",
      "name": "incoming",
      "description": "Входящая маршрутизация",
      "group_uuid": "4c343af6-4a91-469a-a717-f682e52c830f"
    },
    "file": true
  }

Получение файла mp3

GET /api/index/get_file_mp3

Параметр Тип Обязательный Описание
api_key String Да API Ключ
uniqueid String Нет Уникальный идентификатор звонка

Ответ:

Потоковое аудио

Получение файла wav

GET /api/index/get_file_wav

Параметр Тип Обязательный Описание
api_key String Да API Ключ
uniqueid String Нет Уникальный идентификатор звонка

Ответ:

Потоковое аудио

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

GET /api/index/status

Параметр Тип Обязательный Описание
api_key String Да API Ключ
calleridnum String Нет АОН
connectedlinenum String Нет Соединенная линия
context String Нет Маршрутизация
exten String Нет Расширение

Ответ в Json:

{
  "data": [
    {
      "Event": "Status",
      "Privilege": "Call",
      "Channel": "PJSIP/user-00000011",
      "ChannelState": "5",
      "ChannelStateDesc": "Ringing",
      "CallerIDNum": "109",
      "CallerIDName": "",
      "ConnectedLineNum": "110",
      "ConnectedLineName": "",
      "Language": "ru",
      "AccountCode": "",
      "Context": "outgoing",
      "Exten": "109",
      "Priority": "1",
      "Uniqueid": "1711279935.61",
      "Linkedid": "1711279935.60",
      "Type": "PJSIP",
      "DNID": "",
      "EffectiveConnectedLineNum": "110",
      "EffectiveConnectedLineName": "",
      "TimeToHangup": "0",
      "BridgeID": "",
      "Application": "AppDial",
      "Data": "(Outgoing Line)",
      "Nativeformats": "(alaw|ulaw)",
      "Readformat": "alaw",
      "Readtrans": "",
      "Writeformat": "alaw",
      "Writetrans": "",
      "Callgroup": "0",
      "Pickupgroup": "0",
      "Seconds": "5",
      "Variable": "DIALEDPEERNUMBER=user/sip:user@1.1.1.1:5937",
      "DIALEDPEERNUMBER": "user/sip:company@1.1.1.1:5937",
      "ActionID": "66000f44594c1"
    },
    {
      "Event": "Status",
      "Privilege": "Call",
      "Channel": "PJSIP/user",
      "ChannelState": "4",
      "ChannelStateDesc": "Ring",
      "CallerIDNum": "110",
      "CallerIDName": "",
      "ConnectedLineNum": "109",
      "ConnectedLineName": "",
      "Language": "ru",
      "AccountCode": "",
      "Context": "outgoing",
      "Exten": "109",
      "Priority": "7",
      "Uniqueid": "1711279935.60",
      "Linkedid": "1711279935.60",
      "Type": "PJSIP",
      "DNID": "109",
      "EffectiveConnectedLineNum": "109",
      "EffectiveConnectedLineName": "",
      "TimeToHangup": "0",
      "BridgeID": "",
      "Application": "Dial",
      "Data": "PJSIP/user/sip:user@1.1.1.1:5937,60,tT",
      "Nativeformats": "(alaw|ulaw)",
      "Readformat": "alaw",
      "Readtrans": "",
      "Writeformat": "alaw",
      "Writetrans": "",
      "Callgroup": "0",
      "Pickupgroup": "0",
      "Seconds": "5",
      "Variable": "SIPDOMAIN=pbx1.ru",
      "RINGTIME_MS": "298",
      "RINGTIME": "0",
      "PROGRESSTIME_MS": "",
      "PROGRESSTIME": "",
      "DIALEDTIME_MS": "",
      "DIALEDTIME": "",
      "ANSWEREDTIME_MS": "",
      "ANSWEREDTIME": "",
      "DIALEDPEERNAME": "",
      "DIALEDPEERNUMBER": "",
      "DIALSTATUS": "",
      "MIXMONITOR_FILENAME": "/var/spool/asterisk/monitor/1711279935.60.wav",
      "SIPDOMAIN": "pbx1.ru",
      "ActionID": "66000f44594c1"
    }
  ]
}

Создание звонка

GET /api/index/originate

Параметр Тип Обязательный Описание
api_key String Да API Ключ
channel String Да Канал
exten String Да Расширение
context String Да Маршрутизация
priority Integer Да Приоритет
callerid String Нет АОН
variable String Нет Переменные
async Boolean Нет Асинхронный ввод

variable - позволяет передать несколько переменных через запятую. Например variable=file=123,idcall=456

Загрузка файла

POST /api/index/uploads

Параметр Тип Обязательный Описание
api_key String Да API Ключ
file File Да Файл

Пример загрузки файла:

$curl_file = curl_file_create("/home/user/test.wav");

$post = array("file"=> $curl_file);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http:/192.168.0.2/pbx/api/index/uploads?api_key=11111111-2222-3333-4444-555555555555");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$result = curl_exec($ch);
curl_close($ch);

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

POST /api/index/get_log_cdr

Параметр Тип Обязательный Описание
api_key String Да API Ключ
start Datetime Нет Начало записей логов, если не указано берется начало дня.
end Datetime Нет Конец записей логов, если не указано берется конец дня.

Ответ в Json:

{
  "data": [
    {
      "accountcode": null,
      "src": "79123456789",
      "dst": "110",
      "dcontext": "local-evolvex",
      "clid": "\"Сергей\" <79123456789>",
      "channel": "Local/110@local-evolvex-00000167;2",
      "dstchannel": "PJSIP/user-110-evolvex-000002a0",
      "lastapp": "Dial",
      "lastdata": "PJSIP/user-110-evolvex/sip:user-110-evolvex@1.1.1.1:10110,60,t",
      "start": "2024-10-30 09:59:15",
      "answer": null,
      "end": "2024-10-30 09:59:22",
      "duration": "7",
      "billsec": "0",
      "disposition": "NO ANSWER",
      "amaflags": "DOCUMENTATION",
      "userfield": null,
      "uniqueid": "1730267955.2409",
      "linkedid": "1730267935.2405",
      "peeraccount": null,
      "sequence": "1923",
      "source": null,
      "destination": null,
      "direction": null,
      "group_uuid": null
    }
  ]
}

Документация API

Manager API

Введение

Для работы с интерфейсом событий существует несколько вариантов взаимодействия.

/arawman => Raw HTTP Manager Event Interface with Digest authentication
/rawman => Raw HTTP Manager Event Interface
/amxml => XML Manager Event Interface with Digest authentication
/mxml => XML Manager Event Interface

Документация описывает взаимодействие с интерфейсом событий через необработанные HTTP запросы. Аналогичная документация применима и к другим вариантам.

Авторизация

GET /rawman?action=login

Параметр Тип Обязательный Описание

username

String

 Да Пользователь

secret

String

 Да Пароль

Пример запроса: http://<ip>:8088/rawman?action=login&username=test&secret=test

Пример ответа:

Response: Success
Message: Authentication accepted

Проверка доступности

GET /rawman?action=ping

Пример ответа:

Response: Success
Ping: Pong
Timestamp: 1711272193.709205

Запрос статуса телефонной станции

GET /rawman?action=status

Параметр Тип Обязательный Описание
actionid String Нет Идентификатор запроса

channel

String

 Нет Канал

variables

String

 Нет Переменные

allvariables

Boolean

 Нет Все переменные

Пример ответа:

Response: Success
EventList: start
Message: Channel status will follow

Event: Status
Privilege: Call
Channel: PJSIP/user
ChannelState: 6
ChannelStateDesc: Up
CallerIDNum: 110
CallerIDName: 
ConnectedLineNum: <unknown>
ConnectedLineName: <unknown>
Language: ru
AccountCode: 
Context: outgoing
Exten: 153
Priority: 3
Uniqueid: 1711273253.11
Linkedid: 1711273253.11
Type: PJSIP
DNID: 153
EffectiveConnectedLineNum: <unknown>
EffectiveConnectedLineName: <unknown>
TimeToHangup: 0
BridgeID: 
Application: Queue
Data: queue
Nativeformats: (alaw)
Readformat: alaw
Readtrans: 
Writeformat: slin
Writetrans: (slin@8000)->(alaw@8000)
Callgroup: 0
Pickupgroup: 0
Seconds: 21

Event: StatusComplete
EventList: Complete
ListItems: 1
Items: 1

Запрос создания звонка

GET /rawman?action=originate

Параметр Тип Обязательный Описание
actionid String Нет Идентификатор запроса

channel

String

 Да Канал

exten

String

 Да Расширение

context

String

 Да Маршрутизация

priority

Integer

 Да Приоритет

application

String

 Нет Приложение

data

String

 Да Данные приложение

timeout

Integer

 Да Таймаут

callerid

String

 Нет АОН

variable

String

 Нет Переменные

account




earlymedia




async

Boolean

 Нет Асинхронный ввод

codecs




channelid




otherchannelid




Пример запроса: http://<ip>:8088/rawman?action=originate&channel=PJSIP/user&context=outgoing&exten=100&priority=1&async=true

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

GET /rawman?action=listcommands

Пример ответа:

Response: Success
AbsoluteTimeout: Set absolute timeout.  (Priv: system,call,all)
AGI: Add an AGI command to execute by Async AGI.  (Priv: agi,all)
AOCMessage: Generate an Advice of Charge message on a channel.  (Priv: aoc,all)
Atxfer: Attended transfer.  (Priv: call,all)
BlindTransfer: Blind transfer channel(s) to the given destination  (Priv: call,all)
Bridge: Bridge two channels already in the PBX.  (Priv: call,all)
BridgeDestroy: Destroy a bridge.  (Priv: <none>)
BridgeInfo: Get information about a bridge.  (Priv: <none>)
BridgeKick: Kick a channel from a bridge.  (Priv: <none>)
BridgeList: Get a list of bridges in the system.  (Priv: <none>)
BridgeTechnologyList: List available bridging technologies and their statuses.  (Priv: <none>)
BridgeTechnologySuspend: Suspend a bridging technology.  (Priv: <none>)
BridgeTechnologyUnsuspend: Unsuspend a bridging technology.  (Priv: <none>)
CancelAtxfer: Cancel an attended transfer.  (Priv: call,all)
Challenge: Generate Challenge for MD5 Auth.  (Priv: <none>)
Command: Execute Asterisk CLI Command.  (Priv: command,all)
ConfbridgeKick: Kick a Confbridge user.  (Priv: call,all)
ConfbridgeList: List participants in a conference.  (Priv: reporting,all)
ConfbridgeListRooms: List active conferences.  (Priv: reporting,all)
ConfbridgeLock: Lock a Confbridge conference.  (Priv: call,all)
ConfbridgeMute: Mute a Confbridge user.  (Priv: call,all)
ConfbridgeSetSingleVideoSrc: Set a conference user as the single video source
  distributed toall other participants.  (Priv: call,all)
ConfbridgeStartRecord: Start recording a Confbridge conference.  (Priv: system,all)
ConfbridgeStopRecord: Stop recording a Confbridge conference.  (Priv: system,all)
ConfbridgeUnlock: Unlock a Confbridge conference.  (Priv: call,all)
ConfbridgeUnmute: Unmute a Confbridge user.  (Priv: call,all)
CoreSettings: Show PBX core settings (version etc).  (Priv: system,reporting,all)
CoreShowChannelMap: List all channels connected to the specified channel.  (Priv: system,reporting,all)
CoreShowChannels: List currently active channels.  (Priv: system,reporting,all)
CoreStatus: Show PBX core status variables.  (Priv: system,reporting,all)
CreateConfig: Creates an empty file in the configuration directory.  (Priv: config,all)
DBDel: Delete DB entry.  (Priv: system,all)
DBDelTree: Delete DB Tree.  (Priv: system,all)
DBGet: Get DB Entry.  (Priv: system,reporting,all)
DBGetTree: Get DB entries, optionally at a particular family/key  (Priv: system,reporting,all)
DBPut: Put DB entry.  (Priv: system,all)
DialplanExtensionAdd: Add an extension to the dialplan  (Priv: system,all)
DialplanExtensionRemove: Remove an extension from the dialplan  (Priv: system,all)
Events: Control Event Flow.  (Priv: <none>)
ExtensionState: Check Extension Status.  (Priv: call,reporting,all)
ExtensionStateList: List the current known extension states.  (Priv: call,reporting,all)
FAXSession: Responds with a detailed description of a single FAX session  (Priv: call,all)
FAXSessions: Lists active FAX sessions  (Priv: call,all)
FAXStats: Responds with fax statistics  (Priv: reporting,all)
Filter: Dynamically add filters for the current manager session.  (Priv: system,all)
GetConfig: Retrieve configuration.  (Priv: system,config,all)
GetConfigJSON: Retrieve configuration (JSON format).  (Priv: system,config,all)
Getvar: Gets a channel variable or function value.  (Priv: call,reporting,all)
Hangup: Hangup channel.  (Priv: system,call,all)
ListCategories: List categories in configuration file.  (Priv: config,all)
ListCommands: List available manager commands.  (Priv: <none>)
LocalOptimizeAway: Optimize away a local channel when possible.  (Priv: system,call,all)
LoggerRotate: Reload and rotate the Asterisk logger.  (Priv: system,reporting,all)
Login: Login Manager.  (Priv: <none>)
Logoff: Logoff Manager.  (Priv: <none>)
MailboxCount: Check Mailbox Message Count.  (Priv: call,reporting,all)
MailboxStatus: Check mailbox.  (Priv: call,reporting,all)
MessageSend: Send an out of call message to an endpoint.  (Priv: message,all)
MixMonitor: Record a call and mix the audio during the recording.
  Use of StopMixMonitor is required to guarantee the audio file
  is available for processing during dialplan execution.  (Priv: system,all)
MixMonitorMute: Mute / unMute a Mixmonitor recording.  (Priv: system,call,all)
ModuleCheck: Check if module is loaded.  (Priv: system,all)
ModuleLoad: Module management.  (Priv: system,all)
Originate: Originate a call.  (Priv: originate,all)
Ping: Keepalive command.  (Priv: <none>)
PJSIPHangup: Hangup an incoming PJSIP channel with a SIP response code  (Priv: system,call,all)
PJSIPQualify: Qualify a chan_pjsip endpoint.  (Priv: system,reporting,all)
PJSIPRegister: Register an outbound registration.  (Priv: system,reporting,all)
PJSIPShowAors: Lists PJSIP AORs.  (Priv: system,all)
PJSIPShowAuths: Lists PJSIP Auths.  (Priv: system,all)
PJSIPShowContacts: Lists PJSIP Contacts.  (Priv: system,all)
PJSIPShowEndpoint: Detail listing of an endpoint and its objects.  (Priv: system,all)
PJSIPShowEndpoints: Lists PJSIP endpoints.  (Priv: system,all)
PJSIPShowRegistrationInboundContactStatuses: Lists ContactStatuses
  for PJSIP inbound registrations.  (Priv: system,all)
PJSIPShowRegistrationsInbound: Lists PJSIP inbound registrations.  (Priv: system,all)
PJSIPShowRegistrationsOutbound: Lists PJSIP outbound registrations.  (Priv: system,reporting,all)
PJSIPShowResourceLists: Displays settings for configured resource lists.  (Priv: system,all)
PJSIPShowSubscriptionsInbound: Lists subscriptions.  (Priv: system,all)
PJSIPShowSubscriptionsOutbound: Lists subscriptions.  (Priv: system,all)
PJSIPUnregister: Unregister an outbound registration.  (Priv: system,reporting,all)
PresenceState: Check Presence State  (Priv: call,reporting,all)
QueueAdd: Add interface to queue.  (Priv: agent,all)
QueueChangePriorityCaller: Change priority of a caller on queue.  (Priv: <none>)
QueueLog: Adds custom entry in queue_log.  (Priv: agent,all)
QueueMemberRingInUse: Set the ringinuse value for a queue member.  (Priv: agent,all)
QueuePause: Makes a queue member temporarily unavailable.  (Priv: agent,all)
QueuePenalty: Set the penalty for a queue member.  (Priv: agent,all)
QueueReload: Reload a queue, queues, or any sub-section of a queue or queues.  (Priv: <none>)
QueueRemove: Remove interface from queue.  (Priv: agent,all)
QueueReset: Reset queue statistics.  (Priv: <none>)
QueueRule: Queue Rules.  (Priv: <none>)
QueueStatus: Show queue status.  (Priv: <none>)
QueueSummary: Show queue summary.  (Priv: <none>)
QueueWithdrawCaller: Request to withdraw a caller from the queue back to the dialplan.  (Priv: <none>)
Redirect: Redirect (transfer) a call.  (Priv: call,all)
Reload: Send a reload event.  (Priv: system,config,all)
SendText: Sends a text message to channel. A content type
  can be optionally specified. If not set it is set to an empty
  string allowing a custom handler to default it as it sees fit.  (Priv: call,all)
Setvar: Sets a channel variable or function value.  (Priv: call,all)
ShowDialPlan: Show dialplan contexts and extensions  (Priv: config,reporting,all)
Status: List channel status.  (Priv: system,call,reporting,all)
StopMixMonitor: Stop recording a call through MixMonitor,
  and free the recording's file handle.  (Priv: system,call,all)
UpdateConfig: Update basic configuration.  (Priv: config,all)
UserEvent: Send an arbitrary event.  (Priv: user,all)
WaitEvent: Wait for an event to occur.  (Priv: <none>)

Описание команд

GET /rawman?action=command&command=manager show command waitevent

Пример ответа:

Response: Success
Message: Command output follows
Output: [Syntax]
Output: Action: WaitEvent
Output: [ActionID:] <value>
Output: Timeout: <value>
Output: 
Output: [Synopsis]
Output: Wait for an event to occur. 
Output: 
Output: [Description]
Output: This action will elicit a 'Success' response. Whenever a manager event is
Output: queued. Once WaitEvent has been called on an HTTP manager session, events will
Output: be generated and queued.
Output: 
Output: [Arguments]
Output: ActionID
Output:     ActionID for this transaction. Will be returned.
Output: Timeout
Output:     Maximum time (in seconds) to wait for events, '-1' means forever.
Output: 
Output: [See Also]
Output: Not available
Output: 
Output: [Privilege]
Output: <none>
Output: 
Output: [List Responses]
Output: None
Output: 
Output: [Final Response]
Output: None
Output: 
Output: