Skip to content

Documentation API

Account API – get_xdr_list

Account API – `get_xdr_list`

Description

This method retrieves Account XDR (eXtended Detail Records) records for a specific account.

HTTP Request

POST /Account/get_xdr_list
Authorization: Bearer <token>
Content-Type: application/json

Request Body (application/json)

{
  "params": {
    "call_id": "string",
    "call_recording": 1,
    "cld": "string",
    "cli": "string",
    "connect_time_after": "2000-01-01 08:00:00",
    "connect_time_before": "2000-01-01 08:00:00",
    "enable_safe_mode": 1,
    "format": "string",
    "from_date": "2000-01-01 08:00:00",
    "get_split_xdrs": 1,
    "get_total": 1,
    "h323_conf_id": "string",
    "history_pattern": "string",
    "i_account": 1,
    "i_dest_group": 1,
    "i_service": 1,
    "i_service_type": 1,
    "limit": 50,
    "offset": 0,
    "quality": "string",
    "roaming": 1,
    "show_unsuccessful": 1,
    "to_date": "2000-01-01 08:00:00",
    "with_cr_download_ids": 1,
    "with_netaccess_usage": 1
  }
}

Parameters (in `params` object)

Parameter	Type	Description
`call_id`	string	Filters xDRs by the identifier of the call.
`call_recording`	integer	Filters xDRs by the available call recordings. Possible values: `1` - match only xDRs with available call recording; `0` - match xDRs without recording.
`cld`	string	Filters xDRs by the Called Line Identification. Use `%` as a wildcard: `%value`, `value%`, `%value%`.
`cli`	string	Filters xDRs by the Calling Line Identification. Use `%` as a wildcard.
`connect_time_after`	date-time	Filters xDRs with `connect_time` after this date.
`connect_time_before`	date-time	Filters xDRs with `connect_time` before this date.
`enable_safe_mode`	integer	Whether to check the number of matched xDRs before processing. Possible values: `1` - check enabled; `0` - disabled.
`format`	string	Output file format when downloading xDRs. Possible value: `csv`.
`from_date`	date-time	Filters xDRs with billing time after this date.
`get_split_xdrs`	integer	Whether to include split xDRs in the response. Possible values: `0` - no; `1` - yes.
`get_total`	integer	Whether to include the total number of matched xDRs. Possible values: `0` - no; `1` - yes.
`h323_conf_id`	string	Filters xDRs by the session identifier.
`history_pattern`	string	Filters xDRs by matching pattern in history. Wildcards supported. Possible: `null` or any string.
`i_account`	integer	Filters xDRs by the ID of the account.
`i_dest_group`	integer	Filters xDRs by the ID of the destination group.
`i_service`	integer	Filters xDRs by the ID of the service.
`i_service_type`	integer	Filters xDRs by the service type ID.
`limit`	integer	Number of rows to return.
`offset`	integer	Number of rows to skip.
`quality`	string	Filters by call quality. Possible values: `good`, `fair`, `poor`, `unknown`.
`roaming`	integer	Filters xDRs by roaming status.
`show_unsuccessful`	integer	Include unsuccessful attempts. Possible values: `1` - include; `0` - exclude.
`to_date`	date-time	Filters xDRs with billing time before this date.
`with_cr_download_ids`	integer	Include call recording IDs. Possible values: `0` - no; `1` - yes.
`with_netaccess_usage`	integer	Include `bytes_downloaded` and `bytes_uploaded` for netaccess xDRs. Possible values: `0` - no; `1` - yes.

Response 200 (Success)

{
total: 1,
xdr_list: [
{
CLD: "string",
CLI: "string",
account_id: "string",
aux_xdrs: [
{
value: "string",
xdr_column_id: "string",
xdr_time: "2000-01-01 08:00:00"
}
],
beneficiary_account_id: "string",
bill_status: "string",
bill_time: "2000-01-01 08:00:00",
bit_flags: 1,
bytes_downloaded: 1,
bytes_uploaded: 1,
call_id: "string",
charged_amount: 1.01,
charged_quantity: 1,
connect_time: "2000-01-01 08:00:00",
country: "string",
cr_download_ids: [
"string"
],
description: "string",
disconnect_cause: "string",
disconnect_reason: "string",
disconnect_time: "2000-01-01 08:00:00",
failed: 1,
h323_conf_id: "string",
h323_incoming_conf_id: "string",
history: "string",
i_account: 1,
i_customer: 1,
i_dest: 1,
i_rate: 1,
i_service: 1,
i_xdr: 1,
is_split: "string",
service: "string",
setup_time: 1,
split_order: 1,
subdivision: "string",
subscription_name: "string",
unix_connect_time: 1,
unix_disconnect_time: 1
}
]
}

`xdr_list[]` Object Fields

Field	Type	Description
total	integer	The total number of xDRs found.
xdr_list[]		The list of xDRs.
CLD	string	The called line identification. The UI equivalent of this field is the 'To (CLD)' input field on the Account xDRs search panel.
CLI	string	The calling line identification. The UI equivalent of this field is the 'From (CLI)' input field on the Account xDRs search panel.
account_id	string	The identifier of the account related to the xDR. The UI equivalent of this field is the 'Account ID' column on the Account xDRs search panel.
aux_xdrs[]		The list of auxiliary records linked with the xDR.
value	string	The additional xDR property value.
xdr_column_id	string	The additional xDR property name.
xdr_time	date-time	The additional xDR property date and time when the property was processed.
beneficiary_account_id	string	The ID of the beneficiary account if the service was consumed by a beneficiary. Note: if the xDR is related to a regular account, this value is the same as 'account_id'.
bill_status	string	The related account bill status. Possible values: O - Open; I - Inactive; C - Closed.
bill_time	date-time	The billing time of the xDR. Points to date and time, and to what billing interval is included.
bit_flags	integer	The extended information about how the service was used. Should be treated as a bit-map. Note: each currently-used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position).
bytes_downloaded	integer	The quantity of downloaded bytes for the xDR. Note: available only for xDRs with netaccess service; the field is returned by 'with_netaccess_usage' in the request.
bytes_uploaded	integer	The quantity of uploaded bytes for the xDR. Note: available only for xDRs with netaccess service; the field is returned by 'with_netaccess_usage' in the request.
call_id	string	The unique identifier of the call.
charged_amount	number	The amount charged. The UI equivalent of this field is the 'Charged amount' column on the Account xDRs search panel.
charged_quantity	integer	The number of units charged. The UI equivalent of this field is the 'Charged time' column on the Account xDRs search panel.
connect_time	date-time	The call connect time. The UI equivalent of this field is the 'Connect time' column on the Account xDRs search panel.
country	string	The call destination country name. The UI equivalent of this field is the 'Country, Area' column on the Account xDRs search panel.
cr_download_ids	[string]	The list of ids used to download the recorded files.
description	string	The xDR destination description. The UI equivalent of this field is the 'Description' column on the Account xDRs search panel.
disconnect_cause	string	The code for the cause of the disconnection. The UI equivalent of this field is the 'Disconnection error' column on the Account xDRs search panel.
disconnect_reason	string	The call disconnect reason.
disconnect_time	date-time	The call disconnect time. The UI equivalent of this field is the 'Disconnect time' column on the Account xDRs search panel.
failed	integer	The flag indicating whether the xDR call failed. Possible values: 0 - normal xDR; 1 - xDR for failed call.
h323_conf_id	string	The unique identifier of the session.
h323_incoming_conf_id	string	The unique ID of the incoming session (if applicable). Used for interrelating xDRs when the charged session is established as a result of a previous session (possibly having its own xDR).
history	string	The additional information about the xDR.
i_account	integer	The identifier of the account for which the xDR was created.
i_customer	integer	The identifier of the account's customer.
i_dest	integer	The identifier of the destination.
i_rate	integer	The identifier of the rate applied to the xDR. Note: for xDRs related to subscriptions, the field value points to the subscription ID.
i_service	integer	The identifier of the service. The UI equivalent of this field is the 'Service' input field on the Account xDRs search panel.
i_xdr	integer	The unique identifier of the xDR.
is_split	string	Shows whether the xDR is split. Possible values: 0 - the xDR is not split; 1 - the xDR is split.
service	string	The name of the service. The UI equivalent of this field is the 'Service' column on the Account xDRs search panel.
setup_time	integer	The time (in ms) between the first provisional response and the connect_time.
split_order	integer	The sequential number where the xDR is part of a group of xDRs resulting from the same session.
subdivision	string	The destination country subdivision name. The UI equivalent of this field is the 'Country, Area' column on the Account xDRs search panel.
subscription_name	string	The name of the subscription related to the xDR. Note: the field is returned when the method is called from the admin realm.
unix_connect_time	integer	The call connect time. Note: the format is unix time - seconds since the epoch.
unix_disconnect_time	integer	The call disconnect time. Note: the format is unix time - seconds since the epoch.

Error Response 500

{
  "faultcode": "string",   The error code
  "faultstring": "string"   Text description of the error
}