This is the API V2 documentation. To switch out of beta revert back to our API V1.

Telnyx DevelopersDevelopers
Sign inTelnyx Developers
Open Menu
DocsAPI ReferenceJoin Slack Community
Create an AccountSign in
Questions on setup? Talk to our experts
Open SidemenuDocs
Docs
Close Sidemenu

Sending Commandssending-commands

A Programmable Fax API command is sent with a fax_id. The fax_id allows a user to communicate to Telnyx the fax the user wants to take an action on.

Authenticationauthentication

To send a Programmable Fax API command from your application, you must authenticate your request by sending the Authorization header with a value of a key:secret pair. A key and secret can be retrieved from Auth in the Mission Control Portal under the tab Auth v2, or via the Telnyx API.

Credential TypeHTTP Header Format
Key + SecretAuthorization: Basic base64(":")

Available Commands and their Expected Webhooksavailable-commands-and-their-expected-webhooks

Telnyx sends webhooks to update on the status of Programmable Fax. Webhooks will also be sent in response to requests to list and delete faxes.

Command Associated Webhooks
Send a fax fax.queued
fax.media.processed
fax.sending.started
fax.delivered
fax.failed

Response when sending command

When you send a Programmable Fax API Command, you will immediately receive an http response. Responses include, but are not limited to:

HTTP Status CodeMessageDescription
200OKThe request succeeded.
403ForbiddenThe request was valid, however the user is not authorized to perform this action.
404Not FoundThe requested resource could not be found.
422Invalid ParametersThe request has invalid parameters.

Was this page helpful?