bird sms senders create

Usage

Esempio di codice

bird sms senders create [flags]

Claims an alphanumeric sender for this workspace, the brand name that shows as the from on a message. Claiming costs nothing. Where a country asks for no registration, the sender can reach it as soon as that destination is enabled on the workspace; everywhere else it needs bird sms senders registrations create first. Which countries ask for what is on bird sms senders requirements.

Build the request from flags, a JSON SMSSenderCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Procedure

Step 1 of 3 of "Claim an SMS sender and register it for a country". Next: bird sms senders requirements.

Examples

Esempio di codice

# print the body shape (no credentials needed)
bird sms senders create --example

# the body it prints:

Esempio di codice

{
  "sender": "BIRD",
  "type": "alpha"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--type	The kind of sender to create. Only alpha (an alphanumeric sender string) is customer-creatable. Dedicated numbers become senders when you allocate them from inventory. This endpoint cannot create their senders. Possible values: alpha. (required; or in --body-file)
--sender	The alphanumeric sender string to create, for example 'BIRD'. 1–11 letters, digits, spaces, dashes, or underscores, at least one of them a letter, and no separator at either end. (required; or in --body-file)
--response-schema	Print the fields this command returns, then exit

Name	Description
bird sms senders get	Get an SMS sender
bird sms senders list	List your SMS senders
bird sms senders requirements	List what a sender needs to send