Application developers may wish to access call logs from a Neural termiantion or PBX account via API. This article outlines how to access this data in CSV format via either HTTP or HTTPS.
The URL and Fields
You can export your call logs via URL using the following string. Replace the values in bold with those appropriate for your query.
https://voip.neural.net.au:15000/get/report-export-<direction>&user=<user>&pass=<password>&repType=custom&download=true&inline=true&fromTime=123456789&toTime=123456789
Direction:
Inbound or outbound call logs. One of:
in - Inbound call logs
out - Outbound call logs
User:
Your portal username
Password:
Your portal password
fromTime / toTime:
Unix timestamp of the start and end times for the calls to report on. Most programming languages have a function to report their native date/time format into a unix timestamp.
You can learn more about the unix timestamp format in Wikipedia.
Alternatively you can use our standard call log export command, which has pre-defined time periods.
Inline
Determines whether the response will be 'inline' data or 'attachment' data. Inline data returns the CSV data as the inline HTML reponse. If you remove this section of the URL, data will instead be sent in attachment format, which forces the browser to treat the CSV as a file download, rather than a web page. Most retrieval methods (cURL, wget, etc.) prefer inline.
Example
A working example would look something like...
https://voip.neural.net.au:15000/get/report-export-in&user=test&pass=s3cr3t&repType=30day&download=true&inline=true
CSV Data Return
The CSV data will be returned
HTTP Alternative
If HTTPS is unsuitable for your application, the same API is also available on HTTP. Simply remove the 's' from https and change the port to 16000.
For example:
http://termination.neural.net.au:16000/get/report-export-out&user=test&pass=s3cr3t&repType=live&download=true&inline=true
Some development environments (such as .NET) don't always get along well with HTTPS, so this can be used as an alternative.
Sample Code
Sample code for this function is also available in the knowledge base.
0 Comments