Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Programmable Fax Commands API

Programmable fax command operations

Telnyx Programmable Fax Commands API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Programmable Fax Commands. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

6 operations 4 paths 18 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Programmable Fax Commands API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Programmable Fax Commands 6

Programmable fax command operations

GET
/faxes
View a list of faxes
ListFaxes 2 params → 200404default
POST
/faxes
Send a fax
SendFax body → 202422default
DELETE
/faxes/{id}
Delete a fax
DeleteFax 1 param → 204404default
GET
/faxes/{id}
View a fax
ViewFax 1 param → 200404default
POST
/faxes/{id}/actions/cancel
Cancel a fax
CancelFax 1 param → 202404422default
POST
/faxes/{id}/actions/refresh
Refresh a fax
RefreshFax 1 param → 200404default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Fax (19 properties), SendFaxRequest (15 properties), SendFaxMultipartRequest (9 properties), programmable-fax_Error (5 properties). Each schema is shown below with its type and property counts.

MediaUrl
string
The URL (or list of URLs) to the PDF used for the fax's media. mediaurl and medianame/contents can't be submitted together.
From
string
The phone number, in E.164 format, the fax will be sent from.
StoreMedia
boolean
Should fax media be stored on temporary URL. It does not support medianame, they can't be submitted together.
Quality
string
The quality of the fax. The ultra settings provides the highest quality available, but also present longer fax processing times. ultralight is best suited for…
To
string
The phone number, in E.164 format, the fax will be sent to or SIP URI
ConnectionId
string
The ID of the connection used to send the fax.
programmable-fax_Error
object
5 properties 2 required
SendFaxRequest
object
15 properties 3 required
Direction
string
The direction of the fax.
StorePreview
boolean
Should fax preview be stored on temporary URL.
Monochrome
boolean
The flag to enable monochrome, true black and white fax results.
T38Enabled
boolean
The flag to disable the T.38 protocol.
Id
string
Identifies the type of resource.
Fax
object
19 properties
PaginationMeta
object
4 properties
MediaName
string
The medianame used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. medianame and mediau…
SendFaxMultipartRequest
object
9 properties 4 required
programmable-fax_Errors
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-programmable-fax-commands-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API