Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx notify sms_numbers
Every sylphx notify sms_numbers command: its argument, its flags and a run line.
The sms_numbers commands of Sylphx Notify, as the CLI spells them: the same
calls as the sms_numbers API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#create
Provisions one carrier number within explicit cost limits and receives its SMS.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
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 …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.region-code | string | ISO two-letter country code. Required. |
--spec.number-type | string | local, mobile, toll_free, national or shared_cost. Required. |
--spec.provider | string | The carrier; Telnyx is supported. Required. |
--spec.upfront-cost-limit | string | Maximum one-time USD price, as a decimal string. No quote over it is ordered. Required. |
--spec.monthly-cost-limit | string | Maximum recurring monthly USD price, as a decimal string. Required. |
#get
Gets an SMS number binding.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify sms-numbers get orgs/acme/projects/shop/envs/production/sms_numbers/sms-numberGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number · scope notify:read · effect read · Request, response and examples
#list
Lists an environment's SMS number bindings.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx notify sms-numbers list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers · scope notify:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
#delete
Requests carrier release and stops recurring number billing. Read status until retired_time is set. Historical messages stay readable.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify sms-numbers delete orgs/acme/projects/shop/envs/production/sms_numbers/sms-number --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number · scope notify:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--yes | bool | Do not ask before this destructive call. |