Skip to main content

Update a fax

POST 
/Accounts/:AccountSid/Faxes/:Sid

Allows you to modify the properties of Fax.

Permissions​

The API token must include the following scopes: Fax.

Request​

Path Parameters

    AccountSid uuidrequired

    The Project ID that uniquely identifies the Account to retrieve.

    Sid uuidrequired

    The Fax ID that uniquely identifies the Fax to retrieve.

Body

    Status string

    Possible values: [queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, canceled]

    The status of the fax.

Responses​

OK

Schema

    account_sid string

    The unique identifier for the account this fax is associated with.

    api_version string

    The version of the SignalWire API.

    date_created string

    The date and time, in ISO 8601 format, the fax was created.

    date_updated string

    The date and time, in ISO 8601 format, the fax was updated.

    direction string

    Possible values: [inbound, outbound]

    The direction of the fax. Possible values are inbound or outbound.

    from string

    The phone number, in E.164 format, the fax was sent from.

    media_url string

    The URL hosting the received media. Can use this URL to download incoming media. Optionally pass a username and password using the format "https://user:pass@example.com/path/to/fax.pdf".

    media_sid string

    ThThe unique identifier for the media instance associated with the fax instance.

    num_pages string

    The number of pages in the fax document.

    price string

    The cost of the fax.

    price_unit string

    The currency, in ISO 4217 format, of the price.

    quality string

    Possible values: [standard, fine, superfine]

    The quality of the fax.

    sid string

    The unique identifier of the fax.

    status string

    Possible values: [queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, canceled]

    The status of the fax.

    to string

    The phone number, in E.164 format, the fax was sent to.

    duration integer

    The time, in seconds, it took to deliver a fax.

    links

    object

    The URL links for resources associated with the fax.

    media string

    Media associated with this fax.

    url string

    The URL of this resource.

    error_code string

    Error code for this resource (if available).

    error_message string

    The description of this error (if available).

Loading...