Programmable Fax Applications

List all Fax Applications

Changed on

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.

get/fax_applications

Request

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

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

outbound_voice_profile_idstring

Identifies the associated outbound voice profile.

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]

{
  "application_name": {
    "contains": "fax-app"
  },
  "outbound_voice_profile_id": "1293384261075731499"
}
sort'created_at' | 'application_name' | 'active'
Example:application_name

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>application_name</code>: sorts the result by the <code>application_name</code> field in ascending order. </li> <li> <code>-application_name</code>: sorts the result by the <code>application_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.

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

Changes

  • a72569d69430Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • warning

      deleted the query request parameter page[number]

    • warning

      deleted the query request parameter page[size]

    • info

      added the new optional query request parameter page