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.
kamailio/obsolete/avp_radius/doc/functions.xml

48 lines
1.7 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="avp_radius.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>Functions</title>
<section id="avp_load_radius">
<title><function>avp_load_radius(user)</function></title>
<para>
The functions loads user's attributes from radius and stores them
into AVPs. Parameter "user" is used to indicate, whose attributes
are loaded. Possible values are "caller", "caller_from_ruri",
"callee", and "digest".
</para>
<para>
In "caller" case, attributes belong to the user of the From URI, in
"callee" case, to the user of the Request URI, and, in "digest"
case, to the authenticated user.
</para>
<para>
The "caller_from_uri" case loads attribute value pairs defined for
caller (default SER-Caller-AVPs), but uses the user in the Request
URI. This is useful for the case where a call has been forwarded
by callee (Request URI) and you need to look up whether callee
is allowed to forward the call to ex. PSTN or if the call should be
anonymous (i.e. not show info about who diverted the call).
</para>
<para>
AVP name returned from Radius is prefixed by string "caller_", if
avp_load_radius parameter is "caller" or "digest", and by
"callee_", if parameter is "callee".
</para>
<example>
<title><function>avp_load_radius</function> usage</title>
<programlisting>
...
avp_load_radius("callee")
...
</programlisting>
</example>
</section>
</section>