Open a received fax
get_inbound_faxUse this for one received fax: who sent it, when, how many pages, and pdf_url, a link to its PDF for 5 minutes, for apps that can download files. Getting the link marks the fax read for the person. To read what the fax says in the chat, use read_inbound_fax instead. Needs the person to sign in to Faxette.
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": {
"organization": "<organization>",
"id": "<id>"
},
"name": "get_inbound_fax"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The fax's id from get_inbound_faxes. | |
| organization | Yes | The organization's id from get_organizations. Ask the person which one if there are several. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Pass it to get_inbound_fax or read_inbound_fax. | |
| url | Yes | The fax's page in the organization's inbox. Give it to the person. | |
| read | Yes | Whether the signed-in person has opened it. | |
| locked | Yes | True when it arrived after the organization's plan ended. Nobody can open it until an owner restarts the plan. | |
| status | Yes | failed: the sender's machine gave up before the fax arrived. | |
| pdf_url | Yes | The PDF, for 5 minutes. Null when the fax is locked, failed or its document was deleted. | |
| to_name | Yes | That number's name, like Front desk. | |
| to_number | Yes | Which of the organization's numbers it was sent to. | |
| page_count | Yes | ||
| from_number | Yes | Who sent it. Null when the sender hid their number. | |
| received_at | Yes | ||
| failure_reason | Yes | ||
| document_deleted | Yes | True once the document has been deleted. Faxette deletes them 30 days after they arrive. | |
| document_deleted_on | Yes | When the document is or was deleted. |