Modern office phone systems can hook into Profiler to look up the caller ID of a number coming in and display it on the handset / screen of the device and match it clients that are in Profiler.
To lookup a caller ID, you can produce a JSON or XML response from Profiler. The calling URL is:
- https://database.profilersoftware.com/ProfilerAPI/Enquiry/PABX?q=xxxx
- https://database.profilersoftware.com/ProfilerAPI/Enquiry/PABXxml?q=xxxx
Setup Notes
- In the above, the “database” is the name of the Profiler URL you access. This is the first part up to the first dot. You will notice this API access is using profilersoftware.com domain, this is by design.
- The xxxx in the value above is the phone number passed from the phone system
An example if your database is “testville” and the phone number is 0412345678 the call would be
- https://testville.profilersoftware.com/ProfilerAPI/Enquiry/PABX?q=0412345678
Results
If no callers match the number your result would be, in Json
[]
of in XML
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPhoneNumberEnquiry />
A list of clients will be, in Json
[
{
"clientId": 19150,
"description": "ID: 19150 Ash Wright",
"phoneAh": "12 1212 1445",
"phoneMobile": "0412356789",
"phoneMobile2": "",
"phoneBus": "08 1223 4556",
"email": "[email protected]",
"clientHook": "https://uat.profilersystem.com/ProfilerWeb/Client/?ID=19150"
},
...
]
or in XML
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPhoneNumberEnquiry>
<PhoneNumberEnquiry>
<ClientId>19150</ClientId>
<Description>ID: 19150 John Smith</Description>
<PhoneAh>12 1212 1445</PhoneAh>
<PhoneMobile>0412345678</PhoneMobile>
<PhoneMobile2 />
<PhoneBus>08 1223 4556</PhoneBus>
<Email>[email protected]</Email>
<ClientHook>https://uat.profilersystem.com/ProfilerWeb/Client/?ID=19150</ClientHook>
</PhoneNumberEnquiry>
....
</ArrayOfPhoneNumberEnquiry>
The results will be an array, and multiple callers will be listed should there be multiple matches of clients within Profiler.
Commonly displayed to the customer is
- Description (which combines the ClientID and Display Name of the customer)
- Client Hook – which provides a clickable link to display the client information page in Profiler
This provides the functionality to link your PABX to Profiler. You will need to contact your Phone provider to provide the logic into your phone system, as we only provide the data
3CX CRM lookup – https://www.3cx.com/docs/cfd-crm-lookup/