mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 19:28:53 +00:00
3fc90e7810
* Do a git blame on the embedded XML managerEvent elements.
* From the commit hash, grab the summary line.
* Do a git log --grep <summary> to find the cherry-pick commits in all
branches that match.
* Do a git patch-id to ensure the commits are all related and didn't get
a false match on the summary.
* Do a git tag --contains <commit> to find the tags that contain each
commit.
* Weed out all tags not ..0.
* Sort and discard any .0.0 and following tags where the commit
appeared in an earlier branch.
* The result is a single tag for each branch where the application or function
was defined.
The events defined in res/res_pjsip/pjsip_manager.xml were done by hand
because the XML was extracted from the C source file relatively recently.
Two bugs were fixed along the way...
* The get_documentation awk script was exiting after it processed the first
DOCUMENTATION block it found in a file. We have at least 1 source file
with multiple DOCUMENTATION blocks so only the first one in them was being
processed. The awk script was changed to continue searching rather
than exiting after the first block.
* Fixing the awk script revealed an issue in logger.c where the third
DOCUMENTATION block contained a XML fragment that consisted only of
a managerEventInstance element that wasn't wrapped in a managerEvent
element. Since logger_doc.xml already existed, the remaining fragments
in logger.c were moved to it and properly organized.
(cherry picked from commit 2897d87a99)
938 lines
55 KiB
XML
938 lines
55 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
|
|
<?xml-stylesheet type="text/xsl" href="appdocsxml.xslt"?>
|
|
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<manager name="PJSIPQualify" language="en_US">
|
|
<since>
|
|
<version>12.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Qualify a chan_pjsip endpoint.
|
|
</synopsis>
|
|
<syntax>
|
|
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
|
|
<parameter name="Endpoint" required="true">
|
|
<para>The endpoint you want to qualify.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Qualify a chan_pjsip endpoint.</para>
|
|
</description>
|
|
</manager>
|
|
<managerEvent language="en_US" name="IdentifyDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>13.20.0</version><version>15.3.0</version></since>
|
|
<synopsis>Provide details about an identify section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'identify'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Endpoint">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='endpoint']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SrvLookups">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='srv_lookups']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Match">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='match']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MatchHeader">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='match_header']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="EndpointName">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="AorDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>13.12.0</version><version>14.1.0</version></since>
|
|
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'aor'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="MinimumExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='minimum_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MaximumExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='maximum_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DefaultExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='default_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="QualifyFrequency">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='qualify_frequency']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AuthenticateQualify">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='authenticate_qualify']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MaxContacts">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='max_contacts']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RemoveExisting">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_existing']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RemoveUnavailable">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_unavailable']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Mailboxes">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OutboundProxy">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SupportPath">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='support_path']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TotalContacts">
|
|
<para>The total number of contacts associated with this AoR.</para>
|
|
</parameter>
|
|
<parameter name="ContactsRegistered">
|
|
<para>The number of non-permanent contacts associated with this AoR.</para>
|
|
</parameter>
|
|
<parameter name="EndpointName">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="AuthDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.0.0</version></since>
|
|
<synopsis>Provide details about an authentication section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'auth'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Username">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Password">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Md5Cred">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='md5_cred']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Realm">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='realm']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="NonceLifetime">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='nonce_lifetime']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AuthType">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='auth_type']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="EndpointName">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="TransportDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.6.0</version></since>
|
|
<synopsis>Provide details about an authentication section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'transport'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Protocol">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='protocol']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Bind">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='bind']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AsycOperations">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='async_operations']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CaListFile">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='ca_list_file']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CaListPath">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='ca_list_path']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CertFile">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cert_file']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="PrivKeyFile">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='priv_key_file']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Password">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='password']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ExternalSignalingAddress">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_signaling_address']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ExternalSignalingPort">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_signaling_port']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ExternalMediaAddress">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_media_address']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Domain">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='domain']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="VerifyServer">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='verify_server']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="VerifyClient">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='verify_client']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RequireClientCert">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='require_client_cert']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Method">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='method']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Cipher">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cipher']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="LocalNet">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='local_net']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Tos">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='tos']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Cos">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cos']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="WebsocketWriteTimeout">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='websocket_write_timeout']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="EndpointName">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="EndpointDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.0.0</version></since>
|
|
<synopsis>Provide details about an endpoint section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'endpoint'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Context">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='context']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Disallow">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='disallow']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Allow">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtmfMode">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtmf_mode']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RtpIpv6">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_ipv6']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RtpSymmetric">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_symmetric']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="IceSupport">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='ice_support']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="UsePtime">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='use_ptime']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ForceRport">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='force_rport']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RewriteContact">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rewrite_contact']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Transport">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='transport']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OutboundProxy">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MohSuggest">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='moh_suggest']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="100rel">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='100rel']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Timers">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TimersMinSe">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers_min_se']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TimersSessExpires">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers_sess_expires']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Auth">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='auth']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OutboundAuth">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='outbound_auth']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Aors">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='aors']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MediaAddress">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_address']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="IdentifyBy">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='identify_by']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DirectMedia">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DirectMediaMethod">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media_method']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TrustConnectedLine">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_connected_line']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SendConnectedLine">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_connected_line']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ConnectedLineMethod">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='connected_line_method']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DirectMediaGlareMitigation">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media_glare_mitigation']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DisableDirectMediaOnNat">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='disable_direct_media_on_nat']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Callerid">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CalleridPrivacy">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid_privacy']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CalleridTag">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid_tag']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TrustIdInbound">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_id_inbound']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TrustIdOutbound">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_id_outbound']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SendPai">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_pai']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SendRpid">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_rpid']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SendDiversion">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_diversion']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Mailboxes">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AggregateMwi">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='aggregate_mwi']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MediaEncryption">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_encryption']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MediaEncryptionOptimistic">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_encryption_optimistic']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="UseAvpf">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='use_avpf']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ForceAvp">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='force_avp']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MediaUseReceivedTransport">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_use_received_transport']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OneTouchRecording">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='one_touch_recording']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="InbandProgress">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='inband_progress']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CallGroup">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='call_group']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="PickupGroup">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='pickup_group']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="NamedCallGroup">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='named_call_group']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="NamedPickupGroup">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='named_pickup_group']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DeviceStateBusyAt">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='device_state_busy_at']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38Udptl">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38UdptlEc">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_ec']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38UdptlMaxdatagram">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_maxdatagram']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="FaxDetect">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='fax_detect']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38UdptlNat">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_nat']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38UdptlIpv6">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_ipv6']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="T38BindUdptlToMediaAddress">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_bind_udptl_to_media_address']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="ToneZone">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tone_zone']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Language">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='language']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RecordOnFeature">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='record_on_feature']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RecordOffFeature">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='record_off_feature']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AllowTransfer">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_transfer']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="UserEqPhone">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='user_eq_phone']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MohPassthrough">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='moh_passthrough']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SdpOwner">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sdp_owner']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SdpSession">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sdp_session']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TosAudio">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tos_audio']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="TosVideo">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tos_video']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CosAudio">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='cos_audio']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="CosVideo">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='cos_video']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AllowSubscribe">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_subscribe']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SubMinExpiry">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sub_min_expiry']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="FromUser">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='from_user']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="FromDomain">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='from_domain']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MwiFromUser">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='mwi_from_user']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RtpEngine">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_engine']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsVerify">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_verify']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsRekey">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_rekey']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsCertFile">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_cert_file']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsPrivateKey">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_private_key']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsCipher">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_cipher']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsCaFile">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_ca_file']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsCaPath">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_ca_path']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DtlsSetup">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_setup']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SrtpTag32">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='srtp_tag_32']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RedirectMethod">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='redirect_method']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SetVar">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='set_var']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MessageContext">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='message_context']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Accountcode">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='accountcode']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="PreferredCodecOnly">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='preferred_codec_only']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DeviceState">
|
|
<para>The aggregate device state for this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="ActiveChannels">
|
|
<para>The number of active channels associated with this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="SubscribeContext">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='subscribe_context']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Allowoverlap">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_overlap']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OverlapContext">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='overlap_context']/synopsis/node())"/></para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="AorList">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'aor'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="MinimumExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='minimum_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MaximumExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='maximum_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="DefaultExpiration">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='default_expiration']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="QualifyFrequency">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='qualify_frequency']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AuthenticateQualify">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='authenticate_qualify']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="MaxContacts">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='max_contacts']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RemoveExisting">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_existing']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="RemoveUnavailable">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_unavailable']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Mailboxes">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="OutboundProxy">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="SupportPath">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='support_path']/synopsis/node())"/></para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="AuthList">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide details about an Address of Record (Auth) section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'auth'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Username">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Md5Cred">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='md5_cred']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Realm">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='realm']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="AuthType">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='auth_type']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="Password">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='password']/synopsis/node())"/></para>
|
|
</parameter>
|
|
<parameter name="NonceLifetime">
|
|
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='nonce_lifetime']/synopsis/node())"/></para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ContactList">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide details about a contact section.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'contact'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="ViaAddr">
|
|
<para>IP address of the last Via header in REGISTER request.
|
|
Will only appear in the event if available.</para>
|
|
</parameter>
|
|
<parameter name="ViaPort">
|
|
<para>Port number of the last Via header in REGISTER request.
|
|
Will only appear in the event if available.</para>
|
|
</parameter>
|
|
<parameter name="QualifyTimeout">
|
|
<para>The elapsed time in decimal seconds after which an OPTIONS
|
|
message is sent before the contact is considered unavailable.</para>
|
|
</parameter>
|
|
<parameter name="CallId">
|
|
<para>Content of the Call-ID header in REGISTER request.
|
|
Will only appear in the event if available.</para>
|
|
</parameter>
|
|
<parameter name="RegServer">
|
|
<para>Asterisk Server name.</para>
|
|
</parameter>
|
|
<parameter name="PruneOnBoot">
|
|
<para>If true delete the contact on Asterisk restart/boot.</para>
|
|
</parameter>
|
|
<parameter name="Path">
|
|
<para>The Path header received on the REGISTER.</para>
|
|
</parameter>
|
|
<parameter name="Endpoint">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
<parameter name="AuthenticateQualify">
|
|
<para>A boolean indicating whether a qualify should be authenticated.</para>
|
|
</parameter>
|
|
<parameter name="Uri">
|
|
<para>This contact's URI.</para>
|
|
</parameter>
|
|
<parameter name="QualifyFrequency">
|
|
<para>The interval in seconds at which the contact will be qualified.</para>
|
|
</parameter>
|
|
<parameter name="UserAgent">
|
|
<para>Content of the User-Agent header in REGISTER request</para>
|
|
</parameter>
|
|
<parameter name="ExpirationTime">
|
|
<para>Absolute time that this contact is no longer valid after</para>
|
|
</parameter>
|
|
<parameter name="OutboundProxy">
|
|
<para>The contact's outbound proxy.</para>
|
|
</parameter>
|
|
<parameter name="Status">
|
|
<para>This contact's status.</para>
|
|
<enumlist>
|
|
<enum name="Reachable"/>
|
|
<enum name="Unreachable"/>
|
|
<enum name="NonQualified"/>
|
|
<enum name="Unknown"/>
|
|
</enumlist>
|
|
</parameter>
|
|
<parameter name="RoundtripUsec">
|
|
<para>The round trip time in microseconds.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ContactStatusDetail">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>13.0.0</version></since>
|
|
<synopsis>Provide details about a contact's status.</synopsis>
|
|
<syntax>
|
|
<parameter name="AOR">
|
|
<para>The AoR that owns this contact.</para>
|
|
</parameter>
|
|
<parameter name="URI">
|
|
<para>This contact's URI.</para>
|
|
</parameter>
|
|
<parameter name="Status">
|
|
<para>This contact's status.</para>
|
|
<enumlist>
|
|
<enum name="Reachable"/>
|
|
<enum name="Unreachable"/>
|
|
<enum name="NonQualified"/>
|
|
<enum name="Unknown"/>
|
|
</enumlist>
|
|
</parameter>
|
|
<parameter name="RoundtripUsec">
|
|
<para>The round trip time in microseconds.</para>
|
|
</parameter>
|
|
<parameter name="EndpointName">
|
|
<para>The name of the endpoint associated with this information.</para>
|
|
</parameter>
|
|
<parameter name="UserAgent">
|
|
<para>Content of the User-Agent header in REGISTER request</para>
|
|
</parameter>
|
|
<parameter name="RegExpire">
|
|
<para>Absolute time that this contact is no longer valid after</para>
|
|
</parameter>
|
|
<parameter name="ViaAddress">
|
|
<para>IP address:port of the last Via header in REGISTER request.
|
|
Will only appear in the event if available.</para>
|
|
</parameter>
|
|
<parameter name="CallID">
|
|
<para>Content of the Call-ID header in REGISTER request.
|
|
Will only appear in the event if available.</para>
|
|
</parameter>
|
|
<parameter name="ID">
|
|
<para>The sorcery ID of the contact.</para>
|
|
</parameter>
|
|
<parameter name="AuthenticateQualify">
|
|
<para>A boolean indicating whether a qualify should be authenticated.</para>
|
|
</parameter>
|
|
<parameter name="OutboundProxy">
|
|
<para>The contact's outbound proxy.</para>
|
|
</parameter>
|
|
<parameter name="Path">
|
|
<para>The Path header received on the REGISTER.</para>
|
|
</parameter>
|
|
<parameter name="QualifyFrequency">
|
|
<para>The interval in seconds at which the contact will be qualified.</para>
|
|
</parameter>
|
|
<parameter name="QualifyTimeout">
|
|
<para>The elapsed time in decimal seconds after which an OPTIONS
|
|
message is sent before the contact is considered unavailable.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="EndpointList">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.0.0</version></since>
|
|
<synopsis>Provide details about a contact's status.</synopsis>
|
|
<syntax>
|
|
<parameter name="ObjectType">
|
|
<para>The object's type. This will always be 'endpoint'.</para>
|
|
</parameter>
|
|
<parameter name="ObjectName">
|
|
<para>The name of this object.</para>
|
|
</parameter>
|
|
<parameter name="Transport">
|
|
<para>The transport configurations associated with this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="Aor">
|
|
<para>The aor configurations associated with this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="Auths">
|
|
<para>The inbound authentication configurations associated with this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="OutboundAuths">
|
|
<para>The outbound authentication configurations associated with this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="DeviceState">
|
|
<para>The aggregate device state for this endpoint.</para>
|
|
</parameter>
|
|
<parameter name="ActiveChannels">
|
|
<para>The number of active channels associated with this endpoint.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<manager name="PJSIPShowEndpoints" language="en_US">
|
|
<since>
|
|
<version>12.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Lists PJSIP endpoints.
|
|
</synopsis>
|
|
<syntax />
|
|
<description>
|
|
<para>
|
|
Provides a listing of all endpoints. For each endpoint an <literal>EndpointList</literal> event
|
|
is raised that contains relevant attributes and status information. Once all
|
|
endpoints have been listed an <literal>EndpointListComplete</literal> event is issued.
|
|
</para>
|
|
</description>
|
|
<responses>
|
|
<list-elements>
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='EndpointList'])" />
|
|
</list-elements>
|
|
<managerEvent language="en_US" name="EndpointListComplete">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.0.0</version></since>
|
|
<synopsis>Provide final information about an endpoint list.</synopsis>
|
|
<syntax>
|
|
<parameter name="EventList"/>
|
|
<parameter name="ListItems"/>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</responses>
|
|
</manager>
|
|
<manager name="PJSIPShowEndpoint" language="en_US">
|
|
<since>
|
|
<version>12.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Detail listing of an endpoint and its objects.
|
|
</synopsis>
|
|
<syntax>
|
|
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
|
|
<parameter name="Endpoint" required="true">
|
|
<para>The endpoint to list.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>
|
|
Provides a detailed listing of options for a given endpoint. Events are issued
|
|
showing the configuration and status of the endpoint and associated objects. These
|
|
events include <literal>EndpointDetail</literal>, <literal>AorDetail</literal>,
|
|
<literal>AuthDetail</literal>, <literal>TransportDetail</literal>, and
|
|
<literal>IdentifyDetail</literal>. Some events may be listed multiple times if multiple objects are
|
|
associated (for instance AoRs). Once all detail events have been raised a final
|
|
<literal>EndpointDetailComplete</literal> event is issued.
|
|
</para>
|
|
</description>
|
|
<responses>
|
|
<list-elements>
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='EndpointDetail'])" />
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='IdentifyDetail'])" />
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ContactStatusDetail'])" />
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AuthDetail'])" />
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='TransportDetail'])" />
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AorDetail'])" />
|
|
</list-elements>
|
|
<managerEvent language="en_US" name="EndpointDetailComplete">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>12.0.0</version></since>
|
|
<synopsis>Provide final information about endpoint details.</synopsis>
|
|
<syntax>
|
|
<parameter name="EventList"/>
|
|
<parameter name="ListItems"/>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</responses>
|
|
</manager>
|
|
<manager name="PJSIPShowAors" language="en_US">
|
|
<since>
|
|
<version>16.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Lists PJSIP AORs.
|
|
</synopsis>
|
|
<syntax />
|
|
<description>
|
|
<para>
|
|
Provides a listing of all AORs. For each AOR an <literal>AorList</literal> event
|
|
is raised that contains relevant attributes and status information. Once all
|
|
aors have been listed an <literal>AorListComplete</literal> event is issued.
|
|
</para>
|
|
</description>
|
|
<responses>
|
|
<list-elements>
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AorList'])" />
|
|
</list-elements>
|
|
<managerEvent language="en_US" name="AorListComplete">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide final information about an aor list.</synopsis>
|
|
<syntax>
|
|
<parameter name="EventList"/>
|
|
<parameter name="ListItems"/>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</responses>
|
|
</manager>
|
|
<manager name="PJSIPShowAuths" language="en_US">
|
|
<since>
|
|
<version>16.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Lists PJSIP Auths.
|
|
</synopsis>
|
|
<syntax />
|
|
<description>
|
|
<para>Provides a listing of all Auths. For each Auth an <literal>AuthList</literal> event
|
|
is raised that contains relevant attributes and status information. Once all
|
|
auths have been listed an <literal>AuthListComplete</literal> event is issued.
|
|
</para>
|
|
</description>
|
|
<responses>
|
|
<list-elements>
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AuthList'])" />
|
|
</list-elements>
|
|
<managerEvent language="en_US" name="AuthListComplete">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide final information about an auth list.</synopsis>
|
|
<syntax>
|
|
<parameter name="EventList"/>
|
|
<parameter name="ListItems"/>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</responses>
|
|
</manager>
|
|
<manager name="PJSIPShowContacts" language="en_US">
|
|
<since>
|
|
<version>16.0.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Lists PJSIP Contacts.
|
|
</synopsis>
|
|
<syntax />
|
|
<description>
|
|
<para>Provides a listing of all Contacts. For each Contact a <literal>ContactList</literal>
|
|
event is raised that contains relevant attributes and status information.
|
|
Once all contacts have been listed a <literal>ContactListComplete</literal> event
|
|
is issued.
|
|
</para>
|
|
</description>
|
|
<responses>
|
|
<list-elements>
|
|
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ContactList'])" />
|
|
</list-elements>
|
|
<managerEvent language="en_US" name="ContactListComplete">
|
|
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
|
<since><version>16.0.0</version></since>
|
|
<synopsis>Provide final information about a contact list.</synopsis>
|
|
<syntax>
|
|
<parameter name="EventList"/>
|
|
<parameter name="ListItems"/>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</responses>
|
|
</manager>
|
|
</docs>
|