Skip to main content

OpenSIPS Python Packages

This repository contains a collection of Python packages for OpenSIPS. These modules are designed to be as lightweight as possible and provide a simple interface for interacting with OpenSIPS. Alongside the source code, the repository also contains a Docker image that comes with the OpenSIPS Python packages pre-installed.

Features

Currently, the following packages are available:

  • mi - can be used to execute OpenSIPS Management Interface (MI) commands.
  • event - allows you to use OpenSIPS Event Interface subscriptions.

Usage

  1. Install the package from source code:

    git clone
    cd python-opensips
    pip install .
    

    or from PyPI:

    pip install opensips
    
  2. Import the package in your Python code:

    from opensips.mi import OpenSIPSMI, OpenSIPSMIException
    from opensips.event import OpenSIPSEvent, OpenSIPSEventException, OpenSIPSEventHandler
    
  3. Use the methods provided by the modules:

    mi = OpenSIPSMI('http', url='http://localhost:8888/mi')
    try:
        response = mi.execute('ps')
        # do something with the response
    except OpenSIPSMIException as e:
        # handle the exception
    
    mi_connector = OpenSIPSMI('http', url='http://localhost:8888/mi')
    hdl = OpenSIPSEventHandler(mi_connector, 'datagram', ip='127.0.0.1', port=50012)
    
    def some_callback(message):
        # do something with the message (it is a JSON object)
        pass
    
    ev: OpenSIPSEvent = None
    try:
        event = hdl.subscribe('E_PIKE_BLOCKED', some_callback)
    except OpenSIPSEventException as e:
        # handle the exception
    
    try:
        ev.unsubscribe('E_PIKE_BLOCKED')
    except OpenSIPSEventException as e:
        # handle the exception
    

Documentation

  • MI - contains information about supported MI communication types and required parameters for each type.
  • Event Interface - lists the supported event transport protocols and provides information about the required parameters for each protocol.
  • Docker - provides information about the Docker image that contains the OpenSIPS Python packages.

Scripts

MI

After installing the package, you can use the provided opensips-mi script to run MI commands. This script takes the following arguments:

  • -t or --type - the type of the MI communication (http, datagram or fifo).
  • -i or --ip - the IP address of the OpenSIPS server.
  • -p or --port - the port of the OpenSIPS MI.
  • -f or --fifo-file - the path to the FIFO file.
  • -fb or --fifo-fallback - the path to the FIFO fallback file.
  • -fd or --fifo-reply-dir - the directory where the FIFO reply files are stored.
  • --env-file - the path to the environment file that contains the MI parameters (by default, the script will look for the .env file in the current directory); lower priority than the command line arguments.
  • -ds or --datagram-socket - Unix Datagram Socket.
  • -dt or --datagram-timeout - Datagram Socket timeout in seconds. Default is 0.1.
  • -db or --datagram-buffer-size - Datagram Socket buffer size in bytes. Default is 32768.

Usage

# general usage
opensips-mi -t datagram -p 8080 command_name [command_args ...]

# this will execute get_statistics command
opensips-mi -t datagram -p 8080 -s core: shmem:

# you can pass json string as argument with -j flag for commands that require arrays as arguments
opensips-mi -t datagram -p 8080 get_statistics -j "{'statistics': ['core:', 'shmem:']}"

Event

You can use the provided opensips-event script to subscribe for OpenSIPS events. This script takes the following arguments:

  • all the above arguments for the MI communication
  • -T or --transport - the transport protocol to use (datagram, stream).
  • -li or --listen-ip - the IP address to listen on.
  • -lp or --listen-port - the port to listen on.
  • -e or --expire - the expiration time for the subscription.
  • the event name to subscribe for.
  • --env-file - the path to the environment file that contains the MI parameters (by default, the script will look for the .env file in the current directory); lower priority than the command line arguments.

Usage

opensips-event -t datagram -p 8080 -T datagram -lp 50012 -e 3600 E_PIKE_BLOCKED

License

The python-opensips source code is licensed under the GNU General Public License v3.0

All documentation files (i.e. .md extension) are licensed under the Creative Commons License 4.0

Creative Commons Logo

© 2024 - OpenSIPS Solutions

Metadata

Release files for opensips 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opensips 0.1.11
File Size Uploaded Provenance Actions
opensips-0.1.11.tar.gz 46.5 kB With provenance Details for opensips-0.1.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opensips 0.1.11
File Interpreter ABI Platform Actions
opensips-0.1.11-py3-none-any.whl Python 3 none any Details for opensips-0.1.11-py3-none-any.whl

Total release size: 100.2 kB

Release files / opensips-0.1.11.tar.gz

Download URL opensips-0.1.11.tar.gz
Size 46.5 kB
Tags Source
SHA-256 checksum
How to use checksums
cee82746abe955f9617d163c65f8477148d3fff9d33e39c71b34b4c1e02a4e32
BLAKE2b-256 checksum
How to use checksums
f3ee8f7c567ce615e399a191a9486bdce9a5f4f375038c0d1c20619ad05f175f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / opensips-0.1.11-py3-none-any.whl

Download URL opensips-0.1.11-py3-none-any.whl
Size 53.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
73092c6867c11c29121305db9a83e9771cf99c112940f2fcb548d66848a277a9
BLAKE2b-256 checksum
How to use checksums
6b88a7999ed1d4f3f7dc46d613d5215d8796c07dfcbcfbcd467fc746df6268e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Security for opensips 0.1.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for opensips-0.1.11.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page