Send and manage faxes via the Sinch Fax API.
Before using fax commands, configure your fax service ID:
sinch config set fax serviceID=<your-service-id>
sinch config set fax senderNumber=+15551234567 # optional default senderSend a fax from a file or URL.
sinch fax send [options]| Option | Description |
|---|---|
-t, --to <number> | Recipient fax number in E.164 format |
-f, --file <path> | Path to file (PDF, TIFF, DOC, DOCX, TXT, HTML — max 20MB) |
-u, --content-url <url> | URL to content (repeatable for multiple URLs) |
--from <number> | Sender fax number |
--service-id <id> | Fax service ID |
--json | Output as JSON |
If --to and content are omitted, the command prompts interactively.
Example
sinch fax send --to +12025550134 --file ./document.pdf
sinch fax send --to +12025550134 --content-url https://example.com/doc.pdfGet the current status of a fax.
sinch fax status <fax-id> [options]| Option | Description |
|---|---|
--wait | Poll until the fax completes or fails |
--timeout <seconds> | Timeout for --wait mode (default: 300) |
--watch | Continuously poll and redisplay status |
--interval <seconds> | Poll interval for --watch (default: 5) |
--json | Output as JSON |
Get complete details for a fax, including pricing and retry configuration.
sinch fax get <fax-id> [--json]Check fax service authentication and configuration.
sinch fax auth-status