Interface FaxRequestBase

The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the callbackUrl parameter, if provided, otherwise it will be sent to the URL specified in the callbackUrl field of the Fax Service object.

Note: If a callback URL uses basicauth credentials, when the callback URL is retrieved those credentials are masked. It is not possible to retrieve previously-set credentials through the API.

The content type of the callback.

You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this here. All keys used must be lower case.

The cover page id you want to use for the fax

A phone number in E.164 format, including the leading '+'.

If true, page numbers will be displayed in the header. Default is true.

Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.

A TZ database name string specifying the timezone for the header timestamp.

Determines how documents are converted to black and white. Defaults to value selected on Fax Service object.

You can use this to attach labels to your call that you can use in your applications. It is a key value store.

The number of times the fax will be retired before cancel. Default value is set in your fax service. The maximum number of retries is 5.

The number of seconds to wait between retries if the fax is not yet completed.

ID of the fax service used.