Programmable Fax Applications

Creates a Fax Application

Changed on

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

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/fax_applications
  • Auth: HTTP bearer

Request body

application_namestring required

A user-assigned name to help manage the application.

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.

webhook_event_urlstring uri required

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

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_timeout_secsinteger nullable

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

tagsstring[]

Tags associated with the Fax Application.

Example request

{
  "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,
  "tags": [
    "tag1",
    "tag2"
  ],
  "inbound": {
    "channel_limit": 10,
    "sip_subdomain": "example",
    "sip_subdomain_receive_settings": "only_my_connections"
  },
  "outbound": {
    "channel_limit": 10,
    "outbound_voice_profile_id": "1293384261075731499"
  }
}

Response

Successful response

Example response

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

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status