mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
141 lines
3.1 KiB
141 lines
3.1 KiB
app_python Module
|
|
|
|
Maxim Sobolev
|
|
|
|
Edited by
|
|
|
|
Maxim Sobolev
|
|
|
|
Copyright © 2010 Maxim Sobolev
|
|
__________________________________________________________________
|
|
|
|
Table of Contents
|
|
|
|
1. Admin Guide
|
|
|
|
1. Overview
|
|
2. Dependencies
|
|
|
|
2.1. Kamailio Modules
|
|
2.2. External Libraries or Applications
|
|
|
|
3. Parameters
|
|
|
|
3.1. script_name (string)
|
|
3.2. mod_init_function (string)
|
|
3.3. child_init_method (string)
|
|
|
|
4. Functions
|
|
|
|
4.1. python_exec(method [, args])
|
|
|
|
List of Examples
|
|
|
|
1.1. Set script_name parameter
|
|
1.2. Set mod_init_function parameter
|
|
1.3. Set child_init_method parameter
|
|
1.4. python_exec usage
|
|
|
|
Chapter 1. Admin Guide
|
|
|
|
Table of Contents
|
|
|
|
1. Overview
|
|
2. Dependencies
|
|
|
|
2.1. Kamailio Modules
|
|
2.2. External Libraries or Applications
|
|
|
|
3. Parameters
|
|
|
|
3.1. script_name (string)
|
|
3.2. mod_init_function (string)
|
|
3.3. child_init_method (string)
|
|
|
|
4. Functions
|
|
|
|
4.1. python_exec(method [, args])
|
|
|
|
1. Overview
|
|
|
|
This module allows executing Python scripts from config file, exporting
|
|
functions to access the SIP message from Python.
|
|
|
|
For some basic examples of Python scripts that can be used with this
|
|
module, look at the files inside source tree located at
|
|
'modules/app_python/python_examples/'.
|
|
|
|
2. Dependencies
|
|
|
|
2.1. Kamailio Modules
|
|
2.2. External Libraries or Applications
|
|
|
|
2.1. Kamailio Modules
|
|
|
|
The following modules must be loaded before this module:
|
|
* none.
|
|
|
|
2.2. External Libraries or Applications
|
|
|
|
The following libraries or applications must be installed before
|
|
running Kamailio with this module loaded:
|
|
* python-dev - Python devel library.
|
|
|
|
3. Parameters
|
|
|
|
3.1. script_name (string)
|
|
3.2. mod_init_function (string)
|
|
3.3. child_init_method (string)
|
|
|
|
3.1. script_name (string)
|
|
|
|
The path to the fiel with Python code to be executed from configuration
|
|
file.
|
|
|
|
Default value is “/usr/local/etc/kamailio/handler.py”.
|
|
|
|
Example 1.1. Set script_name parameter
|
|
...
|
|
modparam("app_python", "script_name", "/usr/local/etc/kamailio/myscript.py")
|
|
...
|
|
|
|
3.2. mod_init_function (string)
|
|
|
|
The Python function to be executed by this module when it is initialied
|
|
by Kamailio.
|
|
|
|
Default value is “mod_init”.
|
|
|
|
Example 1.2. Set mod_init_function parameter
|
|
...
|
|
modparam("app_python", "mod_init_function", "my_mod_init")
|
|
...
|
|
|
|
3.3. child_init_method (string)
|
|
|
|
The Python function to be executed by this module when a new worker
|
|
process (child) is initialied by Kamailio.
|
|
|
|
Default value is “child_init”.
|
|
|
|
Example 1.3. Set child_init_method parameter
|
|
...
|
|
modparam("app_python", "child_init_method", "my_child_init")
|
|
...
|
|
|
|
4. Functions
|
|
|
|
4.1. python_exec(method [, args])
|
|
|
|
4.1. python_exec(method [, args])
|
|
|
|
Execute the Python function with the name given by the parameter
|
|
'method'. Optionally can be provided a second string with parameters to
|
|
be passed to the Python function.
|
|
|
|
Example 1.4. python_exec usage
|
|
...
|
|
python_exec("my_python_function");
|
|
python_exec("my_python_function", "my_params");
|
|
...
|