Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Configure voicemail on a sms number
Configure voicemail and create an inert standalone carrier application.
Configure voicemail and create an inert standalone carrier application. Never buys, attaches, forwards or changes the voice profile of a line.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number:configureVoicemail - Scope
notify:write - Effect
write— a successful call changes state. - Collection sms_numbers
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The number resource. Required. |
greeting | string | Plain-text greeting spoken before recording. Required. |
retention_days | int32 | Content retention, 1–30 days. Required. |
max_recording_duration | duration | Maximum recording duration, 10–180 whole seconds (for example, "120s"). 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. |
voicemail | VoicemailConfig | Desired voicemail behavior. Configuring this does not attach the line. Output only. |
voice_application_id | string | Readback-verified standalone Call Control application. The line's owner attaches it separately; Notify never changes a DID's voice configuration. Output only. |
voice_application_error | string | Safe provisioning error. Definite refusals are retryable after inventory readback; an unknown create outcome is never blindly repeated. 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. |
#VoicemailConfig
| Field | Type | What it is |
|---|---|---|
greeting | string | Greeting spoken before recording. Plain text, not SSML. Required. |
retention_days | int32 | Delete both carrier and Storage audio, and the transcript, after 1–30 days. Required. |
max_recording_duration | duration | Maximum recording duration, 10–180 whole seconds (for example, "120s"). Required. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number:configureVoicemail" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"greeting":"…","max_recording_duration":{},"retention_days":1}'