Send a fax
send_faxUse this to send a fax from the person's Faxette credit, or an organization's fax on its plan or card. For an organization's fax, pass the payment_method from get_fax's payment_option once the person agrees to it, and for saved_card its quote; amount_cents isn't needed. Only for a fax in their account that's ready to pay for: call get_fax first. Show the prepared PDF with open_fax_review or its review_url. Have the person confirm the destination, documents and credit_price, explain that it comes from their credit, and call this only once they clearly agree. If get_account shows their credit doesn't cover it, give them the status page instead, where they can pay for this fax by card. For the EU connector, also explain that sending starts immediately and the person's right to cancel ends once the fax is delivered. Obtain their explicit agreement before setting immediate_sending_consent to true. Needs the person to sign in to Faxette; calling it while they aren't asks the app to sign them in.
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": "send_fax"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The fax's id, from create_fax, get_faxes or get_fax. | |
| quote | No | The credit_quote returned by get_fax for the exact destination, PDF and price the person reviewed and approved. After quote_changed or quote_required, show the new proof and obtain fresh approval. | |
| amount_cents | No | The credit_price amount_cents from get_fax that the person agreed to. If the fax's documents changed since, Faxette refuses with price_changed: call get_fax and confirm the new price. | |
| payment_method | No | Only for an organization's fax: the payment_option's payment_method the person agreed to. If it changed, Faxette refuses with payment_changed: call get_fax and confirm again. | |
| immediate_sending_consent | No | Required as true for EU credit sends, only after the person explicitly agrees to immediate sending and acknowledges that their right to cancel ends on delivery. Never infer this from agreement to the price alone. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The fax's id. Pass it to get_fax when the person is signed in. | |
| price | Yes | Before tax. Null until the pages are counted. | |
| status | Yes | draft: waiting for files, or for a file to be fixed. processing_documents: counting pages. documents_ready: ready to pay. awaiting_payment: the person is paying. scheduled: paid, about to dial. sending, delivered, failed. canceled: not paid in time. | |
| attempt | Yes | The current attempt to dial the fax number. | |
| payment | Yes | The person's payment once they start paying, by card or from their credit. amount_cents includes tax. | |
| language | No | ||
| resend_by | Yes | For a failed fax: until when the person can correct the fax number on the status page and send it again. | |
| fax_number | Yes | ||
| page_count | Yes | Null until the pages are counted. | |
| review_url | No | A private review link, valid for 30 minutes. Give it to the person so they can inspect the prepared PDF before paying. | |
| status_url | Yes | The page where the person checks the fax and pays. Give it to them. | |
| max_attempts | Yes | ||
| checkout_quote | No | ||
| failure_reason | Yes | For a failed fax: temporary (busy or no answer on every attempt), wrong_number (no fax machine answered), or our_side. | |
| document_errors | Yes | Files Faxette couldn't use. position is the file's number in the fax. The person fixes them on the status page. | |
| next_attempt_at | Yes | When the next attempt dials, if the line was busy or didn't answer. | |
| checkout_available | Yes | True when the person can pay on the status page. |