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
Sms numbers
An SMS Number is provisioned and owned by Notify for one environment.
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 | Provisions one carrier number within explicit cost limits and receives its SMS. |
GET | get | Gets an SMS number binding. |
GET | list | Lists an environment's SMS number bindings. |
DELETE | 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
#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
#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
#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