Login | Register

Documentation

Documentation -> Manuals -> Manual 3.5 -> Modules

Pages for other versions: devel 3.4 3.3 3.2 3.1 Older versions: 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4


Modules v3.5
PrevNext

1.  SIP related modules

1.1  SIP signaling modules

  • B2B_ENTITIES - Back-to-Back User Agent Entities, stable
  • B2B_LOGIC - Back-to-Back User Agent Logic, stable
  • CALL CENTER - Inbound call center system , stable
  • DIALOG - Dialog support module , stable
  • NAT_TRAVERSAL - NAT traversal module , stable
  • NATHELPER - NAT traversal helper module , stable
  • OPTIONS - OPTIONS server replier module , stable
  • REGISTRAR - SIP Registrar implementation module , stable
  • SIGNALING - SIP signaling module , stable
  • UAC_REGISTRANT - SIP Registrant implementation module , stable
  • TM - Transaction (stateful) module , stable
  • SL - Stateless replier module , stable
  • MEDIA_EXCHANGE - Module to exchange SDP bodies between different SIP calls, beta
  • CALLOPS - Module to trigger different call operations on ongoing SIP calls, beta
  • B2B_SDP_DEMUX - Module to de-multiplex calls with multiple media streams, alpha
  • MSRP_UA - MSRP User Agent module, alpha

1.2  SIP Routing modules

  • CARRIERROUTE - routing extension suitable for carriers , stable
  • CPL_C - CPL interpreter module , stable
  • DISPATCHER - Dispatcher module , stable
  • DROUTING - Dynamic Routing / LCR , stable
  • QROUTING - Quality-based Routing , beta
  • EMERGENCY - Emergency module, beta
  • ENUM - ENUM lookup module , stable
  • JABBER - JABBER IM and PRESENCE interconnection module , beta
  • IMC - Instant Messaging Conferencing module , stable
  • LOAD_BALANCER - Load Balancer (for calls) module, stable
  • MID_REGISTRAR - SIP registration front-end with traffic throttling , stable
  • MSILO - SIP message silo module , stable
  • MSRP_GATEWAY - SIP MESSAGE / MSRP gateway module, alpha
  • RR - Record-Route and Route module , stable
  • SCRIPT_HELPER - Embedded SIP routing logic and dialog management, stable
  • OSP - OSP peering module , stable

1.3  SIP messaging operations

  • COMPRESSION - Message compression and compaction, stable
  • DIVERSION - Diversion header insertion module , stable
  • IDENTITY - SIP Identity implementation, stable
  • MAXFWD - Max-Forward processor module , stable
  • MANGLER - SIP mangler module , stable
  • PATH - Path support for SIP frontending , stable
  • SIP_I - ISUP manipulation module , stable
  • SIPMSGOPS - SIP operations module , stable
  • STIR_SHAKEN - STIR/SHAKEN support , beta
  • TOPOLOGY_HIDING - Provides Topology Hiding capabilities , stable
  • UAC - UAC functionalies (FROM mangling and UAC auth) , stable
  • UAC_AUTH - UAC Authentication functionality, stable
  • UAC_REDIRECT - UAC redirection functionality , stable
  • SST - SIP Session Timer support , stable

1.4  SIP Presence Modules

  • PRESENCE - Presence server module - common API , stable
  • PRESENCE_CALLINFO - Extension to Presence server for Call-Info, stable
  • PRESENCE_DIALOGINFO - Extension to Presence server for Dialog Info, stable
  • PRESENCE_DFKS - Extension to Presence server for Device Feature Key Synchronization, alpha
  • PRESENCE_MWI - Extension to Presence server for Message Waiting Indication , stable
  • PRESENCE_XCAPDIFF - Extension to Presence server for XCAP-DIFF event, stable
  • PRESENCE_XML - Presence server module - presence & watcher info and XCAP , stable
  • PUA - Common API for presence user agent client , stable
  • PUA_BLA - BLA extension for PUA , stable
  • PUA_DIALOGINFO - Dialog-Info extension for PUA , stable
  • PUA_MI - MI extension for PUA , stable
  • PUA_USRLOC - USRLOC extension for PUA , stable
  • PUA_XMPP - XMPP extension for PUA (SIMPLE-XMPP presence gateway) , stable
  • B2B_SCA - Back-to-Back Shared Call Appearance, stable
  • RLS - Resource List Server implementation , stable
  • XCAP - XCAP API provider , stable
  • XCAP_CLIENT - XCAP client implementation , stable

2.  Scripting modules

2.1  Script helper modules

  • JSON - Manipulate JSON objects in OpenSIPS script, stable
  • XML - Manipulate XML documents in OpenSIPS script, stable
  • CFGUTILS - Various utility functions, stable
  • EXEC - External exec module , stable
  • TEXTOPS - Text operations module, stable
  • AVPOPS - renamed, see SQLops module
  • SQLOPS - SQL DB operations module stable
  • REGEX - RegExp via PCRE library, stable
  • MATHOPS - Floating point and rounding operations, stable
  • BENCHMARK - Script file benchmarking, stable
  • CARRIERROUTE - routing extension suitable for carriers , stable
  • GFLAGS - Global shared flags module, stable
  • PYTHON - Python scripting support, stable
  • LUA - Call LUA scripts from OpenSIPS cfg, stable
  • PERL - embed execution of Perl function , stable
  • MMGEOIP - MaxMind GeoIP module, stable
  • UUID - UUID generation, stable

2.2  Auth modules

  • AUTH_AAA - AAA-backend authentication module, stable
  • AUTH - Authentication Framework module, stable
  • AUTH_DB -Database-backend authentication module, stable
  • AUTH_JWT -Authentication over JSON Web Tokens, alpha
  • AUTH_AKA - Authentication using RFC 3310 AKA mechanism, alpha
  • AKA_AV_DIAMETER - Fetches RFC 3310 AKA AVs using Cx/Dx Diameter interface, alpha
  • PERMISSIONS - Permissions control module , stable

2.3  Accounting & Billing modules

  • ACC - Accounting module, stable
  • CALL CONTROL - PrePaid application module , stable
  • CGRATES - Connector to the CGRateS billing engine, stable

2.4  Dialplan Modules

  • ALIAS_DB - Database SIP aliases module, stable
  • DIALPLAN - Dialplan management , stable
  • DOMAIN - Multi-domain support module , stable
  • DOMAINPOLICY - Policies to connect federations , stable
  • GROUP - User-groups module with DB-backend , stable
  • USERBLACKLIST - User black/white listing , stable
  • SPEEDDIAL - Per-user speed-dial controller module , stable
  • PEERING - Radius peering module , stable

2.5  Data caching

  • DNS_CACHE - Module for caching DNS records that can be used with any Key-Value back-end , stable
  • USRLOC - User location implementation module , stable
  • SQL_CACHER - SQL Caching module, stable
  • RATE_CACHER - Cache, Query, Reload or Update rates via MI, alpha

2.6  Traffic shaping module

  • PIKE - Flood detector module , stable
  • QOS - QOS (RTP) module , stable
  • RATELIMIT - SIP traffic shaping module , stable
  • FRAUD_DETECTION - Detects fraudulent calls, stable

3.  Database modules

3.1  SQL modules

  • DB_BERKELEY - Berkeley DB driver for DB API , stable
  • DB_CACHEDB - SQL to CacheDB translator , stable
  • DB_FLATSTORE - Fast writing-only text-backend for database module , stable
  • DB_HTTP - HTTP-backend for DB API , stable
  • DB_MYSQL - MYSQL-backend for database API module , stable
  • DB_ORACLE - ORACLE-backend for database API module , stable
  • DB_PERLVDB - Perl Virtual Database engine , stable
  • DB_POSTGRES - POSTGRES-backend for database API module , stable
  • DB_SQLITE - SQLITE3-backend for database API module , beta
  • DB_TEXT - Text-backend for database API module , stable
  • DB_UNIXODBC - unixODBC driver module , stable
  • DB_VIRTUAL - Middle-layer DB mixer, stable

3.2  noSQL modules


4.  External Integration modules

4.1  OpenSIPS API modules

  • EVENT_DATAGRAM - Publish JSON-RPC notifications using UDP, stable
  • EVENT_FLATSTORE - Text/File backend for events, stable
  • EVENT_KAFKA - Publish JSON-RPC notifications/generic messages to Apache Kafka , alpha
  • EVENT_STREAM - Publish JSON-RPC notifications using TCP, beta
  • EVENT_ROUTE - Route triggering based on events, stable
  • EVENT_ROUTING - Event-based routing, stable
  • EVENT_RABBITMQ - Publish JSON-RPC notifications using AMQP over TCP , stable
  • EVENT_VIRTUAL - Aggregator of event backends (failover & balancing), stable
  • EVENT_XMLRPC - Event XMLRPC client module , stable
  • MI_DATAGRAM - DATAGRAM (unix and network) support for Management Interface , stable
  • MI_FIFO - FIFO support for Management Interface , stable
  • MI_HTML - Minimal web GUI for Management Interface , stable
  • MI_HTTP - HTTP support for Management Interface , stable
  • MI_SCRIPT - support for running Management Interface commands in script , alpha
  • MI_XMLRPC_NG - XMLRPC support for Management Interface , stable
  • HTTPD - Embedded HTTP server , stable
  • PI_HTTP - Provisioning Interface module , stable
  • RABBITMQ - Connector to a RabbitMQ message broker, stable
  • RABBITMQ_CONSUMER - Connect to RabbitMQ and receive events, stable
  • STATISTICS - Script statistics support , stable
  • STATUS_REPORT - Script Status/Report identifiers support , stable

4.2  Media Relays

  • MEDIAPROXY - NAT traversal module , stable
  • MSRP_RELAY - Implementation of a Relay for the MSRP protocol , alpha
  • RTPENGINE - Connector to RTPengine external RTP relay , stable
  • RTPPROXY - Connector to RTPproxy external RTP relay, stable
  • RTP_RELAY - Interface for different RTP relay engines, alpha

4.3  External integration (non-SIP protocols)

  • AAA_DIAMETER - Diameter backend for the AAA API, alpha
  • AAA_RADIUS - RADIUS backend for the AAA API, stable
  • FREESWITCH - FreeSWITCH ESL connection manager, stable
  • FREESWITCH_SCRIPTING - FreeSWITCH events & commands at OpenSIPS script level, stable
  • H350 - H350 implementation , stable
  • HTTP2D - Programmable HTTP/2 Server, beta
  • JSONRPC - Execute JSON-RPC commands, beta
  • LAUNCH_DARKLY - Launch Darkly integration, alpha
  • LDAP - LDAP connector , stable
  • PROMETHEUS - export statistics to a Prometheus server, alpha
  • REST_CLIENT - Implementation of an HTTP client , stable
  • SEAS - Sip Express Application Server (interface module) , stable
  • SIPCAPTURE - SipCapture module , stable
  • SIPREC - SIP Recording module , stable
  • TRACER - Collects SIP, logs, DNS or REST queries and ships them to various backends , stable
  • SNGTC - Voice Transcoding in OpenSIPS using Sangoma hardware , stable
  • SNMPStats - SNMP interface for statistics module , stable
  • STUN - Built-in STUN server , stable -
  • XMPP - SIP-to-XMPP Gateway (SIP to Jabber/Google Talk) , stable

5.  OpenSIPS protocols and infrastructure

  • CLUSTERER - Define and configure an OpenSIPS cluster, stable
  • TLS_MGM - TLS management module , stable
  • TLS_OPENSSL - TLS operations implemented using the openSSL library , stable
  • TLS_WOLFSSL - TLS operations implemented using the wolfSSL library , alpha
  • TCP_MGM - TCP connections management module , alpha
  • PROTO_BIN - Binary INterface protocol module - implements inter-OPENSIPS communication , stable
  • PROTO_BINS - Binary INterface over TLS protocol module - implements Secure inter-OPENSIPS communication , alpha
  • PROTO_HEP - HEP protocol module - implements HEP transport for SIP , stable
  • PROTO_MSRP - implements MSRP protocol stack, alpha
  • PROTO_SCTP - SCTP protocol module - implements SCTP transport for SIP , stable
  • PROTO_TCP - TCP protocol module - implements TCP-plain transport for SIP , stable
  • PROTO_TLS - TLS protocol module - implements TLS transport for SIP , stable
  • PROTO_UDP - UDP protocol module - implements UDP-plain transport for SIP , stable
  • PROTO_WS - WebSocket protocol module - implements WS transport for SIP , stable
  • PROTO_WSS - WebSocket Secure protocol module - implements WSS transport for SIP , stable
  • PROTO_SMPP - SMPP (Short Message Peer-to-Peer) protocol module - implements transport for SMPP messages, beta

Page last modified on March 28, 2024, at 12:02 PM