Get the status of a fax
get_fax_statusRead where a fax is. Give the id from create_fax, or an address of the fax: the status address from the tracking prompt of the person, or the address of a page of the fax. "status" is pending, delivered, failed or expired. While it is pending, "stage" says more: rendering (we prepare the pages), awaiting_payment (the person did not pay yet; "pages" and "price" are given, and they can still change), sending (paid, on its way). delivered: the fax arrived. failed: the fax was not delivered, the person is not charged, and can send it again; with "render_failed", the document could not be prepared, and the person opens the link to change it. expired: the fax was not paid in time, or it is no longer available. Do not call this in a loop: read the status when the person asks.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>"
},
"name": "get_fax_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id of the fax, or an address of the fax: its status address (https://.../api/fax/{id}/status), or the address of its preview, payment or confirmation page. |