Client Reporting Integration / Request API

Introduction

Our system allows you to access call reports either through HTTP requests, or via FTP updates. This way, you can retrieve call data without needing to access the Delacon portal. The reporting fields can also be customised to focus on the data you are interested in.

Below is a schematic overview of the process:

URL Parameters

By default, below parameters will be included in the report, which are the basic data fields available in the Delacon call log.

Dial From

Exchange

City

State

1300

Transferred

DateTime

Result

Dealer

Business Name

Business Category

Time(sec)

Voice Mail Left

Converted

Search Engine

Type

Keyword

Device

ISP

Client IP

Referral

Landing Page

Extra Tracking

Survey Outcome

Survey Sales Amount

Below is a list of parameters that can be added to request:

Expand List

Parameter Name	Description of data to be entered	Mandatory	Type/Length
userid	User ID, when not using API key	NO*	Alphanumeric string
password	Password, when not using API key	NO*	Alphanumeric string
datefrom	start date of the reporting period, or TODAY (in capitals) for the current day.	YES	String in YYYY-MM-DD format, or TODAY
dateto	end date of the reporting period. The latest date that can be set in this parameter is the day before the current date.	YES	String in YYYY-MM-DD format
reporttype	the tracking number(s) to be included in the report.	NO	tracking numbers separated by a comma
reportoption	Format of the report	NO	Default is XML, valid value is “csv”
customername	Name of customer to which report is to relate	NO	Alphanumeric string
cids	Delacon Service Ids to be included in the report. Multiple IDs can be specified and separated by comma. If parameter is not added, the report will include call data from all services.	NO	Alphanumeric string
showrecurl	Request the recording url to be included	NO	Valid value is “1”
showrowid	Request the unique Delacon ID to be included	NO	Valid value is “1”
showdtmf	Request IVR DTMF tones entered by caller	NO	Valid value is “1”
showcid	Request the Service ID is included	NO	Valid value is “1”
showmid	Request the Master ID is included	NO	Valid value is “1”
showcity	Request the City of the caller	NO	Valid value is “1”
showstate	Request the State of the caller	NO	Valid value is “1”
showdevice	Request the Device of the caller	NO	Valid value is “1”
showisp	Request the ISP of the caller	NO	Valid value is “1”
showip	Request the IP address of the caller	NO	Valid value is “1”
showgaid	Request the Google Analytics Client ID	NO	Valid value is “1”
isCallRecordingMessageCompleted	Check if the call recording alert message has played in full completed	NO	Valid value is “1”
showlandingpage	Request the Landing page information	NO	Valid value is “1”
gaadcopy	Capture the ad copy information from the AdWords ad that a caller clicked on	NO	Valid value is “1”
showadwordsinformation	Shows the Google Ads campaign name and provides the GCLID for website and call extension calls	NO	Valid value is “1”
show247Information	Request the 247 Integration information	NO	Valid value is “1”
showcallingpage	Request the page called from information	NO	Valid value is “1”
showComment	Displays comments entered in by the operator	NO	Valid value is “1”
showcustomerintent	Displays customised summary of caller’s intent	NO	Valid value is “1”
showsignalid	Display’s Signal’s unique ID number	NO	Valid value is “1”
showsa3code	Displays caller’s SA3 Code. More info on SA3 codes can be found here.	NO	Valid value is “1”
hashcallerID	Using SHA256 protocol, Delacon will hash/encrypt the caller ID, using the full international number (eg.164) without any special characters or spaces. For example, Australian number will be "61412345678" and pass it through the "SHA-256" algorithm.	NO	Valid value is “1”
showadwordsintegration	Check if the adwords integration has been set up	NO	Valid value is “1”
showrating	Specify whether the call rating value is required	NO	Valid value is “1”
show1300duration	Shows the entire call duration	NO	Valid value is “1”
kwnodqt	Removes any double quotes from the keyword field	NO	Valid value is "1"

Setup

Setting up a HTTP request

Below steps are based on using Postman as an API platform for building and using APIs. You may choose a different tool, but the steps will be similar.

Step 1

Download the Postman app: https://www.postman.com/

Step 2

Click on "new" and select HTTP request on the next screen

Postman 2023-07-26 15.19.58.png

Step 3

Set the request to post and add https://pla.delaconcorp.com/site/report/report.jsp as the address from which to request the report.

Postman 2023-07-26 15.22.48.png

Step 4

Navigate to the "Headers" tab and add your Delacon API key. This API key is used to authenticate access to your Delacon account.

Please click here for the instructions on obtaining your API key from the Delacon portal.

In the Key field, type in "Auth".

In the Value field, add the API key from your Delacon portal.

Postman 2023-07-26 15.25.12 (1).png

Step 5

Navigate to the "Params" tab and add all parameters that you want to include in your report. Please review the list of parameters at the beginning of this guide and how to add the values for each parameter.

The system will automatically start building the request string URL, which may look like this:

https://pla.delaconcorp.com/site/report/report.jsp?datefrom=2023-07-01&dateto=2023-07-31&cids=12345,23456&reportoption=csv&showadwordsinformation=1

Postman 2023-07-26 15.27.56 (1).png

Step 6

Once you have added all parameters, click on "Send" or "Send and Download" to get the report.

Postman 2023-07-26 15.31.55.png

Obtaining live call reports via HTTP request

Live call reports allow you to access the phone call data live as it is happening, however some of the (end call) data will be missing until the phone call completes.

Please note the URL will need to run when a call is live and happening, otherwise no data will display.

Option 1: Report URL’s

Reports can be accessed through the following URL using POST request and using the username and password parameters:

http://pla.delaconcorp.com/site/report/livecalldata.jsp

Option 2: API Authentication

Alternatively, an API key can be used for authentication. This may be a more secure alternative than putting a user ID and password in a URL.

The URL will look like the below if authentication is done via API key (see instructions on page 5 on how to authenticate using API key):

https://pla.delaconcorp.com/site/report/livecalldata.jsp

Please click here for the instructions on obtaining your API key.

URL Parameters

URL has the following input parameters:

Parameter Name	Description of data to be entered	Mandatory	Type/Length
userid	User ID	YES	Alphanumeric string
password	Password	YES	Alphanumeric string
incomingCallNumber	The number from which the call is made and in progress	YES	Alphanumeric string
cid	Campaign Id	NO	Alphanumeric string
showrowid	Request if the unique incoming call key is to be included or not	NO	Valid value is “1”
reportoption	Format of the report	YES	String value either xml or csv
gaadcopy	Captures the ad copy from AdWords that a caller clicked on	NO	Valid value is “1”

XML Return results

The XML returns one row of result. The report will include the following parameters of the call:

Parameter Name	Description of data
IncomingCallKey	A unique key that can be used to represent the call in Delacon server. This data will only appear if parameter showrowid is set to “1”
CallerPhoneNumber	Incoming Call Number
Exchange	Telephone Exchange from where the call initiated
City	City from where the call initiated
State	State from where the call initiated
NumberDialled	Dialled Number
AnsweringPoint	The destination connected to the incoming call
CallStartTime	The time the call started (Inbound call start time)
DealerReference	Combination of Dealer name, business name, business category (Dealer name – business name – business category)
Duration	Duration of the call (not displayed during live call)
VoiceMailLeft	Indicates whether the caller left a voice mail (not displayed during live call)
CallConverted	Call Conversion status
SearchEngineUsed	Google, yahoo, bing etc. (if known or applicable)
BrowserType	Type of the browser
KeywordsSearched	The keyword if known that the customer used to make a call.
DeviceUsed	The device used
UserISP	User Internet Service Provider
UserIPAddress	User IP Address
RefferalURL	Referral URL
WebsiteLandingPage	Website Landing Page
AdditionalBrowsingDetails	Extra Tracking Details
CallFeedbackOutcome	Call Feedback Outcome (not displayed during live call)
CallFeedbackSaleAmount	Call Feedback Sale Amount (not displayed during live call)
CallRecordingFile	Call Recording File (not displayed during live call)
MasterID	Master Id
CampaignID	Campaign Id
gaadcopy	Captures the ad copy from AdWords ad that a caller clicked don

Sample XML

Sample XML showing the results of a reporting query:

<CallerPhoneNumber>+6198765432</CallerPhoneNumber>
<Exchange>REYNELLA</Exchange>
<City>ADELAIDE</City>
<State>SA</State>
<NumberDialled>0</NumberDialled>
<AnsweringPoint></AnsweringPoint>
<CallStartTime>2015-09-21 15:01:36.041</CallStartTime>
<CallResult></CallResult>
<DealerReference>6FEE9CEA-595F-4F44-97CD-BAD8A9EB4298 - Company xyz - 6FEE9CEA-595F-4F44-97CD-BAD8A9EB4298</DealerReference>
<Duration></Duration>
<VoiceMailLeft></VoiceMailLeft>
<CallConverted></CallConverted>
<SearchEngineUsed></SearchEngineUsed>
<BrowserType></BrowserType>
<KeywordsSearched></KeywordsSearched>
<DeviceUsed></DeviceUsed>
<UserISP></UserISP>
<UserIPAddress></UserIPAddress>
<RefferalURL></RefferalURL>
<WebsiteLandingPage></WebsiteLandingPage>
<AdditionalBrowsingDetails></AdditionalBrowsingDetails>
<CallFeedbackOutcome></CallFeedbackOutcome>
<CallFeedbackSaleAmount></CallFeedbackSaleAmount>
<CallRecordingFile></CallRecordingFile>
<MasterID>12</MasterID>
<gaadcopy><gaadcopy>
<CampaignID>12</CampaignID>
</CallingFlow>
</CallingFlows>

Live call reports as CSV format

Reports can also be accessed by retrieving report data (in CSV format) by setting the parameter reportoption parameter.

CSV reports will have one row of result and the same parameters as those set out above.

Sample of report in CSV format:

Key, Caller Phone Number,Exchange,City,State,Number Dialled,Answering Point,Call Start Time,Call Result,Dealer Reference,Duration,Voice Mail Left,Call Converted,Search Engine Used,Browser Type,Keywords Searched,Device Used,User ISP,User IP Address,Refferal URL,Website Landing Page,Additional Browsing Details,Call Feedback Outcome,Call Feedback Sale Amount,Call Recording File,Master ID,Campaign ID,

23532, 61733337743,NAMBOUR,NAMBOUR,QLD,0,,2015-09-23 10:32:43.557,, customerabc,,,,,,,,,,,,,,,,31,10549

Similar to the XML output, the column Key will depend on the input parameters.

Example Return Results

XML Return results

This XML returning the results of the report request will include the following parameters for each call reported on:

Parameter Name	Description of data
IncomingCallKey	A unique key that can be used to represent each call received by Delacon (e.g. each call gets its own unique key).
IncomingCallNumber	The incoming callers phone number (where available) or a SHA256 hashed number if the hashcallerID is turned on.
City	City from where the call initiated (e.g. if called from mobile, we use web session IP - for Fixed line call, we use call ID number range allocation).
State	State from where the call initiated.
Geo-origin	Exchange location (for Fixed line calls only).
Number1300	The Delacon Tracking number dialed by the caller.
Time	Date and Time of Call.
Result	Status of call (e.g. answered. missed, busy).
DealerID	The Dealer Identification Number.
DealerName	The defined name of the CID called.
DealerCategory	The defined category of the CID called.
Duration	Duration of outbound call, commencing when termination number is dialed (excludes duration for Delacon hosted IVR, call recording alerts)
DurationOf1300	Total call duration, commencing when tracking number is dialed.
VoiceMailLeft	Indicates whether the caller left a voice mail.
SearchEngine	Search engine used by caller e.g. Google, Yahoo, Bing etc. (if known or applicable).
Type	Whether the search made by the caller was free or paid.
Keywords	The keyword - if known - that the customer used to land on a website.
DeviceUsed	The device the caller used.
UserISP	Caller’s Internet Service Provider.
UserIPAddress	Caller’s IP Address.
WebsiteLandingPage	The webpage the caller first landed on.
URL	The URL consists of Referral Page, Landing Page and the IP address of the caller.
Converted	If the session resulted in a call (when the caller is on your website and the CID is integrated into Google Analytics.
SurveyOutcome	Post call outcome survey entered by operator (if applicable).
SurveySalesAmount	Post call sales amount entered by operator (if applicable).
CompanyID	Company ID (only if cids is specified by Delacon).
RecordingUrl	The URL that can download the recording file (only if showrecurl is specified).
Dtmf	The phone menu number entered by the caller. E.g. If 1 for sales is pressed, the ‘1’ will be captured.
MasterID	MasterID (only if showmid is specified).
Transferred Number	Termination number which Delacon transfers the calls to.
GAADCOPY	Captures the ad copy from the AdWords ad that a caller clicked on.
GaClientId	Requests the Google Analytics Client ID captured for the session.
CookieID247	Shows the 247 Cookie (if applicable).
Type247	Shows the time of the 247 Cookie (if applicable).
CallPage	Page the caller was on when calling Delacon tracking number.
Comment	Displays comments entered in by the operator.
CallRecordingMessageCompleted	Checks if call recording message is completed.
CustomerIntent	Displays customised summary of caller’s intent based on IVR mapping.
SignalId	Displays Signal Identification Number (if applicable).
SA3Code	Displays callers SA3 Code. More info on SA3 codes can be found here.
AdwordsIntegration	Display Y/N to indicate if the adwords integrations have been enabled

Sample XML results

Sample XML showing the results of a reporting query:
<?xml version="1.0"?>

<Geo-Origin> edgecliff </Geo-Origin>

<City>Sydney</City>

<DeviceUsed>iPhone</DeviceUsed>

<WebsiteLandingPage>http://www.landingpage.com.au</WebsiteLandingPage>

<Result>Normal</Result>

<DealerName>Bing Home Bundle - NBN</DealerName>

<Type>Google</Type>

<Keyword>Internet</Keyword>

<URL>www.landingpage.com.au</URL>

</CallingFlow><CallingFlow>

Reports as CSV format

Reports can also be accessed by retrieving report data (in CSV format) by setting the parameter "reportoption".

CSV reports will have the same parameters as those set out above.

Sample of report in CSV format:

Key,Incoming Call Number,Geo-Origin,1300 Number,Transferred,

Date/Time,Result,Dealer ID,Dealer Name,Dealer Category,Email

Address,Duration,1300,Voice Mail Left,Search Engine,Type,Keywords,Extra Tracking,Survey

Outcome, Survey Sales Amount,Company ID,Recording URL, SA3Code, Adwords Integration

682932,61293281232,edgecliff,1300017292,1300659496,15:11.0,Normal,237667,abc

company,franchise,admin@abc.com.au,10,,No,,,,,,,,,,10101,Y

682948,61429782863,Bondi,1300050963,6139394430,41:11.0,Normal,737667,XYZ multimedia,media,admin@ xyzmultimedia.com.au,30,20,Yes,,,,,,,,,, 10101,N

682973,61429782868,edgecliff,1300050967,6139394480,41:11.0,Normal,837667,Hi System,IT,admin@hisys. com.au,120,100,Yes,,,,,,,,,, 10101,Y

Similar to the XML output, the column Key, Company ID, Recording URL will depend on the input parameters.

Appendix:

Optional testing: how to test if the Auth header is working.

Only use this testing method if you are not using a username and password in the URL and want to use the Auth Key method.

It may be best to test that the Auth method is working before plugging it into your program:

Steps to test API URLs with Auth header using SOAP UI

Download the SOAP UI installer from http://cdn01.downloads.smartbear.com/soapui/5.2.1/SoapUI-x32-5.2.1.exe

Follow the prompts to install SoapUI.

Test post call data report URL

E.g. https://pla.delaconcorp.com/site/report/report.jsp?reportoption=xml&datefrom=2015-09-09&dateto=2015-09-10

Step 1: Open SOAP UI

Step 2: Create New REST Project

Step 3: Paste the following URL in to the pop-up dialog box.

https://pla.delaconcorp.com/site/report/report.jsp?reportoption=xml&datefrom=2015-09-09&dateto=2015-09-10

Step 4: Click Ok on the dialog box. You will see the SOP UI screen like this.

Step5: Click the Option ''Header'' encircled in orange at the bottom. You will see a table with columns ''header'', ''name'' appears.

Step 6: Click + to add the Auth header value in the request as follows

Step 7: A dialog box appears as follows. Enter the name of header as Auth and click Ok.

Step 8: The Auth header is created. And the Auth Header value is entered in the value field as follows. And press enter.

Now the request has been created with Auth header in the SOAP UI.

Step 9: Execute the request by clicking the following play button at the top as encircled in the orange below

The result xml will appear as follows

Test live call data report URL

E.g.

https://pla.delaconcorp.com/site/report/livecalldata.jsp?reportoption=xml&incomingCallNumber=418666887

Repeat the Step 1 to 9, except that

The URL used in the step 3 is getting replaced by the one above.
The request parameters would be reportoption, incomingCallNumber instead of reportoption, datefrom and dateto
Please refer the Delacon portal https://www.delaconcorp.com/Portals/0/pdf/ReportingIntegrationSummaryTracking.pdf for the result xml format.

Articles in this section

Client Reporting Integration / Request API

Introduction

URL Parameters

Setup

URL Parameters

XML Return results

Live call reports as CSV format

Comments

Articles in this section

Introduction

URL Parameters

Setup

URL Parameters

XML Return results

Live call reports as CSV format

Related articles