On this page
Adopt a sms number
Adopts an existing active carrier SMS number binding into one environment without purchasing a new number.
Adopts an existing active carrier SMS number binding into one environment without purchasing a new number.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers:adopt - Scope
notify:write - Effect
write— a successful call changes state. - Collection sms_numbers
- Validate-only
validate_only=trueruns every check and writes nothing
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment to bind the existing carrier number in. Required. |
sms_number_id | string | The binding id; server-assigned when empty. |
provider | string | The carrier provider ("telnyx"). Defaults to "telnyx" when empty. |
provider_number_id | string | Carrier phone number identifier to verify live before binding. Required. |
phone_number | string | Expected E.164 phone number; must match the carrier record. Required. |
messaging_profile_id | string | Expected carrier messaging profile id; must match and be active. Required. |
validate_only | bool | Validate against the carrier and local state without writing a binding. |
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.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.RESOURCE_IN_USE— The Resource is attached to or held by another Resource, for example a volume attached to a running lease.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.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:adopt" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"messaging_profile_id":"…","phone_number":"…","provider_number_id":"…"}'