Descarga PySIP - Descarga del código fuente PySIP

PySIP

Otras categorias

v1.8.0

Descargar

Biblioteca SIP de Python para soluciones VoIP personalizadas

PySIP es una biblioteca de Python asincrónica diseñada para simplificar el trabajo con el Protocolo de inicio de sesión (SIP) para la comunicación VoIP. Ya sea que esté creando sistemas de llamadas automatizados, menús de respuesta de voz interactiva (IVR) o cualquier aplicación basada en SIP, PySIP le brinda la flexibilidad de crear y administrar cuentas SIP, manejar llamadas e implementar lógica personalizada con facilidad.

Características

Característica	Descripción
Gestión completa de cuentas SIP	Cree, registre y administre fácilmente cuentas SIP.
Flujos de llamadas personalizados	Escriba scripts para automatizar los flujos de llamadas con su propia lógica empresarial.
Capa de transporte UDP	Transporte UDP asincrónico y eficiente para enviar y recibir mensajes SIP.
Manejo flexible de llamadas	Maneje llamadas SIP entrantes y salientes, reproduzca mensajes y recopile entradas de usuarios.
Totalmente extensible	Incluye un bot de ejemplo para reservar citas, pero puede escribir fácilmente cualquier automatización basada en SIP que necesite.

Tabla de contenido

Instalación
Estructura del proyecto
Empezando
Uso detallado
- Cuenta SIP
- Manejo de llamadas
- Transporte UDP
Guión de ejemplo
Crear sus scripts SIP personalizados
Contribuyendo

Instalación

Opción 1: instalar desde PyPI

Puede instalar PySIP directamente desde PyPI usando pip:

pip install PySIPio

Precaución

Tenga en cuenta que el nombre del paquete en PyPI es PySIPio y no PySIP

Opción 2: instalar desde la fuente

Paso 1: clonar el repositorio

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

Paso 2: instalar dependencias

Asegúrese de tener Python 3.8+ instalado. Instale las dependencias requeridas usando:

pip install -r requirements.txt

? Estructura del proyecto

El proyecto está estructurado para proporcionar una separación clara entre la biblioteca SIP principal y cualquier script personalizado que desee escribir. Aquí hay una descripción general del diseño del proyecto:

 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

? Empezando

Paso 1: configuración del entorno

Cree un archivo .env en su directorio de trabajo para almacenar las credenciales de su cuenta SIP y los detalles del servidor:

SIP_USERNAME=your_sip_username
SIP_PASSWORD=your_sip_password
SIP_SERVER=your_sip_server

Paso 2: configurar una cuenta SIP

Una cuenta SIP es esencial para manejar llamadas. Para comenzar, necesita crear una instancia de la clase SipAccount , que requiere sus credenciales SIP (nombre de usuario, contraseña y servidor). He aquí cómo hacerlo:

 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" ],
)

Paso 3: registrar la cuenta

Una vez creada la SipAccount , el siguiente paso es registrarla en el servidor SIP:

 await account . register ()

Esto envía una solicitud REGISTER SIP al servidor para activar la cuenta. Una vez registrado, podrá realizar llamadas o escuchar llamadas entrantes.

Uso detallado

Cuenta SIP

La clase SipAccount es el núcleo de PySIP. Maneja todas las tareas relacionadas con la cuenta, como el registro, la realización de llamadas y la cancelación del registro del servidor SIP.

Crear una instancia de una cuenta SIP :

 account = SipAccount ( username , password , server )

Registrarse :

Llame al método register() para registrar la cuenta SIP con el servidor:

 await account . register ()

Realizar llamadas :

El método make_call(destination) inicia una llamada al número de destino:

 call = account . make_call ( "destination_number" )

Manejo de llamadas entrantes :

Utilice el decorador on_incoming_call para definir una función que manejará las llamadas entrantes:

 @ 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 ()

Darse de baja :

Cuando haya terminado, cancele el registro de la cuenta para cerrar la sesión correctamente:

 await account . unregister ()

Manejo de llamadas

CallHandler es responsable de manejar el flujo de llamadas. Le permite decir mensajes, recopilar información de la persona que llama o transferir la llamada.

Reproducir un mensaje a la persona que llama :

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

Recopilación de aportaciones del usuario :

Utilice gather() para recopilar información del usuario, como presionar un dígito:

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

Transferir la llamada :

Puedes desviar la llamada a otro número:

 await call_handler . transfer_to ( "1234567890" )

Aceptar, rechazar o establecer ocupado para llamadas entrantes :

Para llamadas entrantes, puede utilizar los siguientes métodos:

 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

Transporte UDP

UdpHandler es un módulo interno que gestiona el envío y recepción asincrónica de mensajes SIP a través de la red.

Enviando un mensaje :

El método send_message() envía un mensaje UDP al servidor SIP o par:

 self . transport . sendto ( message )

Recibir un datagrama :

El método datagram_received() maneja los mensajes entrantes y los coloca en una cola para su procesamiento:

 self . data_q . put_nowait ( data )

? Guión de ejemplo

Para demostrar PySIP en acción, proporcionamos un ejemplo básico de un bot de reserva de citas. Este bot permite a las personas que llaman reservar citas mediante una llamada telefónica.

 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 ())

? Crear sus scripts SIP personalizados

Si bien el robot de reserva de citas es solo un ejemplo, PySIP está diseñado para permitirle crear cualquier automatización basada en SIP o script personalizado que se adapte a sus necesidades.

Para crear su propio script:

Cree un archivo Python en el directorio scripts/ .
Escriba su lógica de llamadas personalizada utilizando la clase CallHandler para controlar el flujo de llamadas.
Utilice SipAccount para registrarse y realizar llamadas como se muestra en el script de ejemplo.