func_pjsip_aor/contact: Fix documentation for contact ID

Clarified the use of the contact ID returned from PJSIP_AOR.

Resolves: #990
This commit is contained in:
George Joseph
2024-11-09 15:34:41 -07:00
parent 3dfac27ef2
commit e50e4ab33a
2 changed files with 31 additions and 1 deletions

View File

@@ -50,7 +50,15 @@
</synopsis>
<syntax>
<parameter name="name" required="true">
<para>The name of the contact to query.</para>
<para>
Contact names are in the form of "aor_id@@hash" for dynamic contacts
created by the registrar and permanent contacts defined
in a <literal>contact</literal> parameter in an <literal>aor</literal>
object. You can get the "aor_id@@hash" contact ID by calling the
<literal>PJSIP_AOR()</literal> dialplpan function with the AOR name
and the <literal>contact</literal> field. You can then pass the value
returned to this function.
</para>
</parameter>
<parameter name="field" required="true">
<para>The configuration option for the contact to query for.
@@ -69,6 +77,9 @@
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="function">PJSIP_AOR</ref>
</see-also>
</function>
***/