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 response = await client.texml.accounts.calls.retrieveCalls('account_sid');

console.log(response.calls);

{
  "calls": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1"
}

GET

texml

Accounts

{account_sid}

Calls

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.texml.accounts.calls.retrieveCalls('account_sid');

console.log(response.calls);

{
  "calls": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

account_sid

string

required

The id of the account the resource belongs to.

Query Parameters

Page

integer

The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

PageSize

integer

The number of records to be displayed on a page

PageToken

string

Used to request the next page of results.

string

Filters calls by the to number.

From

string

Filters calls by the from number.

Status

enum<string>

Filters calls by status.

Available options:

canceled,

completed,

failed,

busy,

no-answer

StartTime

string

Filters calls by their start date. Expected format is YYYY-MM-DD.

StartTime_gt

string

Filters calls by their start date (after). Expected format is YYYY-MM-DD

StartTime_lt

string

Filters calls by their start date (before). Expected format is YYYY-MM-DD

EndTime

string

Filters calls by their end date. Expected format is YYYY-MM-DD

EndTime_gt

string

Filters calls by their end date (after). Expected format is YYYY-MM-DD

EndTime_lt

string

Filters calls by their end date (before). Expected format is YYYY-MM-DD

Response

Multiple call resources.

calls

Call resource · object[]

Show child attributes

calls.account_sid

string

The id of the account the resource belongs to.

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

calls.answered_by

enum<string>

The value of the answering machine detection result, if this feature was enabled for the call.

Available options:

human,

machine,

not_sure

Example:

"human"

calls.caller_name

string

Caller ID, if present.

Example:

"CALLER"

calls.date_created

string

The timestamp of when the resource was created.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

calls.date_updated

string

The timestamp of when the resource was last updated.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

calls.direction

enum<string>

The direction of this call.

Available options:

inbound,

outbound

Example:

"inbound"

calls.duration

string

The duration of this call, given in seconds.

Example:

"12"

calls.end_time

string

The end time of this call.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

calls.from

string

The phone number or SIP address that made this call.

Example:

"+13123456789"

calls.from_formatted

string

The from number formatted for display.

Example:

"(312) 345-6789"

calls.price

string

The price of this call, the currency is specified in the price_unit field. Only populated when the call cost feature is enabled for the account.

Example:

"0.10"

calls.price_unit

string

The unit in which the price is given.

Example:

"USD"

calls.sid

string

The identifier of this call.

Example:

"v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA"

calls.start_time

string

The start time of this call.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

calls.status

enum<string>

The status of this call.

Available options:

ringing,

in-progress,

canceled,

completed,

failed,

busy,

no-answer

Example:

"completed"

calls.to

string

The phone number or SIP address that received this call.

Example:

"+13987654321"

calls.to_formatted

string

The to number formatted for display.

Example:

"(398) 765-4321"

calls.uri

string

The relative URI for this call.

Example:

"/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json"

end

integer

The number of the last element on the page, zero-indexed.

Example:

19

first_page_uri

string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1

Example:

"accepted"

next_page_uri

string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ

Example:

"accepted"

page

integer

Current page number, zero-indexed.

Example:

0

page_size

integer

The number of items on the page

Example:

20

start

integer

The number of the first element on the page, zero-indexed.

Example:

0

uri

string

The URI of the current page.

Example:

"/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1"

Create a TeXML secret Initiate an outbound call

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Fetch multiple call resources

Authorizations

Path Parameters

Query Parameters

Response