Get a delivery report
get_fax_reportUse this when the person asks for a delivery report or the transmitted document. Returns the destination, page count, delivery result, timestamps and attempts. A report URL is available after delivery, failure or cancellation. Document links are only returned for the signed-in owner of an account fax while its files are retained. Report and document links expire after five minutes. A delivered fax does not establish that the recipient read it. It changes nothing.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_fax_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | An account fax ID; requires sign-in. Pass this or status_url, not both. | |
| status_url | No | The original status link, including its token for a guest fax. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| status | Yes | ||
| attempts | Yes | ||
| failed_at | Yes | ||
| created_at | Yes | ||
| fax_number | Yes | ||
| page_count | Yes | ||
| report_url | Yes | ||
| canceled_at | Yes | ||
| delivered_at | Yes | ||
| document_url | Yes | ||
| document_sha256 | Yes | ||
| report_available | Yes | ||
| document_available | Yes |