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 faxApplication = await client.faxApplications.retrieve('1293384261075731499');

console.log(faxApplication.data);

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "fax_application",
    "application_name": "fax-router",
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_timeout_secs": 25,
    "inbound": {
      "channel_limit": 10,
      "sip_subdomain": "example",
      "sip_subdomain_receive_settings": "only_my_connections"
    },
    "outbound": {
      "channel_limit": 10,
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

GET

fax_applications

{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 faxApplication = await client.faxApplications.retrieve('1293384261075731499');

console.log(faxApplication.data);

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "fax_application",
    "application_name": "fax-router",
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_timeout_secs": 25,
    "inbound": {
      "channel_limit": 10,
      "sip_subdomain": "example",
      "sip_subdomain_receive_settings": "only_my_connections"
    },
    "outbound": {
      "channel_limit": 10,
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Identifies the resource.

Example:

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

Response

Successful response

data

Fax Application · object

Show child attributes

data.id

string

Uniquely identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"fax_application"

data.application_name

string

A user-assigned name to help manage the application.

Example:

"call-router"

data.active

boolean

default:true

Specifies whether the connection can be used.

Example:

false

data.anchorsite_override

enum<string>

default:Latency

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Available options:

Latency,

Chicago, IL,

Ashburn, VA,

San Jose, CA,

Sydney, Australia,

Amsterdam, Netherlands,

London, UK,

Toronto, Canada,

Vancouver, Canada,

Frankfurt, Germany

Example:

"Amsterdam, Netherlands"

data.webhook_event_url

string<uri>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

data.webhook_event_failover_url

string<uri> | null

default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

data.webhook_timeout_secs

integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30

Example:

25

data.tags

string[]

Tags associated with the Fax Application.

Example:

["tag1", "tag2"]

data.inbound

object

Show child attributes

data.inbound.channel_limit

integer

When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

Example:

10

data.inbound.sip_subdomain

string

Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.

Example:

"example"

data.inbound.sip_subdomain_receive_settings

enum<string>

default:from_anyone

This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).

Available options:

only_my_connections,

from_anyone

Example:

"only_my_connections"

data.outbound

object

Show child attributes

data.outbound.channel_limit

integer

When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

Example:

10

data.outbound.outbound_voice_profile_id

string

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

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

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

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

Example:

{
  "id": "1293384261075731499",
  "record_type": "fax_application",
  "application_name": "fax-router",
  "active": false,
  "anchorsite_override": "Amsterdam, Netherlands",
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_timeout_secs": 25,
  "inbound": {
    "channel_limit": 10,
    "sip_subdomain": "example",
    "sip_subdomain_receive_settings": "only_my_connections"
  },
  "outbound": {
    "channel_limit": 10,
    "outbound_voice_profile_id": "1293384261075731499"
  },
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z"
}

Creates a Fax Application Deletes a Fax Application

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Retrieve a Fax Application

Authorizations

Path Parameters

Response