REST Client MethodsFaxes

Update

View as Markdown

Use this endpoint for the Fax method to update the Status of a Fax.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
SidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.

Request

StatusenumRequired
The status to set. Only 'canceled' is allowed. The fax must be in 'queued' status to be canceled.
Allowed values:

Response

account_sidstringRequired
The unique identifier for the account this fax is associated with.
api_versionstringRequired
The version of the SignalWire API.
date_createdstringRequired
The date and time, in ISO 8601 format, the fax was created.
date_updatedstringRequired
The date and time, in ISO 8601 format, the fax was updated.
directionenumRequired
The direction of the fax.
Allowed values:
fromstringRequired
The phone number, in E.164 format, the fax was sent from.
media_urlstring or nullRequired
The URL hosting the received media, or null if not available.
media_sidstringRequired
The unique identifier for the media instance associated with the fax instance.
num_pagesstring or nullRequired
The number of pages in the fax document, or null if not yet determined.
pricestring or nullRequired
The cost of the fax, or null if not yet calculated.
price_unitstringRequired
The currency, in ISO 4217 format, of the price.
qualityenumRequired
The quality of the fax.
Allowed values:
sidstringRequired
The unique identifier of the fax.
statusenumRequired
The status of the fax.
tostringRequired
The phone number, in E.164 format, the fax was sent to.
durationintegerRequired
The time, in seconds, it took to deliver a fax.
urlstringRequired
The URL of this resource.
error_codestring or nullRequired
Error code for this resource, or null if no error.
error_messagestring or nullRequired
The description of this error, or null if no error.

Request examples

In this example request, we update the Status of a Fax to Canceled.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.fax.faxes('FaxSid')
5          .update({status: 'canceled'})
6          .then(fax => console.log(fax.to))
7          .done();