# sinch numbers

Manage Sinch phone numbers: search available numbers, view active numbers, update configuration, and release numbers. See [Sinch Numbers API](/docs/numbers/) on developers.sinch.com for product documentation.

> **Interactive by default.** These commands prompt for filters before running: `active list` asks for region and number type; `available search` asks for region, type, capabilities, and a digit pattern. Pass the corresponding filter flags shown in each command's option table below — or add `--non-interactive` — to skip the prompts and get immediate output, which is what you want in scripts and CI. For `available search` the digit-pattern prompt is part of the search query rather than a post-filter; leave it blank (press Enter) to match any number.


## sinch numbers active

Manage phone numbers currently active in your project.

### sinch numbers active list

List all active phone numbers, with optional filters.

```sh
sinch numbers active list [options]
```

| Option | Description |
|  --- | --- |
| `-r, --region <code>` | Filter by region code (e.g., `US`, `GB`, `SE`) |
| `-t, --type <type>` | Filter by type: `MOBILE`, `LOCAL`, or `TOLL_FREE` |
| `-c, --capability <cap...>` | Filter by capability: `SMS`, `VOICE` |
| `-p, --pattern <digits>` | Filter by digit pattern |
| `--search-pattern <mode>` | Pattern match mode: `START`, `CONTAINS`, or `END` |
| `-l, --limit <number>` | Maximum results to return |
| `--non-interactive` | Skip prompts; list with whatever filters are given |
| `--json` | Output as JSON |


### sinch numbers active get

Get details for a specific active number.

```sh
sinch numbers active get [phone-number]
```

The number is accepted in E.164 (`+12027887772`). Numbers copied straight from `active list` output — which prints the pretty format `+1 202-788-7772` — are normalized automatically, so you can paste them directly. This normalization also applies to `active update`, `active release`, and `available check`/`rent`.

### sinch numbers active update

Update configuration for an active number (display name, SMS service plan, voice app, or callback URL).

```sh
sinch numbers active update [phone-number] [options]
```

| Option | Description |
|  --- | --- |
| `-d, --display-name <name>` | New display name |
| `--sms-service-plan <id>` | SMS service plan ID (empty string to unlink) |
| `--voice-app <id>` | Voice app ID |
| `--callback-url <url>` | Callback URL for provisioning events |


### sinch numbers active release

Release an active number, cancelling your subscription. Requires confirmation.

```sh
sinch numbers active release [phone-number] [-f, --force]
```

## sinch numbers available

Search for and rent available phone numbers. This is a group of subcommands:

| Subcommand | Purpose |
|  --- | --- |
| `search` | Search for available numbers to rent |
| `check <phone-number>` | Check whether a specific number is available |
| `rent <phone-number>` | Rent (activate) a specific number |
| `rent-any` | Rent any number matching your criteria (US `LOCAL`) |


### sinch numbers available search

```sh
sinch numbers available search [options]
```

| Option | Description |
|  --- | --- |
| `-r, --region <code>` | Region code (e.g., `US`, `GB`, `SE`) |
| `-t, --type <type>` | Number type: `MOBILE`, `LOCAL`, or `TOLL_FREE` |
| `-c, --capabilities <cap...>` | Capabilities: `SMS`, `VOICE` |
| `-p, --pattern <digits>` | Digit pattern to match |
| `--search-pattern <mode>` | Pattern match mode: `START`, `CONTAINS`, or `END` |
| `-s, --size <number>` | Maximum results |
| `--non-interactive` | Skip prompts; search with whatever flags are given |
| `--json` | Output as JSON |


### sinch numbers available rent

```sh
sinch numbers available rent [phone-number] [options]
```

| Option | Description |
|  --- | --- |
| `--sms-service-plan <id>` | SMS service plan ID (see "Renting with SMS") |
| `--sms-campaign <id>` | SMS campaign ID (for US numbers) |
| `--voice-app <id>` | Voice app ID (for RTC) |
| `--voice-type <type>` | Voice config type: `RTC`, `EST`, or `FAX` |
| `--trunk-id <id>` | EST trunk ID (when `--voice-type EST`) |
| `--callback-url <url>` | Callback URL for provisioning events |
| `-f, --force` | Skip the confirmation prompt |
| `--non-interactive` | Skip prompts; require configuration as flags |
| `--json` | Output as JSON |


### The `[docs required]` tag

Some numbers show `[docs required]` in search results. It means the number's region requires supporting documentation (for example proof of address or business identity) before the number can be activated. You can still rent it — provisioning may pause until the documents are supplied. Whether it applies varies by region, and it is driven by the number's `supportingDocumentationRequired` field from the Numbers API.

### Renting with SMS

When you rent a number and choose to configure SMS, the CLI asks for an **SMS service plan ID**. Unlike fax services and EST trunks — which the CLI can list into a picker — SMS service plans have no list endpoint, so there is no in-CLI lookup. Copy your Service Plan ID from the dashboard at [dashboard.sinch.com/sms/api/rest](https://dashboard.sinch.com/sms/api/rest) and paste it when prompted (or pass `--sms-service-plan <id>`).

## sinch numbers regions

List regions where phone numbers are available.

```sh
sinch numbers regions [options]
```

| Option | Description |
|  --- | --- |
| `-t, --type <type>` | Filter by number type |
| `-c, --capability <cap>` | Filter by capability |