List all Fax Applications

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "filter[application_name][contains]": {
      "type": "string"
    },
    "filter[outbound_voice_profile_id]": {
      "type": "string",
      "format": "int64"
    },
    "page[number]": {
      "type": "integer"
    },
    "page[size]": {
      "type": "integer"
    },
    "sort": {
      "type": "string",
      "enum": [
        "created_at",
        "connection_name",
        "active"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean",
            "description": "Specifies whether the connection can be used."
          },
          "anchorsite_override": {
            "type": "string",
            "description": "`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.",
            "enum": [
              "Latency",
              "Chicago, IL",
              "Ashburn, VA",
              "San Jose, CA",
              "Sydney, Australia",
              "Amsterdam, Netherlands",
              "London, UK",
              "Toronto, Canada",
              "Vancouver, Canada",
              "Frankfurt, Germany"
            ]
          },
          "application_name": {
            "type": "string",
            "description": "A user-assigned name to help manage the application."
          },
          "created_at": {
            "type": "string",
            "description": "ISO 8601 formatted date indicating when the resource was created."
          },
          "id": {
            "type": "string",
            "format": "int64",
            "description": "Uniquely identifies the resource."
          },
          "inbound": {
            "type": "object",
            "properties": {
              "channel_limit": {
                "type": "integer",
                "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection."
              },
              "sip_subdomain": {
                "type": "string",
                "description": "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": {
                "type": "string",
                "description": "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).",
                "enum": [
                  "only_my_connections",
                  "from_anyone"
                ]
              }
            }
          },
          "outbound": {
            "type": "object",
            "properties": {
              "channel_limit": {
                "type": "integer",
                "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection."
              },
              "outbound_voice_profile_id": {
                "type": "string",
                "format": "int64",
                "description": "Identifies the associated outbound voice profile."
              }
            }
          },
          "record_type": {
            "type": "string",
            "description": "Identifies the type of the resource."
          },
          "updated_at": {
            "type": "string",
            "description": "ISO 8601 formatted date indicating when the resource was updated."
          },
          "webhook_event_failover_url": {
            "type": "string",
            "format": "url",
            "description": "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_url": {
            "type": "string",
            "format": "url",
            "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'."
          },
          "webhook_timeout_secs": {
            "type": "integer",
            "description": "Specifies how many seconds to wait before timing out a webhook."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page_number": {
          "type": "integer"
        },
        "page_size": {
          "type": "integer"
        },
        "total_pages": {
          "type": "integer"
        },
        "total_results": {
          "type": "integer"
        }
      }
    }
  }
}