---
# @generated by sylphx-gen. Do not edit.
title: "Sms numbers"
description: "The `sms_numbers` collection of Sylphx Notify: An SMS Number is provisioned and owned by Notify for one environment."
type: reference
product: notifications
summary: "An SMS Number is provisioned and owned by Notify for one environment."
updated: 2026-09-28
order: 900
---

An SMS Number is provisioned and owned by Notify for one environment. The platform orders it within the caller's explicit USD cost limits and authenticates delivery into its durable inbound feed.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/SmsNumber` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}` · **Shape** `spec_status`

## Fields

| 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. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `POST` | [`create`](/docs/api/sms_numbers#create) | Provisions one carrier number within explicit cost limits and receives its SMS. |
| `GET` | [`get`](/docs/api/sms_numbers#get) | Gets an SMS number binding. |
| `GET` | [`list`](/docs/api/sms_numbers#list) | Lists an environment's SMS number bindings. |
| `DELETE` | [`delete`](/docs/api/sms_numbers#delete) | Requests carrier release and stops recurring number billing. Read status until retired_time is set. Historical messages stay readable. |

## create

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

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/sms_numbers/create)

## get

Gets an SMS number binding.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/sms_numbers/get)

## list

Lists an environment's SMS number bindings.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers` · scope `notify:read` · effect `read` · paginated · [Request, response and examples](/docs/api/sms_numbers/list)

## delete

Requests carrier release and stops recurring number billing. Read status until retired_time is set. Historical messages stay readable.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number` · scope `notify:write` · effect `destructive` · [Request, response and examples](/docs/api/sms_numbers/delete)