Отправка уведомления в телеграм по окончании разговора

В последнее время мессенджеры набирают популярность. Особенно телеграм. Но доводилось вам сталкиваться с потребностью отправлять уведомление в телеграм? А если это уведомление о завершившемся звонке? Нет? Тогда эта статья для Вас. В ней мы рассмотрим какой диалплан писать на Астериске. Также будет приведен пример скрипта, который будет мониторить AMI события и отправлять сообщения в телеграм.

Hangup_handler и UserEvent

Поставим задачу таким образом: на астериск поступает извне вызов. который обрабатывается по существующей схеме. Необходимо выполнить отправку сообщения в телеграм при завершении звонка. Что мы можем сделать?

1. Перелопатить кучу контекстов и в каждый из них добавить экстеншн h, который отвечает за разрыв соединения.
2. Или использовать hangup_handler.

Первый пункт нас не интересует. т.к. он слишком долгий. При этом в каждом из контекстов использовать CURL для отправки POST запроса тоже не есть хорошо. Поэтому было выбран способ с UserEvent и Hangup_handler. Вы спросите, что это такое Hangup_handler? Этот функционал позволяет выполнять диалплан сразу после завершения вызова на канале. Также он имеет ряд преимуществ перед использованием экстеншена h.

• hangup handler срабатывает вне зависимости от того, в каком контексте происходит выполнение диалплана в момент завершения вызова
• можно выполнить диалплан при завершении вызова на канале, на котором диалплан не выполняется, и последнее никак нельзя реализовать с помощью экстеншена h

Именно эта функция поможет нам универсально отправлять пользовательское событие в вывод AMI. Для этого мы будем использовать UserEvent.

UserEvent(имя_события, передаваемое значение)

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

Приступим к реализации. Исходя из условия задачи, создадим дополнительный контекст, куда мы направим вызов (изменить параметр context на from-trunk-pre в настройках транка), при поступлении на АТС и навесим на первичный канал наш hangup_handler.

from-trunk-pre]
exten => _X.,1,Set(CHANNEL(hangup_handler_push)=sub-hangup-handler-tg,s,1(${CALLERID(num)})
        same => n,Goto(from-trunk,${EXTEN},1)

Таким образом, мы говорим Астериску, что при завершении вызова на создавшемся канале выполнить контекст sub-hangup-handler-tg.

Полдела сделано. Осталось навесить UserEvent и можно приступать к написанию скрипта. Опишем контекст sub-hangup-handler-tg. Он будет состоять из 2 шагов первый — мы кидаем UserEvent и второй — возвращаемся обратно командой Return.

[sub-hangup-handler-tg]
exten => s,1,UserEvent(HANGUP_TG, Caller: ${ARG1})
        same => n,Return

В данном примере пользовательское событие мы назвали HANGUP_TG, у вас оно может быть другое и в тело события мы добавили аргумент Caller, который будет содержать номер звонящего ${ARG1}

После внесения изменений в диалплан применяем правки, выполняя команду dialplan reload в консоли астериска.

Скрипт отправки в телеграм

Скрипт будем писать на Python 3 версии. Поэтому вам необходимо будет заранее установить интерпретатор этой версии к себе на машину.

Для работы нашего скрипта необходимо будет установить следующие модули:

• aiohttp==3.6.2
• async-timeout==3.0.1
• attrs==19.3.0
• certifi==2020.4.5.1
• chardet==3.0.4
• idna==2.9
• idna-ssl==1.1.0
• multidict==4.7.6
• panoramisk==1.3
• PySocks==1.7.1
• requests==2.23.0
• telepot==12.7
• typing-extensions==3.7.4.2
• urllib3==1.25.9
• yarl==1.4.2

Они устанавливаются следующей командой:

pip install aiohttp async-timeout attrs certifi chardet idna idna-ssl multidict panoramisk PySocks requests telepot typing-extensions urllib3 yarl

Начнем записывать наш скрипт. Для этого перейдем в необходимую для нас директорию, в моем примере это /opt/pyth/ и создадим файл hangup.py и затем откроем созданный файл любым текстовым редактором

# cd /opt/pyth/
# touch hangup.py
# vim hangup.py

Сперва, подключим необходимые модули:

"""
Modules for AMI
"""
import asyncio
from panoramisk import Manager


"""
Import modules for Telegram
"""
import telepot 
# функции для использования прокси
from urllib3.contrib.socks import SOCKSProxyManager
from telepot.api import _default_pool_params, _onetime_pool_params

Зададим необходимые переменные и установим данные для подключения к прокси:

#
# -/-/-/-/-/- SET PROXY CONNECTION -/-/-/-/-
#
telepot.api._onetime_pool_spec = (SOCKSProxyManager, dict(proxy_url='socks5://URL_FOR_POXY', username='username', password='password', **_onetime_pool_params))
telepot.api._pools['default'] = SOCKSProxyManager('socks5://URL_FOR_POXY', username=''username', password='password', **_default_pool_params)



bot = telepot.Bot('YOUR_TG_BOT_API')
manager = Manager( loop = asyncio.get_event_loop(),
        host='127.0.0.1',
        port=5038,
        encoding='utf-8',
        username='test',
        secret='test'
)

Переменная bot — устанавливает подключение к API телеграма с ключем, созданного бота. А переменная manager осуществляет подключение к AMI интерфейсу Астериск.

Теперь опишем функционал отслеживания события UserEvent. для этого в библиотеке panoramisk используется функция register_event. Её можно использовать как декоратор, что упрощает обращение к ней.

@manager.register_event('UserEvent')
def callback(manager, message):
        message = dict(message)
        if message['UserEvent'] == 'HANGUP_TG':
                from datetime import datetime
                time = datetime.utcfromtimestamp(datetime.now().timestamp()).strftime('%Y-%m-%d %H:%M:%S')
                bot.sendMessage(chat_id,'{1} завершен вызов от {0}'.format(message['CallerIDNum'], time))
        pprint(message)

Что показывает данный кусок кода:

1. Передаем в функцию register_event аргумент, значением которого будет название события — ‘UserEvent’
2. Полученный ответ AMI мы преобразуем в словарь (HASH).
3. Проверяем, если в теле события есть заголовок ‘UserEvent’ с значением, которое мы указывали в диалплане — HANGUP_TG, то
   1. указываем в переменную time текущее значение времени в формате datetime
   2. отправляем в телеграм с помощью функции библиотеки telepot — sendMessage

И указываем строки. чтобы скрипт мог работать в фоне:

def main():
        manager.connect()
        try:
                manager.loop.run_forever()
        except KeyboardInterrupt:
                manager.loop.close()

if __name__ == '__main__':
        main()

Чтобы скрипт работал в фоне. можете использовать supervisord. Воспользуйтесь этой статьей, чтобы узнать как его настроить

Листинг скрипта

"""
Modules for AMI
"""
import asyncio
from panoramisk import Manager


"""
Import modules for Telegram
"""
import telepot
from urllib3.contrib.socks import SOCKSProxyManager
from telepot.api import _default_pool_params, _onetime_pool_params

# Module for Pretty print
from pprint import pprint

global bot
#
# -/-/-/-/-/- SET PROXY CONNECTION -/-/-/-/-
#
telepot.api._onetime_pool_spec = (SOCKSProxyManager, dict(proxy_url='socks5://URL', username='username', password='password', **_onetime_pool_params))
telepot.api._pools['default'] = SOCKSProxyManager('socks5://URL', username='username', password='password', **_default_pool_params)



bot = telepot.Bot('3_API_TOKEN_nDs')
manager = Manager( loop = asyncio.get_event_loop(),
        host='127.0.0.1',
        port=5038,
        ssl=False,
        encoding='utf-8',
        username='test',
        secret='test'
)

@manager.register_event('UserEvent')
def callback(manager, message):
        message = dict(message)
        if message['UserEvent'] == 'HANGUP_TG':
                from datetime import datetime
                time = datetime.utcfromtimestamp(datetime.now().timestamp()).strftime('%Y-%m-%d %H:%M:%S')
                bot.sendMessage(chat_id,'{1} завершен вызов от {0}'.format(message['CallerIDNum'], time))
        pprint(message)


def main():
        manager.connect()
        try:
                manager.loop.run_forever()
        except KeyboardInterrupt:
                manager.loop.close()

if __name__ == '__main__':
        main()

Проверка

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