Skip to main content

Send a fax

POST 
/faxes

Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with file_size_limit_exceeded and page_count_limit_exceeded respectively.

Expected Webhooks:

  • fax.queued
  • fax.media.processed
  • fax.sending.started
  • fax.delivered
  • fax.failed

Request

Body

required

Send fax request

    connection_id stringrequired

    The connection ID to send the fax with.

    media_url MediaUrl (string)

    The URL (or list of URLs) to the PDF used for the fax's media. media_url and media_name/contents can't be submitted together.

    media_name MediaName (string)

    The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.

    to To (string)required

    The phone number, in E.164 format, the fax will be sent to or SIP URI

    from From (string)required

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

    from_display_name string

    The from_display_name string to be used as the caller id name (SIP From Display Name) presented to the destination (to number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the from field.

    quality Quality (string)

    Possible values: [normal, high, very_high, ultra_light, ultra_dark]

    Default value: high

    The quality of the fax. The ultra settings provides the highest quality available, but also present longer fax processing times. ultra_light is best suited for images, wihle ultra_dark is best suited for text.

    t38_enabled boolean

    Default value: true

    The flag to disable the T.38 protocol.

    monochrome boolean

    The flag to enable monochrome, true black and white fax results.

    store_media boolean

    Should fax media be stored on temporary URL. It does not support media_name, they can't be submitted together.

    store_preview boolean

    Should fax preview be stored on temporary URL.

    webhook_url string

    Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.

Responses

202: Send fax response

default: Unexpected error

Callbacks

Loading...