Get a test fax
get_test_faxGet one test fax by its slug (fax_ and 8 characters from 0-9 and a-f, for example fax_1a2b3c4d) or by the URL of its page on faxbeep.com (view_url, with or without a language prefix such as /de). The result is the fax object, the same as an item of list_test_faxes, and after it an image of page 1 when one can be read. A client can draw that image very small. In a chat that shows images, also show thumbnail_url as an image in your answer. Give view_url for the full page.
A fax that is not found gives an error result: a new fax can take a while to appear, and a fax that is still processing is not found yet. A fax that was removed, by request or after 30 days, gives the error result "This fax was removed, or it is older than 30 days." Its files are deleted, so it cannot be read again.
For a sample answer, use fax_example (a published sample fax) or fax_example_removed (the answer for a removed fax).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fax | Yes | The slug of the fax (for example fax_1a2b3c4d), or the URL of its page on faxbeep.com (view_url). |