Interface Fax

The bar codes found in the fax. This field is populated when Sinch detects bar codes on incoming faxes.

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.

If the job is complete, this is a timestamp representing the time the job was completed.

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 timestamp representing the time when the initial API call was made.

One of the error numbers listed in the Fax Error Messages section.

One of the error messages listed in the Fax Error Messages section.

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

Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false)

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.

The id of a fax

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. 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 pages in the fax.

The number of pages successfully sent to the receiving side in the fax.

The total price for this fax. This field is populated after the final fax price is calculated.

The Id of the project associated with the call.

The number of times the fax has been retried.

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

ID of the fax service used.

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