Skip to content
Functions and CLI/
/
Quickstart
Last updated

CLI quickstart

You'll end up with: a rented phone number and an SMS sent to your own phone. No code, no deploys, just the CLI.

Prerequisites

  • Sinch CLI installed: npm install -g @sinch/cli
  • A Sinch account with a Project ID, API key, and API secret (find them in the Sinch Dashboard under your project's Access Keys)

If you have not done the install, see Installation.

Step 1 — Log in

sinch auth login

The CLI prompts for your Project ID, Key ID, and Key Secret. These are stored in your OS keychain (not in a config file) so they don't leak into shell history or source control.

Verify the login worked:

sinch auth status

You should see your Project ID printed.

Step 2 — Search for an available number

sinch numbers available search --region US --type LOCAL

You will see a list of available numbers with their monthly cost and capabilities. Pick one that suits you.

Filter to SMS-capable:

sinch numbers available search --region US --type LOCAL --capabilities SMS

Region is an ISO country code (US, GB, SE, …). Type is one of LOCAL, MOBILE, or TOLL_FREE. Capabilities take one or more of SMS and VOICE.

Step 3 — Rent it

sinch numbers available rent

Run without arguments for the interactive flow — the CLI walks you through picking a number from your search results, confirming the cost, and renting it. It appears in your active-numbers inventory right away:

sinch numbers active list

Step 4 — Send an SMS

sinch conversation send takes the recipient and message as positional arguments:

sinch conversation send +15559876543 "Hello from the Sinch CLI!"

You can force a specific channel with --channel:

sinch conversation send +15559876543 "Hi on WhatsApp!" --channel WHATSAPP

The command uses the Sinch Conversation API, so WhatsApp, Messenger, Viber, and other channels all work the same way as long as your Conversation App is configured for them.

Step 5 — Try the other APIs

You now have everything wired up. Some things you can do from here without writing code:

# Send a fax
sinch fax send --from +15551234567 --to +15559876543 --file invoice.pdf

# List your SIP trunks
sinch sip trunks list

# Store an API key in the keychain so a deployed Function can use it
sinch secrets add STRIPE_SECRET_KEY sk_live_abc123

# Look at your phone number's configuration
sinch numbers active get +15551234567

Step 6 — Release the number (optional)

If you rented a number just to test, release it so you are not billed for it:

sinch numbers active release +15551234567

What's next

Previous page
Next page