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 csvDownload = await client.phoneNumbers.csvDownloads.create();

console.log(csvDownload.data);

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "csv_download",
      "url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "status": "pending"
    }
  ]
}

POST

phone_numbers

csv_downloads

JavaScript

import Telnyx from 'telnyx';

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

const csvDownload = await client.phoneNumbers.csvDownloads.create();

console.log(csvDownload.data);

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "csv_download",
      "url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "status": "pending"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

csv_format

enum<string>

default:V1

Which format to use when generating the CSV file. The default for backwards compatibility is 'V1'

Available options:

V1,

V2

Example:

"V2"

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[has_bundle], filter[tag], filter[connection_id], filter[phone_number], filter[status], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference]

Show child attributes

filter[has_bundle]

string

Filter by phone number that have bundles.

filter[tag]

string

Filter by phone number tags.

filter[connection_id]

string

Filter by connection_id.

Example:

"1521916448077776306"

filter[phone_number]

string

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

filter[status]

enum<string>

Filter by phone number status.

Available options:

purchase-pending,

purchase-failed,

port-pending,

active,

deleted,

port-failed,

emergency-only,

ported-out,

port-out-pending

Example:

"active"

filter[voice.connection_name]

object

Filter by voice connection name pattern matching.

Show child attributes

filter[voice.connection_name][contains]

string

Filter contains connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][starts_with]

string

Filter starts with connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][ends_with]

string

Filter ends with connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][eq]

string

Filter by connection name.

Example:

"test"

filter[voice.usage_payment_method]

enum<string>

Filter by usage_payment_method.

Available options:

pay-per-minute,

channel

Example:

"channel"

filter[billing_group_id]

string

Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.

Example:

"62e4bf2e-c278-4282-b524-488d9c9c43b2"

filter[emergency_address_id]

string

Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.

Example:

"9102160989215728032"

filter[customer_reference]

string

Filter numbers via the customer_reference set.

Response

Successful response with details about a CSV download.

data

object[]

Show child attributes

data.id

string

Identifies the resource.

Example:

"42587e44-3a3e-46de-9255-0c9a7a1d1ec7"

data.record_type

string

Identifies the type of the resource.

Example:

"csv_download"

data.url

string

The URL at which the CSV file can be retrieved.

Example:

"https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"

data.status

enum<string>

default:pending

Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved.

Available options:

pending,

complete,

failed,

expired

Example:

"pending"

List CSV downloads Retrieve a CSV download

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Create a CSV download

Authorizations

Query Parameters

Response