Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx notify phone_numbers

Every sylphx notify phone_numbers command: its argument, its flags and a run line.

The phone_numbers commands of Sylphx Notify, as the CLI spells them: the same calls as the phone_numbers API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#connect

ConnectPhoneNumber: existing provider-managed lines; execution credentials are transient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx notify phone-numbers connect orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers:connect · scope notify:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--phone-number-idstringStable caller-chosen id; retries reuse this id. Required.
--phone-numberstringExisting E.164 number. Required.
--provider-session-tokenstringExisting provider session, held only for this synchronous request. Never stored, logged, included in command hashes, or refreshed. Issuer lifetime is provider-owned; transient custody does not assert a shorter lifetime. Required. The value is never returned.
--dry-runboolValidate and print the result without writing (validate_only).

#get

GetPhoneNumber: existing provider-managed lines; execution credentials are transient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx notify phone-numbers get orgs/acme/projects/shop/envs/production/phone_numbers/phone-number

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number · scope notify:read · effect read · Request, response and examples

#list

ListPhoneNumbers: existing provider-managed lines; execution credentials are transient.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx notify phone-numbers list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers · scope notify:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintPage size, default 50, maximum 1000.
--page-tokenstringContinuation token.

#apply-route

ApplyPhoneNumberRoute: existing provider-managed lines; execution credentials are transient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx notify phone-numbers apply-route orgs/acme/projects/shop/envs/production/phone_numbers/phone-number

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:applyRoute · scope notify:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--operation-idstringStable logical operation id. A different route needs a different id. Required.
--voicemailjsonDesired voicemail settings. Required.
--provider-session-tokenstringTransient provider session; excluded from every durable command/hash. Required. The value is never returned.
--dry-runboolValidate and print the result without writing (validate_only).

#probe

ProbePhoneNumber: existing provider-managed lines; execution credentials are transient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx notify phone-numbers probe orgs/acme/projects/shop/envs/production/phone_numbers/phone-number

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:probe · scope notify:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--start-daystringFirst provider-local calendar day, YYYY-MM-DD. Required.
--end-daystringLast day inclusive; at most one day after start_day. Required.
--provider-session-tokenstringTransient provider session. Required. The value is never returned.

#read-voicemail

ReadPhoneNumberVoicemail: existing provider-managed lines; execution credentials are transient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx notify phone-numbers read-voicemail orgs/acme/projects/shop/envs/production/phone_numbers/phone-number

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:readVoicemail · scope notify:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--provider-call-idstringStable provider receipt id already held by this line. Required.
--start-daystringDay window to re-establish receipt ownership. Required.
--end-daystringLast day inclusive, at most one day after start_day. Required.
--provider-session-tokenstringTransient provider session. Required. The value is never returned.