Skip to main content

Send a Fax

POST 
/Accounts/:AccountSid/Faxes

Send a 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.

Body

    MediaUrl stringrequired

    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".

    Example: https://example.com/fax.pdf
    To stringrequired

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

    Example: +13104456789
    From stringrequired

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

    Example: +13103383454
    Quality string

    The quality of the fax.

    Possible values: [standard, fine, superfine]

    Example: standard
    StatusCallback string

    The URL to send a POST request when the status of a fax changes. See here for the list of parameters passed back to your endpoint.

    Example: https://your-api-endpoint.com/path

Responses​

OK

Schema

    account_sid string

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

    Example: b3877c40-da60-4998-90ad-b792e98472ac
    api_version string

    The version of the SignalWire API.

    Example: v1
    date_created string

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

    Example: 2018-11-26T20:00:00Z
    date_updated string

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

    Example: 2018-11-27T20:00:00Z
    direction string

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

    Possible values: [inbound, outbound]

    Example: outbound
    from string

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

    Example: +13103383454
    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".

    Example: https://example.com/fax.pdf
    media_sid string

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

    Example: b3877c40-da60-4998-90ad-b792e98472me
    num_pages string

    The number of pages in the fax document.

    Example: null
    price string

    The cost of the fax.

    Example: null
    price_unit string

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

    Example: null
    quality string

    The quality of the fax.

    Possible values: [standard, fine, superfine]

    Example: standard
    sid string

    The unique identifier of the fax.

    Example: b3877c40-da60-4998-90ad-b792e98472fx
    status string

    The status of the fax.

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

    Example: queued
    to string

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

    Example: +13104456789
    duration integer

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

    Example: 5000

    links

    object

    The URL links for resources associated with the fax.

    media string

    Media associated with this fax.

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media
    url string

    The URL of this resource.

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx
    error_code string

    Error code for this resource (if available).

    Example: 34004
    error_message string

    The description of this error (if available).

    Example: The call dropped prematurely