For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing
the word Basic followed by a space and a base64-encoded string of project_id:token.
The project ID will be used as the username and the API token as the password.
Example:
```
Authorization: Basic base64(project_id:token)
```
Path parameters
AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
SidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.
Response
The request has succeeded.
account_sidstring
The unique identifier for the account this fax is associated with.
api_versionstring
The version of the SignalWire API.
date_createdstring
The date and time, in ISO 8601 format, the fax was created.
date_updatedstring
The date and time, in ISO 8601 format, the fax was updated.
directionenum
The direction of the fax.
Allowed values:
fromstring
The phone number, in E.164 format, the fax was sent from.
media_urlstring or null
The URL hosting the received media, or null if not available.
media_sidstring
The unique identifier for the media instance associated with the fax instance.
num_pagesstring or null
The number of pages in the fax document, or null if not yet determined.
pricestring or null
The cost of the fax, or null if not yet calculated.
price_unitstring
The currency, in ISO 4217 format, of the price.
qualityenum
The quality of the fax.
Allowed values:
sidstring
The unique identifier of the fax.
statusenum
The status of the fax.
tostring
The phone number, in E.164 format, the fax was sent to.
durationinteger
The time, in seconds, it took to deliver a fax.
linksobject
The URL links for resources associated with the fax.
urlstring
The URL of this resource.
error_codestring or null
Error code for this resource, or null if no error.
error_messagestring or null
The description of this error, or null if no error.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing
the word Basic followed by a space and a base64-encoded string of project_id:token.
The project ID will be used as the username and the API token as the password.
SignalWire Docs