sinch fax

Send and manage faxes via the Sinch Fax API.

Commands that need a fax service use --service-id, then the configured default, then an API lookup. The lookup uses your only fax service, or asks which one if you have several (without prompts, the command fails). To set defaults:

sinch config set fax serviceID=<your-service-id>
sinch config set fax senderNumber=+15551234567   # optional default sender

Send a fax from a file or URL.

sinch fax send [options]

If --to and content are omitted, the command prompts interactively.

The CLI rejects local files over 20 MB before sending. This is a CLI check, not a Sinch Fax API limit, and it does not apply to --content-url.

Example

sinch fax send --to +12025550134 --file ./document.pdf
sinch fax send --to +12025550134 --content-url https://example.com/doc.pdf

With --json, the result is an object with a faxes array, one entry per recipient (with --wait, the completed faxes):

{ "faxes": [{ "id": "01HZ...", "status": "QUEUED" }] }

List faxes, with optional filters.

sinch fax list [options]

Delete a fax's stored content.

sinch fax delete-content <fax-id> [--force] [--non-interactive] [--json]

Asks for confirmation unless you pass --force or --json. --non-interactive needs --force. With --json it prints { "deleted": true, "faxId": "<id>" }.

Manage fax services.

sinch fax services list [-l, --limit <number>] [--json]
sinch fax services get <service-id> [--json]
sinch fax services create [options]
sinch fax services update <service-id> [options]
sinch fax services delete <service-id> [--force] [--json]
sinch fax services numbers <service-id> [-l, --limit <number>] [--json]

create and update options:

With --json, services delete prints { "deleted": true, "serviceId": "<id>" }.

Manage fax-to-email configurations.

sinch fax emails list [--service-id <id>] [-l, --limit <number>] [--json]
sinch fax emails add [options]
sinch fax emails update <email> [options]
sinch fax emails delete <email> [--service-id <id>] [--force] [--json]
sinch fax emails numbers <email> [--service-id <id>] [--json]

With --json, emails delete prints { "deleted": true, "email": "<email>" }.

Manage the cover pages of a fax service.

sinch fax cover-pages list [--service-id <id>] [--json]
sinch fax cover-pages get <cover-page-id> [--service-id <id>] [--json]
sinch fax cover-pages add [--service-id <id>] [--name <name>] [--file <path>] [--non-interactive] [--json]
sinch fax cover-pages delete <cover-page-id> [--service-id <id>] [--force] [--json]

add takes the file type from the file extension. With --json, cover-pages delete prints { "deleted": true, "coverPageId": "<id>" }.

Receive incoming fax events on your machine.

sinch fax listen [--port <port>] [--service-id <id>] [--url <url>] [--json]

Starts a local HTTP server on 127.0.0.1 (port 3000 by default) and prints each event it receives. It does not open a tunnel. Pass --url with a public URL that forwards to that port, and the CLI sets it as the fax service's incoming webhook (JSON content type). When you stop it with Ctrl+C, the CLI puts back the service's previous webhook URL, but the content type stays JSON. --json prints each event as JSON, but the status lines also go to stdout, so the output is not pure JSON.

Every fax list command prints an object with one named array. Since 0.7.0; see the changelog.

sinch fax list --json | jq '.faxes[0].id'

Get the current status of a fax.

sinch fax status <fax-id> [options]

Get complete details for a fax, including pricing and retry configuration.

sinch fax get <fax-id> [--json]

Download the content of a fax as a PDF.

sinch fax download <fax-id> [-o <filename>] [--json]

With --json the command prints the saved file and exits:

{ "faxId": "01ABC", "path": "/home/me/01ABC.pdf", "bytes": 48213 }

--json cannot be combined with -o -, because stdout carries the PDF. That combination is rejected with an error on stderr and exit code 1. Other failures print { "error": "...", "statusCode": ..., "serverBody": "..." } to stdout and exit with code 1.