Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Programmable Fax Applications

Creates a Fax Application

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.

post/fax_applications

Request body

activeboolean

Specifies whether the connection can be used.

anchorsite_override'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany'

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.

application_namestring required

A user-assigned name to help manage the application.

tagsstring[]

Tags associated with the Fax Application.

webhook_event_failover_urlstring uri nullable

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_event_urlstring uri required

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

webhook_timeout_secsinteger nullable

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

Example request

{
  "active": false,
  "anchorsite_override": "Amsterdam, Netherlands",
  "application_name": "fax-router",
  "inbound": {
    "channel_limit": 10,
    "sip_subdomain": "example",
    "sip_subdomain_receive_settings": "only_my_connections"
  },
  "outbound": {
    "channel_limit": 10,
    "outbound_voice_profile_id": "1293384261075731499"
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_event_url": "https://example.com",
  "webhook_timeout_secs": 25
}

Response

Successful response

Example response

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