Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('id');

console.log(numberLookup.data);

{
  "data": {
    "id": "9783f4d7-0bfc-427a-9d6b-bc659ad16e5b",
    "start_date": "2025-11-01",
    "end_date": "2025-12-01",
    "aggregation_type": "ALL",
    "status": "COMPLETE",
    "report_url": "https://portal-cdrs-usage.s3.amazonaws.com/telco_data_usage_report_2025-12-02.csv",
    "created_at": "2025-12-02T20:20:57.196925Z",
    "updated_at": "2025-12-02T20:21:08.237091Z",
    "managed_accounts": [],
    "result": [
      {
        "user_id": "d37bdd47-f301-42ec-b2ad-5a0465bfb632",
        "aggregations": [
          {
            "type": "CNAM",
            "total_dips": 3,
            "total_cost": 0.009,
            "currency": "USD"
          }
        ],
        "record_type": "TelcoDataUsageRecord"
      }
    ],
    "record_type": "TelcoDataUsageReport"
  }
}

GET

legacy_reporting

usage_reports

number_lookup

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('id');

console.log(numberLookup.data);

{
  "data": {
    "id": "9783f4d7-0bfc-427a-9d6b-bc659ad16e5b",
    "start_date": "2025-11-01",
    "end_date": "2025-12-01",
    "aggregation_type": "ALL",
    "status": "COMPLETE",
    "report_url": "https://portal-cdrs-usage.s3.amazonaws.com/telco_data_usage_report_2025-12-02.csv",
    "created_at": "2025-12-02T20:20:57.196925Z",
    "updated_at": "2025-12-02T20:21:08.237091Z",
    "managed_accounts": [],
    "result": [
      {
        "user_id": "d37bdd47-f301-42ec-b2ad-5a0465bfb632",
        "aggregations": [
          {
            "type": "CNAM",
            "total_dips": 3,
            "total_cost": 0.009,
            "currency": "USD"
          }
        ],
        "record_type": "TelcoDataUsageRecord"
      }
    ],
    "record_type": "TelcoDataUsageReport"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

Successfully retrieved telco data usage report

data

object

Telco data usage report response

Show child attributes

data.id

string<uuid>

Unique identifier for the report

Example:

"9783f4d7-0bfc-427a-9d6b-bc659ad16e5b"

data.start_date

string<date>

Start date of the report period

Example:

"2025-11-01"

data.end_date

string<date>

End date of the report period

Example:

"2025-12-01"

data.aggregation_type

string

Type of aggregation used in the report

Example:

"ALL"

data.status

string

Current status of the report

Example:

"COMPLETE"

data.report_url

string

URL to download the complete report

Example:

"https://portal-cdrs-usage.s3.amazonaws.com/telco_data_usage_report_2025-12-02.csv"

data.created_at

string<date-time>

Timestamp when the report was created

Example:

"2025-12-02T20:20:57.196925Z"

data.updated_at

string<date-time>

Timestamp when the report was last updated

Example:

"2025-12-02T20:21:08.237091Z"

data.managed_accounts

string[]

List of managed account IDs included in the report

Example:

[]

data.result

object[]

Array of usage records

Show child attributes

data.result.user_id

string<uuid>

User ID

Example:

"d37bdd47-f301-42ec-b2ad-5a0465bfb632"

data.result.aggregations

object[]

List of aggregations by lookup type

Show child attributes

data.result.aggregations.type

string

Type of telco data lookup

Example:

"CNAM"

data.result.aggregations.total_dips

integer

Total number of lookups performed

Example:

3

data.result.aggregations.total_cost

number

Total cost for this aggregation

Example:

0.009

data.result.aggregations.currency

string

Currency code

Example:

"USD"

data.result.record_type

string

Record type identifier

Example:

"TelcoDataUsageRecord"

data.record_type

string

Record type identifier

Example:

"TelcoDataUsageReport"

Submit telco data usage report Delete telco data usage report

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Get telco data usage report by ID

Authorizations

Path Parameters

Response