---
# @generated by sylphx-gen. Do not edit.
title: "Create a sms number"
description: "`notify.sms_numbers.create` (POST /v1/{parent}/sms_numbers): Provisions one carrier number within explicit cost limits and receives its SMS."
type: reference
product: notifications
summary: "Provisions one carrier number within explicit cost limits and receives its SMS."
updated: 2026-09-28
nav: false
---

Provisions one carrier number within explicit cost limits and receives its SMS.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers`
- **Scope** `notify:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [sms_numbers](/docs/api/sms_numbers)
- **Query** `sms_number_id`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment to bind the number in. Required. |
| `sms_number_id` | `string` | The binding id; server-assigned when empty. |
| `sms_number` | `SmsNumber` | The binding to create. Required. |

### SmsNumber

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SmsNumberSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### SmsNumberSpec

| Field | Type | What it is |
| --- | --- | --- |
| `region_code` | `string` | ISO two-letter country code. Required. |
| `number_type` | `string` | local, mobile, toll_free, national or shared_cost. Required. |
| `provider` | `string` | The carrier; Telnyx is supported. Required. |
| `upfront_cost_limit` | `string` | Maximum one-time USD price, as a decimal string. No quote over it is ordered. Required. |
| `monthly_cost_limit` | `string` | Maximum recurring monthly USD price, as a decimal string. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}`. |
| `uid` | `string` | `snum_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SmsNumberSpec` | Desired state. Required. |
| `status` | `SmsNumberStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### SmsNumberSpec

| Field | Type | What it is |
| --- | --- | --- |
| `region_code` | `string` | ISO two-letter country code. Required. |
| `number_type` | `string` | local, mobile, toll_free, national or shared_cost. Required. |
| `provider` | `string` | The carrier; Telnyx is supported. Required. |
| `upfront_cost_limit` | `string` | Maximum one-time USD price, as a decimal string. No quote over it is ordered. Required. |
| `monthly_cost_limit` | `string` | Maximum recurring monthly USD price, as a decimal string. Required. |

### SmsNumberStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `receiving` | `bool` | Receiving: an active binding whose number the carrier delivers to. Output only. |
| `retired_time` | `timestamp` | When the binding stopped receiving, if it has. Output only. |
| `phone_number` | `string` | The provisioned E.164 number; empty until inventory selection. Output only. |
| `carrier_account` | `string` | The platform carrier account reference, never a credential. Output only. |
| `provider_number_id` | `string` | Carrier number identifier, when available. Output only. |
| `order_id` | `string` | Stable carrier order receipt; an uncertain purchase is reconciled, not repeated. Output only. |
| `messaging_profile_id` | `string` | Messaging profile holding this number's webhook configuration. Output only. |
| `state_reason` | `string` | Safe reason for a pending or stalled provision; contains no message text. Output only. |
| `upfront_cost` | `string` | Accepted one-time price in USD. Output only. |
| `monthly_cost` | `string` | Accepted monthly price in USD. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"monthly_cost_limit":"…","number_type":"…","provider":"…","region_code":"…","upfront_cost_limit":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.notify.smsNumbers.create({ parent: 'orgs/acme/projects/shop/envs/production', smsNumber: { spec: { monthlyCostLimit: '…', numberType: '…', provider: '…', regionCode: '…', upfrontCostLimit: '…' } } })
```

**Rust**

```rust
let mut req = sylphx::notify::CreateSmsNumberRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.sms_number = Some(sylphx::notify::SmsNumber {
    spec: Some(sylphx::notify::SmsNumberSpec {
        monthly_cost_limit: "…".to_string(),
        number_type: "…".to_string(),
        provider: "…".to_string(),
        region_code: "…".to_string(),
        upfront_cost_limit: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
let response = sx.notify().sms_numbers().create(req).await?;
```

**CLI**

```bash
sylphx notify sms-numbers create --parent orgs/acme/projects/shop/envs/production --spec.region-code … --spec.number-type … --spec.provider … --spec.upfront-cost-limit … --spec.monthly-cost-limit …
```

**MCP**

```json
{ "method_id": "notify.sms_numbers.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","sms_number":{"spec":{"monthly_cost_limit":"…","number_type":"…","provider":"…","region_code":"…","upfront_cost_limit":"…"}}} }
```