Creates a Fax Application

POST /fax_applications

Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the /phone_numbers endpoint.

Request

application/json

Body

required

Parameters that can be set when creating a Fax Application

application_name Application Name (string)required

A user-assigned name to help manage the application.

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

anchorsite_override Anchorsite Override (string)

Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

Default value: 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.

webhook_event_url urlrequired

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

webhook_event_failover_url urlnullable

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'.

webhook_timeout_secs Webhook Timeout Secs (integer)nullable

Possible values: <= 30

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

inbound

object

channel_limit integer

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

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.

sip_subdomain_receive_settings string

Possible values: [only_my_connections, from_anyone]

Default value: 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).

outbound

object

channel_limit integer

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

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

Responses

201: Successful response

application/json

Schema

data

object

id int64

Uniquely identifies the resource.

record_type string

Identifies the type of the resource.

application_name Application Name (string)

A user-assigned name to help manage the application.

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

anchorsite_override Anchorsite Override (string)

Default value: Latency

webhook_event_url url

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

webhook_event_failover_url urlnullable

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'.

webhook_timeout_secs Webhook Timeout Secs (integer)nullable

Possible values: <= 30

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

inbound

object

channel_limit integer

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

sip_subdomain string

sip_subdomain_receive_settings string

Possible values: [only_my_connections, from_anyone]

Default value: 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).

outbound

object

channel_limit integer

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

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

created_at string

ISO 8601 formatted date indicating when the resource was created.

updated_at string

ISO 8601 formatted date indicating when the resource was updated.

{
  "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"
  }
}

401: Unauthorized

application/json

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

403: Unauthorized

422: Unprocessable entity

Creates a Fax Application

Request​

Body

Responses​

Request

Responses