Skip to main content

List all Fax Applications

GET 
/fax_applications

This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[application_name][contains] string

    If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

    filter[outbound_voice_profile_id] string

    Identifies the associated outbound voice profile.

    sort string

    Possible values: [created_at, application_name, active]

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

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

    If not given, results are sorted by 
    created_at
    in descending order.

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id Int ID (string)

    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)

    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 uri

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

    webhook_event_failover_url urinullable

    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.

    tags string[]

    Default value: ``

    Tags associated with the Fax Application.

    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 Outbound Voice Profile ID (string)

    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.

  • ]

    • meta

    object

    page_number integer
    page_size integer
    total_pages integer
    total_results integer

400: Bad request, the request was unacceptable, often due to missing a required parameter.

Schema

    errors

    object[]

  • Array [

    • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string

  • ]

401: Unauthorized

Schema

    errors

    object[]

  • Array [

    • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string

  • ]

403: Unauthorized

Request samples

curl -L 'https://api.telnyx.com/v2/fax_applications' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}