bird sms
Usage
Code example
bird smsDescription
A send carries either free text with --text (and --category) or a stored template with
--template, never both. A message read back carries its segment breakdown and cost, which
is where a send's price shows up.
Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.
Procedure
Send an SMS
Deliver one SMS to a phone number, as free text or from a stored template. The result is accepted (queued, delivered asynchronously), not yet delivered: the carrier reports back over the following seconds to hours, so the final status only arrives on a later read.
Requires: The destination country must be enabled for the workspace. The allowlist is default-deny — a workspace starts with its organization's home country and nothing else — and a send anywhere else is refused before the sender is even resolved.
Requires: The two send forms are mutually exclusive and take different fields. Free text needs text, a category, and a from — an E.164 number or short code the workspace owns, or an alphanumeric sender ID where the destination country permits one. A template send needs only the template and its parameters: the template carries its own sender and category, so from and category alongside it are rejected.
- bird sms send — Returns accepted (HTTP 202) with the message id and its segment count; billing is per segment, not per message, and a long body or a non-GSM-7 character raises that count. Next: bird sms get or bird sms list
Messages
| Name | Description |
|---|---|
| send | Send an SMS message to one recipient |
| get | Get an SMS message |
| list | List SMS messages |
| list-events | List events for an SMS message |
Templates
| Name | Description |
|---|---|
| templates | Browse the workspace's SMS templates |
Routing
| Name | Description |
|---|---|
| destinations | Manage which destination countries the workspace may send SMS to |
Registration
| Name | Description |
|---|---|
| senders | What a sender needs before it can send, country by country |
| 10dlc | Register the brand and campaign US A2P SMS sending requires |
| tfn | License a toll-free number to send in the US and Canada |
Compliance
| Name | Description |
|---|---|
| suppressions | Manage who an SMS sender may not message |
| keyword-rules | Configure what a reply to one of the workspace's numbers does |
Analytics
| Name | Description |
|---|---|
| stats | Read aggregate SMS statistics |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideSending your first SMSUnderstand the conceptWhat does SMS mean?Explore the capabilitySMSFollow the learning pathBuild your first integration
Try the practice and get an implementation brief