This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuAPI Reference
API Reference
Close Sidemenu

Reporting

Get all Wireless Detail Records (WDRs) ReportsgetWdrReports

get https://api.telnyx.com/v2/wireless/detail_records_reports

Returns the WDR Reports that match the given parameters.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/wireless/detail_records_reports?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1- 250)
optional

The size of the page

Default: 20
Responses
200

Successful response

default

Unexpected error

Success Response
{
  "data": [
    {
      "created_at": "2018-02-02T22:25:27.521Z",
      "end_time": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "detail_records_report",
      "report_url": "http://example.com",
      "start_time": "2018-02-02T22:25:27.521Z",
      "status": "pending",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ]
}

Create a Wireless Detail Records (WDRs) ReportcreateWdrReport

post https://api.telnyx.com/v2/wireless/detail_records_reports

Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"end_time":"2018-02-02T22:25:27.521Z","start_time":"2018-02-02T22:25:27.521Z"}' \
  https://api.telnyx.com/v2/wireless/detail_records_reports
Parameters
In body
end_time
string
optional

ISO 8601 formatted date-time indicating the end time.

Example: "2018-02-02T22:25:27.521Z"
start_time
string
optional

ISO 8601 formatted date-time indicating the start time.

Example: "2018-02-02T22:25:27.521Z"
Responses
201

Successful response

422

Unprocessable entity. Check the 'detail' field in response for details.

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "end_time": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "detail_records_report",
    "report_url": "http://example.com",
    "start_time": "2018-02-02T22:25:27.521Z",
    "status": "pending",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Get a Wireless Detail Record (WDR) ReportgetWdrReport

get https://api.telnyx.com/v2/wireless/detail_records_reports/{id}

Returns one specific WDR report

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Parameters
In path
id
string (uuid)
required

Identifies the resource.

Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Responses
200

Successful response

404

Resource not found

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "end_time": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "detail_records_report",
    "report_url": "http://example.com",
    "start_time": "2018-02-02T22:25:27.521Z",
    "status": "pending",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Delete a Wireless Detail Record (WDR) ReportdeleteWdrReport

delete https://api.telnyx.com/v2/wireless/detail_records_reports/{id}

Deletes one specific WDR report

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Parameters
In path
id
string (uuid)
required

Identifies the resource.

Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Responses
200

Successful response

404

Resource not found

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "end_time": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "detail_records_report",
    "report_url": "http://example.com",
    "start_time": "2018-02-02T22:25:27.521Z",
    "status": "pending",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Was this section helpful?was-this-page-helpful