Siptalk API Reports / All Services
Navigation
General Description
This report will allow you to retrieve call records for all services on your account.
By default it will return up to 1000 records for the current bill month, alternatively you can set optional fields to retrieve specific record sets.
Call records are stored in a monthly table. At the start of each month a new table is created and the cdr_id resets.
API URL
https://api.siptalk.com.au/reports/all-services/
Required Fields
| Field | Description |
|---|---|
| apikey | The API key created in the portal. |
| apisecret | The API secret created in the portal. |
Optional Fields
| Field | Description |
|---|---|
| billmonth | Specify the year/month that you want to retrieve records from. Any valid date format, like 2026-01 |
| lastid | An integer defining the latest cdr_id that you have already collected. Records returned will be those after this id. |
| limit | An integer specifying the max number of records to be returned. The absolute maximum the endpoint will return is 1000 records. |
| sandbox | Can be any non-empty value, including this will make classify the request as readonly and no changes will be made to the system. |
Response Fields
| Field | Type | Value | Description |
|---|---|---|---|
| records | array | variable | Contains an array of call records. |
| count | integer | variable | The number of call records returned. |
| billmonth | text | variable | The bill month to which the records are related. |
Success Response
The test endpoint will return a message containing 'hello world' if successful.
{
"records": [
{
"cdr_id": "1",
"event_id": "5991552540330355",
"customer_id": "1000000000",
"date_time": "2026-01-11 12:23:19",
"duration": "12",
"orig_number": "1000000",
"term_number": "1000000",
"charged_party": "1300000000",
"callcost": "0.0500",
"type_of_call": "7",
"rated": "y",
"rate_used": "0.0800/m+0.00",
"call_type": "Inbound 1300 Local"
},
{
"cdr_id": "2",
"event_id": "5991552540606357",
"customer_id": "1000000000",
"date_time": "2026-01-16 19:16:51",
"duration": "11",
"orig_number": "10000000",
"term_number": "1000000",
"charged_party": "1300000000",
"callcost": "0.0500",
"type_of_call": "7",
"rated": "y",
"rate_used": "0.0800/m+0.00",
"call_type": "Inbound 1300 Local"
}
],
"count": 2,
"billmonth": "2026-01"
}
The Records Array Fields
| Field | Description |
|---|---|
| cdr_id | The record identifier. It is unique only for the bill month the call is recorded in. It resets at the start of each new bill month. |
| event_id | The event identifier allocated to the call. The event id is unique in time across all calls. |
| customer_id | The customer id. |
| date_time | The time the call was initiated. |
| duration | The duration of the call in seconds. |
| orig_number | The number of the originating caller. |
| term_number | The number that answered the call. |
| charged_party | The number that placed the call and the charge is related to. |
| callcost | The exGST cost of the call. Only valid if the call is marked as rated. |
| type_of_call | The call type identifier used by the system. |
| rated | Identifies whether the call has been rated. Calls can take up to 5 minutes to be rated after they complete. |
| rate_used | A text description of the rate used to calculate the call cost. |
| call_type | A text description of the call type. May change without notice. |