Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const customerServiceRecords = await client.customerServiceRecords.list(); console.log(customerServiceRecords.data);

{ "data": [ { "id": "f1486bae-f067-460c-ad43-73a92848f902", "phone_number": "+12065551212", "status": "completed", "error_message": "CSR information not available.", "result": { "carrier_name": "ABC CARRIER, INC.", "associated_phone_numbers": [ "+12065551212" ], "admin": { "name": "John Doe", "billing_phone_number": "+12065551212", "account_number": "1234567890", "authorized_person_name": "John Doe" }, "address": { "administrative_area": "NY", "locality": "New York", "postal_code": "10001", "street_address": "123 Main St", "full_address": "123 Main St; New York; NY; 10001" } }, "record_type": "customer_service_record", "created_at": "2021-03-19T10:07:15.527Z", "updated_at": "2021-03-19T10:07:15.527Z" } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

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

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[phone_number][eq], filter[phone_number][in][], filter[status][eq], filter[status][in][], filter[created_at][lt], filter[created_at][gt]

Show child attributes

filter[phone_number]

object

Show child attributes

filter[phone_number][eq]

string

Filters records to those with a specified number.

Example:

"+12441239999"

filter[phone_number][in]

string[]

Filters records to those with at least one number in the list.

filter[status]

object

Show child attributes

filter[status][eq]

enum<string>

Filters records to those with a specific status.

Available options:

pending,

completed,

failed

Example:

"pending"

filter[status][in]

enum<string>[]

Filters records to those with a least one status in the list.

Available options:

pending,

completed,

failed

filter[created_at]

object

Show child attributes

filter[created_at][lt]

string<date-time>

Filters records to those created before a specific date.

Example:

"2020-01-01T00:00:00Z"

filter[created_at][gt]

string<date-time>

Filters records to those created after a specific date.

Example:

"2020-01-01T00:00:00Z"

sort

object

Consolidated sort parameter (deepObject style). Originally: sort[value]

Show child attributes

sort[value]

enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:

created_at,

-created_at

Example:

"created_at"

Response

Successful Response

data

object[]

Show child attributes

data.id

string<uuid>

Uniquely identifies this customer service record

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.phone_number

string

The phone number of the customer service record.

Example:

"+12065551212"

data.status

enum<string>

The status of the customer service record

Available options:

pending,

completed,

failed

Example:

"completed"

data.error_message

string

The error message in case status is failed. This field would be null in case of pending or completed status.

Example:

"CSR information not available."

data.result

object

The result of the CSR request. This field would be null in case of pending or failed status.

Show child attributes

data.result.carrier_name

string

The name of the carrier that the customer service record is for.

Example:

"ABC CARRIER, INC."

data.result.associated_phone_numbers

string[]

The associated phone numbers of the customer service record.

data.result.admin

object

The admin of the customer service record.

Show child attributes

data.result.admin.name

string

The name of the customer service record.

Example:

"John Doe"

data.result.admin.billing_phone_number

string

The billing phone number of the customer service record.

Example:

"+12065551212"

data.result.admin.account_number

string

The account number of the customer service record.

Example:

"1234567890"

data.result.admin.authorized_person_name

string

The authorized person name of the customer service record.

Example:

"John Doe"

data.result.address

object

The address of the customer service record

Show child attributes

data.result.address.administrative_area

string

The state of the address

Example:

"NY"

data.result.address.locality

string

The city of the address

Example:

"New York"

data.result.address.postal_code

string

The zip code of the address

Example:

"10001"

data.result.address.street_address

string

The street address

Example:

"123 Main St"

data.result.address.full_address

string

The full address

Example:

"123 Main St; New York; NY; 10001"

data.record_type

string

Identifies the type of the resource.

Example:

"customer_service_record"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527Z"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup