Dataset: Telephone Calls and SMS

Dataset name: ds_utility_tel_calls

Description

Telephone calls

Fields in this dataset

Name Field Name Description Field Type Field Example
Telephone Calls ID id The primary identifier for this record. number 5
Telephone Calls Instance instance The instance this transaction relates to. number 8
Telephone Calls Source source The source of the data - user or connection. text
Telecoms Transactions Charge Type utility_tel_call_charge_type The charge type text Included
Telecoms Transactions Cost utility_tel_call_cost The cost of the transaction/ call currency 122.22
Currency Code utility_tel_call_currency_code Currency code for the transaction text GBP
Telecoms Transactions Date utility_tel_call_date The date of the transaction date 29222
Telecoms Transactions Duration utility_tel_call_duration The duration of the call time 0.050138888888889
Incoming/Outgoing utility_tel_call_incoming_outgoing Is this record an incoming or outgoing call/sms. varchar
Telecoms Transactions Number Called utility_tel_call_number_called The telephone number called in the transaction text (44) 01234 123456
Telecoms Transactions Transaction Type utility_tel_call_type The type of transaction text Call or SMS

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_utility_tel_calls
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "5": {
    "id": "5",
    "ds_id": "5",
    "utility_tel_call_charge_type": "Included",
    "utility_tel_call_cost": "122.22",
    "utility_tel_call_currency_code": "GBP",
    "utility_tel_call_date": "29222",
    "utility_tel_call_duration": "0.050138888888889",
    "utility_tel_call_incoming_outgoing": null,
    "utility_tel_call_number_called": "(44) 01234 123456",
    "utility_tel_call_type": "Call or SMS"
  }
}