---
# @generated by sylphx-gen. Do not edit.
title: "Get a sms number"
description: "`notify.sms_numbers.get` (GET /v1/{name}): Gets an SMS number binding."
type: reference
product: notifications
summary: "Gets an SMS number binding."
updated: 2026-09-28
nav: false
---

Gets an SMS number binding.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number`
- **Scope** `notify:read`
- **Effect** `read` — nothing is written.
- **Collection** [sms_numbers](/docs/api/sms_numbers)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the binding to get. 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.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

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

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.notify.smsNumbers.get({ name: 'orgs/acme/projects/shop/envs/production/sms_numbers/sms-number' })
```

**Rust**

```rust
let mut req = sylphx::notify::GetSmsNumberRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/sms_numbers/sms-number".to_string();
let response = sx.notify().sms_numbers().get(req).await?;
```

**CLI**

```bash
sylphx notify sms-numbers get orgs/acme/projects/shop/envs/production/sms_numbers/sms-number
```

**MCP**

```json
{ "method_id": "notify.sms_numbers.get", "args": {"name":"orgs/acme/projects/shop/envs/production/sms_numbers/sms-number"} }
```