Telnyx

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const outboundVoiceProfile of client.outboundVoiceProfiles.list()) {
  console.log(outboundVoiceProfile.id);
}

{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "outbound_voice_profile",
      "name": "office",
      "connections_count": 12,
      "traffic_type": "conversational",
      "service_plan": "global",
      "concurrent_call_limit": 10,
      "enabled": true,
      "tags": [
        "office-profile"
      ],
      "usage_payment_method": "rate-deck",
      "whitelisted_destinations": [
        "US",
        "BR",
        "AU"
      ],
      "max_destination_rate": 10,
      "daily_spend_limit": "100.00",
      "daily_spend_limit_enabled": true,
      "call_recording": {
        "call_recording_type": "by_caller_phone_number",
        "call_recording_caller_phone_numbers": [
          "+19705555098"
        ],
        "call_recording_channels": "dual",
        "call_recording_format": "mp3"
      },
      "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "calling_window": {
        "start_time": "08:00:00.00Z",
        "end_time": "20:00:00.00Z",
        "calls_per_cld": 5
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

outbound_voice_profiles

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const outboundVoiceProfile of client.outboundVoiceProfiles.list()) {
  console.log(outboundVoiceProfile.id);
}

{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "outbound_voice_profile",
      "name": "office",
      "connections_count": 12,
      "traffic_type": "conversational",
      "service_plan": "global",
      "concurrent_call_limit": 10,
      "enabled": true,
      "tags": [
        "office-profile"
      ],
      "usage_payment_method": "rate-deck",
      "whitelisted_destinations": [
        "US",
        "BR",
        "AU"
      ],
      "max_destination_rate": 10,
      "daily_spend_limit": "100.00",
      "daily_spend_limit_enabled": true,
      "call_recording": {
        "call_recording_type": "by_caller_phone_number",
        "call_recording_caller_phone_numbers": [
          "+19705555098"
        ],
        "call_recording_channels": "dual",
        "call_recording_format": "mp3"
      },
      "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "calling_window": {
        "start_time": "08:00:00.00Z",
        "end_time": "20:00:00.00Z",
        "calls_per_cld": 5
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

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[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load.

Required range: x >= 1

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[name][contains]

Show child attributes

filter[name]

object

Name filtering operations

Show child attributes

filter[name][contains]

string

Optional filter on outbound voice profile name.

Example:

"office-profile"

sort

enum<string>

default:-created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

name: sorts the result by the name field in ascending order.
-name: sorts the result by the name field in descending order.

Available options:

enabled,

-enabled,

created_at,

-created_at,

name,

-name,

service_plan,

-service_plan,

traffic_type,

-traffic_type,

usage_payment_method,

-usage_payment_method

Example:

"name"

Response

Successful response

data

Outbound Voice Profile · object[]

Show child attributes

data.name

string

required

A user-supplied name to help with organization.

Minimum string length: 3

Example:

"office"

data.id

string

Identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"outbound_voice_profile"

data.connections_count

integer

Amount of connections associated with this outbound voice profile.

Example:

12

data.traffic_type

enum<string>

default:conversational

Specifies the type of traffic allowed in this profile.

Available options:

conversational

Example:

"conversational"

data.service_plan

enum<string>

default:global

Indicates the coverage of the termination regions.

Available options:

global

Example:

"global"

data.concurrent_call_limit

integer | null

Must be no more than your global concurrent call limit. Null means no limit.

Example:

10

data.enabled

boolean

default:true

Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.

Example:

true

data.tags

string[]

Example:

["office-profile"]

data.usage_payment_method

enum<string>

default:rate-deck

Setting for how costs for outbound profile are calculated.

Available options:

rate-deck

Example:

"rate-deck"

data.whitelisted_destinations

string[]

The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.

Example:

["US", "BR", "AU"]

data.max_destination_rate

number

Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.

data.daily_spend_limit

string

The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.

Example:

"100.00"

data.daily_spend_limit_enabled

boolean

default:false

Specifies whether to enforce the daily_spend_limit on this outbound voice profile.

Example:

true

data.call_recording

object

Show child attributes

data.call_recording.call_recording_type

enum<string>

Specifies which calls are recorded.

Available options:

all,

none,

by_caller_phone_number

data.call_recording.call_recording_caller_phone_numbers

string[]

When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format.

Example:

["+19705555098"]

data.call_recording.call_recording_channels

enum<string>

default:single

When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B.

Available options:

single,

dual

Example:

"dual"

data.call_recording.call_recording_format

enum<string>

default:wav

The audio file format for calls being recorded.

Available options:

wav,

mp3

Example:

"mp3"

Example:

{
  "call_recording_type": "by_caller_phone_number",
  "call_recording_caller_phone_numbers": ["+19705555098"],
  "call_recording_channels": "dual",
  "call_recording_format": "mp3"
}

data.billing_group_id

string<uuid> | null

The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.calling_window

object

(BETA) Specifies the time window and call limits for calls made using this outbound voice profile. Note that all times are UTC in 24-hour clock time.

Show child attributes

data.calling_window.start_time

string

(BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to start.

Example:

"08:00:00.00Z"

data.calling_window.end_time

string

(BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer allowed to start.

Example:

"20:00:00.00Z"

data.calling_window.calls_per_cld

integer

(BETA) The maximum number of calls that can be initiated to a single called party (CLD) within the calling window. A null value means no limit.

Example:

5

Example:

{
  "start_time": "08:00:00.00Z",
  "end_time": "20:00:00.00Z",
  "calls_per_cld": 5
}

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Get all outbound voice profiles

Authorizations

Query Parameters

Response