Reference13r1:Concept Reverse Lookup: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
No edit summary
m (typos, typography)
Line 8: Line 8:
== Configuration ==
== Configuration ==


For reverse lookup there are two configuration parameters: The LDAP URL as command line parameter at the PBX and a crypted VAR for the LDAP password:
For reverse lookup there are two configuration parameters: The LDAP URL as command line parameter at the PBX and a encrypted VAR for the LDAP password:
;/rl0-url: Command line parameter for the LDAP URL according to RFC 2255
;/rl0-url: Command line parameter for the LDAP URL according to RFC 2255
;PBX0/RL0-PWD: The VAR for the password
;PBX0/RL0-PWD: The VAR for the password
Line 14: Line 14:
In short the format of the URL is as follows:
In short the format of the URL is as follows:


  ldap(s)://<host>/<dn>?<attributes>/<scope>/<filter>/extenstions
  ldap(s)://<host>/<dn>?<attributes>/<scope>/<filter>/<extensions>


;dn: The path in the LDAP directory, e.g. dc=entries
;dn: The path in the LDAP directory, e.g. <code>dc=entries</code>
;attributes: The list of attributes to be returned, e.g. givenname,sn,company
;attributes: The list of attributes to be returned, e.g. <code>givenname,sn,company</code>
;scope: The scope. Could be "base", "one", "sub"
;scope: The scope. Could be <code>base</code>, <code>one</code>, <code>sub</code>
;filter: The LDAP filter used for the search, e.g. (metaSearchNumber=+%n)
;filter: The LDAP filter used for the search, e.g. (<code>metaSearchNumber=+%n</code>) (for the meaning of %n see below)
;extentions: Used for the bind name, e.g. bindname=test.com\contacts
;extensions: Used for the bind name, e.g. <code>bindname=test.com\contacts</code>


Inside the LDAP URL placeholders can be used, which are replaced by the actual information:
Inside the LDAP URL placeholders can be used, which are replaced by the actual information:


;%n: The number which should be looked up. It is provided in e.164 international format without prefixed or '+' at the beginning
;%n: The number which should be looked up. It is provided in e.164 international format with no prefixes nor '+' at the beginning (e.g. 497031730090)
;%u: The H323-Id (SIP URI) of the user on behalf of which the lookup is performed
;%u: The H323-Id (SIP URI) of the user on behalf of which the lookup is performed


== CDRs ==
== CDRs ==


The result of the lookup is stored in the CDRs as the results of the lookup are available, so the events for the lookup results are not necessarily next to the related events. To allow matching of the reverse lookup result to the looked up number in the event the name and as reference the looked up number is stored. The event in the CDR is formated as follows:
The result of the lookup is stored in the CDRs as the results of the lookup are available, so the events for the lookup results are not necessarily next to the related events. To allow matching of the reverse lookup result to the looked up number in the event the name and as reference the looked up number is stored. The event in the CDR is formatted as follows:


<code xml>
  <event msg="lookup"><ep e164="<reference number>" dn="<looked up name>"/></event>
  <event msg="lookup"><ep e164="<reference number>" dn="<looked up name>"/></event>
</code>

Revision as of 15:55, 26 April 2021

With the reverse lookup feature the PBX does the lookup of calling or called numbers in an external directory so that not each endpoint has to do the same lookup again. The result of the lookup is sent to the endpoints using name id facilities and is stored in the CDRs so that it can be displayed in call lists.

Version

Available since 13r1 release

Configuration

For reverse lookup there are two configuration parameters: The LDAP URL as command line parameter at the PBX and a encrypted VAR for the LDAP password:

/rl0-url
Command line parameter for the LDAP URL according to RFC 2255
PBX0/RL0-PWD
The VAR for the password

In short the format of the URL is as follows:

ldap(s)://<host>/<dn>?<attributes>/<scope>/<filter>/<extensions>
dn
The path in the LDAP directory, e.g. dc=entries
attributes
The list of attributes to be returned, e.g. givenname,sn,company
scope
The scope. Could be base, one, sub
filter
The LDAP filter used for the search, e.g. (metaSearchNumber=+%n) (for the meaning of %n see below)
extensions
Used for the bind name, e.g. bindname=test.com\contacts

Inside the LDAP URL placeholders can be used, which are replaced by the actual information:

%n
The number which should be looked up. It is provided in e.164 international format with no prefixes nor '+' at the beginning (e.g. 497031730090)
%u
The H323-Id (SIP URI) of the user on behalf of which the lookup is performed

CDRs

The result of the lookup is stored in the CDRs as the results of the lookup are available, so the events for the lookup results are not necessarily next to the related events. To allow matching of the reverse lookup result to the looked up number in the event the name and as reference the looked up number is stored. The event in the CDR is formatted as follows:

<event msg="lookup"><ep e164="<reference number>" dn="<looked up name>"/></event>