AVPOPS module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”AVPops (AVP-operations) modules implements a set of script functions which allow access and manipulation of user AVPs (preferences) and pseudo-variables. AVPs are a powerful tool for implementing services/preferences per user/domain. Now they are usable directly from configuration script. Functions for interfacing DB resources (loading/storing/removing), functions for swapping information between AVPs and SIP messages, function for testing/checking the value of an AVP.
AVPs are persistent per SIP transaction, being available in “route”, “branch_route” and “failure_route”. To make them available in “onreply_route” armed via TM module, set “onreply_avp_mode” parameter of TM module (note that in the default “onreply_route”, the AVPs of the transaction are not available).
An up-to-date tutorial providing more information (detailed explanations and commented examples) can be found on Voice Sistem documentation web page at http://voice-system.ro/docs/avpops .
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- Optionally a database module
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- None
AVP naming format
Section titled “AVP naming format”The format of the parameters specifying an AVP in functions exported by this module is: $avp(avp_flags:avp_name) or $avp(avp_alias).
- avp_flags = type_flags [script_flags]; type_flags = ‘I’ | ‘i’ | ‘S’ | ‘s’; script_flags = 0..255 ‘I’ or ‘i’ means that the type of avp name is integer (ID) ‘S’ or ‘s’ means that the type of avp name is string The type flag is mandatory. script_flags must be an 8 bit unsigned number, therefore can be set up to 8 flags. If no script flag is provided, the name will match all AVPs, regardless they have or not a script flag set (preserves the compatibility with the old naming schema).
- avp_name = string | integer string - might be any alphanumeric string, wich contain following characters: [a-z] [A-Z] [0-9] ’_’ integer - might be an unsigned integer, greater than zero, up to 2^16-1
- avp_alias = string string - might be any alphanumeric string, wich contain following characters: [a-z] [A-Z] [0-9] ’_‘
...$avp(i:11) - the AVP identified by integer 11$avp(s:foo) - the AVP identified by the string 'foo'$avp(bar) - the AVP identified by the AVP alias 'bar'$avp(i3:123) - the AVP identified by the integer 123 which has script flags 1 and 2 set...Exported Parameters
Section titled “Exported Parameters”avp_url (string)
Section titled “avp_url (string)”DB URL for database connection.
This parameter is optional, it’s default value being NULL.
...modparam("avpops","avp_url","mysql://user:passwd@host/database")...db_url (string)
Section titled “db_url (string)”This parameter has the same meaning as “avp_url” parameter.
avp_table (string)
Section titled “avp_table (string)”DB table to be used.
This parameter is optional, it’s default value being NULL.
...modparam("avpops","avp_table","avptable")...use_domain (integer)
Section titled “use_domain (integer)”If the domain part of the an URI should be used for identifying an AVP in DB operations.
Default value is 0 (no).
...modparam("avpops","use_domain",1)...uuid_column (string)
Section titled “uuid_column (string)”Name of column containing the uuid (unique user id).
Default value is “uuid”.
...modparam("avpops","uuid_column","uuid")...username_column (string)
Section titled “username_column (string)”Name of column containing the username.
Default value is “username”.
...modparam("avpops","username_column","username")...domain_column (string)
Section titled “domain_column (string)”Name of column containing the domain name.
Default value is “domain”.
...modparam("avpops","domain_column","domain")...attribute_column (string)
Section titled “attribute_column (string)”Name of column containing the attribute name (AVP name).
Default value is “attribute”.
...modparam("avpops","attribute_column","attribute")...value_column (string)
Section titled “value_column (string)”Name of column containing the AVP value.
Default value is “value”.
...modparam("avpops","value_column","value")...type_column (string)
Section titled “type_column (string)”Name of column containing the AVP type.
Default value is “type”.
...modparam("avpops","type_column","type")...db_scheme (string)
Section titled “db_scheme (string)”Definition of a DB scheme to be used for non-standard access to Database information.
Definition of a DB scheme. Scheme syntax is:
-
db_scheme = name’:‘element[’;‘element]*
-
element =
'uuid_col='string'username_col='string'domain_col='string'value_col='string'value_type='('integer'|'string')'table='string
Default value is “NULL”.
...modparam("avpops","db_scheme","scheme1:table=subscriber;uuid_col=uuid;value_col=first_name")...Exported Functions
Section titled “Exported Functions”avp_db_load(source,name)
Section titled “avp_db_load(source,name)”Loads from DB into memory the AVPs corresponding to the given source. If given, it sets the script flags for loaded AVPs. It returns true if it loaded some values in AVPs, false otherwise (db error, no avp loaded …).
Meaning of the parameters is as follows:
-
source - what info is used for identifying the AVPs. Parameter syntax:
*source = (pvar|str_value)['/'('username'|'domain'|'uri'|'uuid')])**pvar = any pseudo variable defined in OpenSIPS. Ifthe pvar is $ru (request uri), $fu (from uri), $tu (to uri)or $ou (original uri), then the implicit flag is 'uri'.Otherwise, the implicit flag is 'uuid'.* -
name - which AVPs will be loaded from DB into memory. Parameter syntax is:
*name = avp_spec['/'(table_name|'$'db_scheme)]**avp_spec = matching_flags|$avp(avp_name)|$avp(avp_alias)**matching_flags = 'a' | 'A' | 'i' | 'I' | 's' | 'S'[script_flags]*'a' or 'A' means matching any ofAVP name types ('i' and 's'), the rest have themeaning descriped in 'AVP naming format' chapter.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_db_load("$fu","$avp(i:678)");avp_db_load("$ru/domain","i/domain_preferences");avp_db_load("$avp(s:uuid)","$avp(s:404fwd)/fwd_table");avp_db_load("$ru","$avp(i:123)/$some_scheme");...avp_db_store(source,name)
Section titled “avp_db_store(source,name)”Stores to DB the AVPs corresponding to the given source.
The meaning and usage of the parameters are identical as for avp_db_load(source,name) function. Please refer to its description.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_db_store("$tu","$avp(i:678)");avp_db_store("$ru/username","$avp(email)");...avp_db_delete(source,name)
Section titled “avp_db_delete(source,name)”Deletes from DB the AVPs corresponding to the given source.
The meaning and usage of the parameters are identical as for avp_db_load(source,name) function. Please refer to its description.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_db_delete("$tu","$avp(i:678)");avp_db_delete("$ru/username","$avp(email)");avp_db_delete("$avp(s:uuid)","$avp(s:404fwd)/fwd_table");...avp_db_query(query[,dest])
Section titled “avp_db_query(query[,dest])”Make a database query and store the result in AVPs.
The meaning and usage of the parameters:
- query - must be a valid SQL query. The parameter can contain pseudo-variables. You must escape any pseudo-variables manually to prevent SQL injection attacks. You can use the existing transformations escape.common and unescape.common to escape and unescape the content of any pseudo-variable. Failing to escape the variables used in the query makes you vulnerable to SQL injection, e.g. make it possible for an outside attacker to alter your database content.
- dest - a list with AVP names where to store the result. The format is “$avp(name1);$avp(name2);…”. If this parameter is ommited, the result is stored in “$avp(i:1);$avp(i:2);…”. If the result gives many rows, then multiple AVPs with corresponding name will be added. The value type of the AVP (string or integer) will be derived from the type of the columns.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_db_query("select password, ha1 from subscriber where username='$tu'", "$avp(i:678);$avp(i:679)");avp_db_query("delete from subscriber");...avp_delete(name)
Section titled “avp_delete(name)”Deletes from memory the AVPs with name or, if empty, all AVPs.
Meaning of the parameters is as follows:
-
name - which AVPs will be deleted from memory. Parameter syntax is:
*name = (matching_flags|avp_name|avp_alias)['/'flag]**matching_flags = please refer to avp_db_load() function**flag = 'g'|'G'*
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_delete("$avp(i:678)/g");avp_delete("$avp(email)");avp_delete("i");avp_delete("a3");...avp_pushto(destination,name)
Section titled “avp_pushto(destination,name)”Pushes the value of AVP(s) into the SIP message.
Meaning of the parameters is as follows:
-
destination - as what will be the AVP value pushed into SIP message. Parameter syntax:
*destination = '$ru' ['/'('username'|'domain')] | '$du' |'$br'**$ru '['/'('username'|'domain')] - write the AVP in therequest URI or in username/domain part of it**$du - write the AVP in 'dst_uri' field**$br - write the AVP directly as a new branch (does notaffect RURI)* -
name - which AVP(s)/pseudo-variable should be pushed into the SIP message. Parameter syntax is:
*name = ( avp_name | avp_alias | pvar_name )['/'flags]**flags = 'g' - effective only with AVPs*
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_pushto("$ru/domain","$fd");avp_pushto("$ru","$avp(i:678)");avp_pushto("$ru/domain","$avp(s:backup_domains)/g");avp_pushto("$du","$avp(i:679)");avp_pushto("$br","$avp(i:680)");...avp_check(name,op_value)
Section titled “avp_check(name,op_value)”Checks the value of the AVP(s) against an operator and value.
Meaning of the parameters is as follows:
-
name - which AVP(s) should be checked. Parameter syntax is:
*name = ( pseudo-variable )* -
op_value - define the operator, the value and flags for checking. Parameter syntax is:
-
op_value = operator ’/’ value [’/‘flags]
-
operator = ‘eq’ | ‘ne’ | ‘lt’ | ‘le’ | ‘gt’ | ‘ge’ | ‘re’ | ‘fm’ | ‘and’ | ‘or’ | ‘xor’
-
value = pseudo-variable | fix_value
-
fix_value = ‘i:‘integer | ‘s:‘string | string
-
flags = ‘g’ | ‘G’ | ‘i’ | ‘I’ Operator meaning:
-
eq - equal
-
ne - not equal
-
lt - less than
-
le - less or equal
-
gt - greater than
-
ge - greater or equal
-
re - regexp (regular exression match)
-
fm - fast match (see: man fnmatch)
-
and - bitwise ‘and’
-
or - bitwise ‘or’
-
xor - bitwise ‘xor’ Integer values can be given in hexadecimal using notation: ‘i:0xhex_number’ (e.g.,: ‘i:0xabcd’);
-
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_check("$avp(i:678)", "lt/i:345/g");avp_check("$fd","eq/$td/I");avp_check("$avp(s:foo)","gt/$avp($bar)/g");avp_check("$avp(s:foo)","re/sip:.*@bar.net/g");avp_check("$avp(s:foo)","fm/$avp(fm_avp)/g");...avp_copy(old_name,new_name)
Section titled “avp_copy(old_name,new_name)”Copy / move an avp under a new name.
Meaning of the parameters is as follows:
-
name1 - which AVP(s) should be copied/moved. Parameter syntax is:
*name = ( avp_name | avp_alias )* -
name2 - the new name of the copied/moved AVP(s). Parameter syntax is:
*name = ( avp_name | avp_alias ) ['/'flags]**flags = 'g' | 'G' | 'd' | 'D' | 'n' | 'N' | 's' | 'S'*
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_copy("$avp(i:678)", "$avp(s:345)/g");avp_copy("$avp(old)","$avp(new)/gd");...avp_printf(dest, format)
Section titled “avp_printf(dest, format)”NOTE: since OpenSIPS 1.3.0 the function has been moved to core and it is an alias to pv_printf().
Prints the formatted string ‘format’ in the AVP ‘dest’. The ‘format’ parameter can include any pseudo-variable defined in OpenSIPS. The list with all pseudo-variables in OpenSIPS can be found at: http://opensips.org/dokuwiki/.
Meaning of the parameters is as follows:
-
dest - in which AVP should be stored the result. Parameter syntax is:
- name = ( avp_name | avp_alias )
-
format - the formatted string to be printed in ‘dest’ AVP.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_printf("$avp(i:20)", "This is a $rm request with call-id $hdr(call-id)");...avp_subst(avps, subst)
Section titled “avp_subst(avps, subst)”Perl/sed-like subst applied to AVPs having string value.
Meaning of the parameters is as follows:
-
avps - source AVP, destination AVP and flags. Parameter syntax is:
*avps = src_avp [ '/' dst_avp [ '/' flags ] ]**src_avp = ( avp_name | avp_alias )**dst_avp = ( avp_name | avp_alias ) - if dst_avp is missingthen the value of src_avp will be replaced**flags = ( d | D | g | G ) -- (d, D - delete source avp;g, G - apply to all avps matching src_avp name)* -
subst - perl/sed-like reqular expression. Parameter syntax is:
*subst = "/regexp/replacement/flags"**regexp - regular expression**replacement - replacement string, can includepseudo-variables and \1, ..., \9 for matching tokens,\0 for whole matching text**flags = 'g' | 'G' | 'i' | 'i' (g, G - replace allmatching tokens; i, I - match ignore case)*
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...# if avp i:678 has a string value in e-mail format, replace the# domain part with the value of domain part from R-URIavp_subst("$avp(i:678)", "/(.*)@(.*)/\1@$rd/");
# if any avp i:678 has a string value in e-mail format, replace the# domain part with the value of domain part from R-URI# and place the result in avp i:679avp_subst("$avp(i:678)/$avp(i:679)/g", "/(.*)@(.*)/\1@$rd/");...IMPORTANT NOTE: if the replacement string includes src_avp or dst_avp you will get something that you may not expect. In case you have many src_avp and you make the substitution to be applied to all of them, after the first src_avp is processed, it will be added in avp list and next processing will use it.
avp_op(name,op_value)
Section titled “avp_op(name,op_value)”Different integer operations with avps.
Meaning of the parameters is as follows:
-
name - ‘source_avp/destination_avp’ - which AVP(s) should be processed and where to store the result. If ‘destination_avp’ is missing, same name as ‘source_avp’ is used to store the result. Parameter syntax is:
- name = ( source_avp[/destination_avp] ) source_avp = ( avp_name | avp_alias ) destination_avp = ( avp_name | avp_alias )
-
op_value - define the operation, the value and flags. Parameter syntax is:
*op_value = operator '/' value ['/'flags]**operator = 'add' | 'sub' | 'mul' | 'div' | 'mod'| 'and' | 'or' | 'xor' | 'not'**value = pseudo-variable | fix_value**fix_value = 'i:'integer**flags = 'g' | 'G' | 'd' | 'D'*
Integer values can be given in hexadecimal using notation ‘i:0xhex_number’ (e.g.,: ‘i:0xabcd’);
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_op("$avp(i:678)", "add/i:345/g");avp_op("$avp(number)","sub/$avp(number2)/d");...is_avp_set(name)
Section titled “is_avp_set(name)”Check if any AVP with name is set.
Meaning of the parameters is as follows:
-
name - name of AVP to look for. Parameter syntax is:
*name = avp_name|avp_alias [ '/' flags ])**flags = ('e'|'s'|'n') - e = empty value; s = value string;n = value number (int)*
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...if(is_avp_set("$avp(i:678)")) log("AVP with integer id 678 exists\n");...avp_print()
Section titled “avp_print()”Prints the list with all the AVPs from memory. This is only a helper/debug function.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
...avp_print();...Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Daniel-Constantin Mierla (@miconda) | 111 | 44 | 3163 | 2394 |
| 2. | Elena-Ramona Modroiu | 54 | 11 | 4111 | 461 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | 52 | 34 | 599 | 683 |
| 4. | Elena-Ramona Modroiu | 18 | 5 | 1063 | 204 |
| 5. | Stefan Darius (@dariusstefan) | 14 | 3 | 940 | 142 |
| 6. | Henning Westerholt (@henningw) | 12 | 8 | 114 | 135 |
| 7. | Andrei Pelinescu-Onciul | 6 | 4 | 23 | 20 |
| 8. | Klaus Darilion | 4 | 2 | 4 | 2 |
| 9. | Olle E. Johansson | 3 | 1 | 5 | 5 |
| 10. | Razvan Crainea (@razvancrainea) | 3 | 1 | 2 | 2 |
All remaining contributors: Konstantin Bokarius, Norman Brandinger (@NormB), Andreas Granig, Edson Gellert Schubert.
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2026 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jun 2005 - Dec 2008 |
| 4. | Henning Westerholt (@henningw) | Aug 2007 - Jul 2008 |
| 5. | Olle E. Johansson | Jun 2008 - Jun 2008 |
| 6. | Daniel-Constantin Mierla (@miconda) | Jun 2005 - Mar 2008 |
| 7. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 8. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
| 9. | Elena-Ramona Modroiu | Jun 2005 - Oct 2007 |
| 10. | Klaus Darilion | Feb 2007 - Mar 2007 |
All remaining contributors: Norman Brandinger (@NormB), Andreas Granig, Andrei Pelinescu-Onciul, Elena-Ramona Modroiu.
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Henning Westerholt (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Klaus Darilion, Andrei Pelinescu-Onciul, Elena-Ramona Modroiu.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0