Загрузка PySIP - Загрузка исходного кода PySIP

PySIP

Другие категории

v1.8.0

Скачать

Библиотека Python SIP для индивидуальных решений VoIP

PySIP — это асинхронная библиотека Python, предназначенная для упрощения работы с протоколом инициации сеанса (SIP) для связи VoIP. Независимо от того, создаете ли вы автоматизированные системы вызовов, меню интерактивного голосового ответа (IVR) или любое приложение на основе SIP, PySIP дает вам гибкость для создания и управления учетными записями SIP, обработки вызовов и с легкостью реализации пользовательской логики.

Функции

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

Установка
Структура проекта
Начиная
Подробное использование
- SIP-аккаунт
- Обработка вызовов
- UDP-транспорт
Пример сценария
Создание собственных сценариев SIP
Содействие

Установка

Вариант 1. Установка из PyPI.

Вы можете установить PySIP непосредственно из PyPI, используя pip:

pip install PySIPio

Осторожность

Обратите внимание, что имя пакета в PyPI — PySIPio , а не PySIP

Вариант 2. Установить из исходного кода.

Шаг 1. Клонируйте репозиторий.

git clone https://github.com/moha-abdi/PySIP.git
cd PySIP

Шаг 2. Установите зависимости

Убедитесь, что у вас установлен Python 3.8+. Установите необходимые зависимости, используя:

pip install -r requirements.txt

? Структура проекта

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

 PySIP/
│
├── PySIP/                     # Core library files
│   ├── sip_account.py          # SIP account management
│   ├── sip_core.py             # SIP message parsing and handling
│   ├── udp_handler.py          # Asynchronous UDP transport for SIP
│
├── scripts/                    # Example custom scripts
│   └── appointment_booking_bot.py  # Example bot for appointment booking
│
├── test.py                     # Example usage of PySIP for testing
├── requirements.txt            # Project dependencies
├── .env.example                # Example environment configuration
└── README.md                   # Project documentation

? Начиная

Шаг 1: Настройка среды

Создайте файл .env в своем рабочем каталоге для хранения учетных данных вашей учетной записи SIP и сведений о сервере:

SIP_USERNAME=your_sip_username
SIP_PASSWORD=your_sip_password
SIP_SERVER=your_sip_server

Шаг 2. Настройка учетной записи SIP

Учетная запись SIP необходима для обработки вызовов. Для начала вам необходимо создать экземпляр класса SipAccount , для которого требуются ваши учетные данные SIP (имя пользователя, пароль и сервер). Вот как это сделать:

 from PySIP . sip_account import SipAccount
import os
from dotenv import load_dotenv

# Load SIP credentials from .env file
load_dotenv ()

account = SipAccount (
    os . environ [ "SIP_USERNAME" ],
    os . environ [ "SIP_PASSWORD" ],
    os . environ [ "SIP_SERVER" ],
)

Шаг 3: Регистрация учетной записи

После создания SipAccount следующим шагом будет его регистрация на SIP-сервере:

 await account . register ()

При этом на сервер отправляется запрос SIP REGISTER для активации учетной записи. После регистрации вы сможете совершать звонки или прослушивать входящие звонки.

Подробное использование

SIP-аккаунт

Класс SipAccount лежит в основе PySIP. Он выполняет все задачи, связанные с учетной записью, такие как регистрация, совершение вызовов и отмена регистрации на SIP-сервере.

Создание экземпляра SIP-аккаунта :

 account = SipAccount ( username , password , server )

Регистрация :

Вызовите метод register() чтобы зарегистрировать учетную запись SIP на сервере:

 await account . register ()

Совершение звонков :

Метод make_call(destination) инициирует вызов на номер назначения:

 call = account . make_call ( "destination_number" )

Обработка входящих звонков :

Используйте декоратор on_incoming_call , чтобы определить функцию, которая будет обрабатывать входящие вызовы:

 @ account . on_incoming_call
async def handle_incoming_call ( call : SipCall ):
    await call . accept ()  # or call.reject() or call.busy()
    await call . call_handler . say ( "Thank you for calling us!" )
    await call . call_handler . hangup ()

Отмена регистрации :

Когда вы закончите, отмените регистрацию учетной записи, чтобы корректно закрыть сеанс:

 await account . unregister ()

Обработка вызовов

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

Воспроизведение сообщения вызывающему абоненту :

 await call_handler . say ( "Welcome to our service." )

Сбор данных пользователя :

Используйте gather() для сбора данных от пользователя, например, нажатия цифры:

 dtmf_key = await call_handler . gather ( length = 1 , timeout = 5 )

Передача вызова :

Вы можете переадресовать звонок на другой номер:

 await call_handler . transfer_to ( "1234567890" )

Принятие, отклонение или установка занятости для входящих вызовов :

Для входящих звонков вы можете использовать следующие методы:

 await call . accept ()  # Accept the incoming call
await call . reject ()  # Reject the incoming call
await call . busy ()    # Mark the line as busy for the incoming call

UDP-транспорт

UdpHandler — это внутренний модуль, который управляет асинхронной отправкой и получением SIP-сообщений по сети.

Отправка сообщения :

Метод send_message() отправляет UDP-сообщение на SIP-сервер или одноранговый узел:

 self . transport . sendto ( message )

Получение датаграммы :

Метод datagram_received() обрабатывает входящие сообщения, помещая их в очередь на обработку:

 self . data_q . put_nowait ( data )

? Пример сценария

Чтобы продемонстрировать PySIP в действии, мы предоставили базовый пример бота для записи на прием. Этот бот позволяет звонящим назначать встречи по телефону.

 import asyncio
from PySIP . sip_account import SipAccount
from scripts . appointment_booking_bot import appointment_booking_bot
from dotenv import load_dotenv
import os

# Load environment variables
load_dotenv ()

# Initialize SIP account with credentials from .env file
account = SipAccount (
    os . environ [ "SIP_USERNAME" ],
    os . environ [ "SIP_PASSWORD" ],
    os . environ [ "SIP_SERVER" ],
)

@ account . on_incoming_call
async def handle_incoming_call ( call : SipCall ):
    await call . accept ()
    await call . call_handler . say ( "We have received your call successfully" )

async def main ():
    # Register the SIP account
    await account . register ()

    # Make a call to a test number (e.g., '111')
    call = account . make_call ( "111" )
    call_task = asyncio . create_task ( call . start ())

    # Run the appointment booking bot
    await appointment_booking_bot ( call . call_handler , customer_name = "John" )

    # Wait for the call to complete, then unregister
    await call_task
    await account . unregister ()

if __name__ == "__main__" :
    asyncio . run ( main ())

? Создание собственных сценариев SIP

Хотя бот для записи на прием — это лишь один пример, PySIP предназначен для того, чтобы позволить вам создавать любую автоматизацию на основе SIP или собственный сценарий, который соответствует вашим потребностям.

Чтобы создать свой собственный сценарий:

Создайте файл Python в каталоге scripts/ .
Напишите свою собственную логику вызовов, используя класс CallHandler для управления потоком вызовов.
Используйте SipAccount для регистрации и совершения звонков, как показано в примере сценария.