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
-
connection_name
: sorts the result by theconnection_name
field in ascending order. -
-connection_name
: sorts the result by theconnection_name
field in descending order.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 250
The size of the page
If present, applications with application_name
containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Identifies the associated outbound voice profile.
Possible values: [created_at
, connection_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:
If not given, results are sorted by
created_at
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Uniquely identifies the resource.
Identifies the type of the resource.
A user-assigned name to help manage the application.
Default value: true
Specifies whether the connection can be used.
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.
The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
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'.
Possible values: <= 30
Specifies how many seconds to wait before timing out a webhook.
inbound
object
When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.
Possible values: [pdf
, tiff
]
Default value: pdf
The file type used for inbound faxes.
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.
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
When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.
Identifies the associated outbound voice profile.
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
meta
object
{
"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,
"inbound_fax_file_type": "pdf",
"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
}
}
400: Bad request, the request was unacceptable, often due to missing a required parameter.
- application/json
- Schema
- Example (from schema)
- missingParameter
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request failed because it was not well-formed.",
"source": {
"pointer": "/"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
401: Unauthorized
- application/json
- Schema
- Example (from schema)
- Authentication Failed
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "Could not understand the provided credentials.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}
403: The user doesn't have the required permissions to perform the requested action.
- application/json
- Schema
- Example (from schema)
- notAuthorized
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10010",
"title": "Not authorized",
"detail": "You are not authorized to access the requested resource.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10010"
},
"source": {
"pointer": "/"
}
}
]
}