This document details the system and method for integrating OpenCNAM with Broadsoft. OpenCNAM exposes a Broadsoft compliant SOAP endpoint that can be configured through the standard Broadsoft CLI.
First, the customer must add a static IP address from which SOAP queries will be issued to the "whitelist" for this product. This can be accomplished in the OpenCNAM customer portal as follows:
![]() | 1. Log into the customer dashboard at www.opencnam.com/dashboard 2. Click on Manage Account in the sidebar. |
![]() | 3. Click Show IP Authentication Options to expose the IP address whitelist. |
![]() | 4. Add the IP address(es) of the SOAP signalling endpoint(s) from which your queries will be issued here. |
The main resource to consider when integrating Broadsoft with OpenCNAM is the SOAP Endpoint which can be found here:
http://api.opencnam.com/v3/broadsoft
You will need to configure your Broadsoft Application Server using the following steps:
TeloComputer:~ user1$ ssh root@bwas00.customer.com
Password: *****
Last login: Wed Jan 18 13:42:23 2017 from 10.6.161.171
|-----------------------------------------------------------------|
| This system is for the use of authorized users only. |
| Individuals using this computer system without authority, or in |
| excess of their authority, are subject to having all of their |
| activities on this system monitored and recorded by system |
| personnel. |
| |
| In the course of monitoring individuals improperly using this |
| system, or in the course of system maintenance, the activities |
| of authorized users may also be monitored. |
| |
| Anyone using this system expressly consents to such monitoring |
| and is advised that if such monitoring reveals possible |
| evidence of criminal activity, system personnel may provide the |
| evidence of such monitoring to law enforcement officials. |
|-----------------------------------------------------------------|
Become the user "bwadmin" by executing the following line:
su - bwadmin
Enter the BroadSoft Application Server CLI and become root by issuing the following commands:
bwcli
AS_CLI>
lo
AS_CLI> lo
Password: *****
admin logging in...
Next, configure Broadsoft to use the SOAP protocol and OpenCNAM's SOAP Endpoint as the external CNAM database:
Service
CallingNameRetrieval
set queryProtocol soap
set sipExternalDatabaseURI http://api.opencnam.com/v3/broadsoft
get
and confirm your settings match the following:AS_CLI> Service
AS_CLI/Service> CallingNameRetrieval
AS_CLI/Service/CallingNameRetrieval> set queryProtocol soap
...Done
AS_CLI/Service/CallingNameRetrieval> set sipExternalDatabaseURI
http://api.opencnam.com/v3/broadsoft
...Done
AS_CLI/Service/CallingNameRetrieval> get
triggerCNAMQueriesForAllNetworkCalls = false
triggerCNAMQueriesForGroupAndEnterpriseCalls = false
queryProtocol = soap
queryTimeoutInMilliseconds = 1200
routeAdvanceTimerMilliseconds = 1000
retryFailedCNAMServerIntervalSeconds = 300
ignoreRestrictedPresentationIndicator = false
supportsDNSSRV = false
sipExternalDatabaseURI = null
sipExternalDatabasePort = 5060
sipExternalDatabaseTransport = udp
soapExternalDatabaseURI = http://api.opencnam.com/v3/broadsoft
callingNameSource = presentationIdentity
If your CNAM results are not as expected, try the following steps to attempt to diagnose the issue:
curl
call to OpenCNAM from the command line of your BroadSoft Application Server. curl 'https://api.opencnam.com/v3/phone/+16786318356'
We are happy to assist with your integration. Our team can be reached in any of the following ways:
Phone: +1-888-315-8356 (TELO) or +1-678-631-8356 (TELO)
Email: support@opencnam.com
OpenCNAM has several interfaces available through which customers may perform CNAM queries. This document details the system and method for integrating OpenCNAM with Broadsoft devices. OpenCNAM exposes a Broadsoft compliant SOAP endpoint that can be configured through the standard Broadsoft CLI. Using this SOAP interface, Broadsoft devices can query OpenCNAM and display CNAM/Caller ID for display on phones.
We are happy to assist with your integration. Our team can be reached in any of the following ways:
Phone: +1-888-315-8356 (TELO) or +1-678-631-8356 (TELO)
Email: support@opencnam.com