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
-
application_name
: sorts the result by theapplication_name
field in ascending order. -
-application_name
: sorts the result by theapplication_name
field in descending order.
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]
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:
If not given, results are sorted by
created_at
Responses
200: Successful response
- application/json
400: Bad request, the request was unacceptable, often due to missing a required parameter.
- application/json
401: Unauthorized
- application/json
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
}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}