Sign inGet Started

bird sms

Usage

Contoh kode
bird sms

Description

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 the template and its parameters; the template supplies the category. Supply from for a workspace template and omit it for a built-in template. Omit text, category, and media_urls for either template scope.
  1. 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

NameDescription
sendSend an SMS message to one recipient
getGet an SMS message
listList SMS messages
list-eventsList events for an SMS message

Templates

NameDescription
templatesBrowse the SMS templates available to the workspace

Routing

NameDescription
destinationsManage which destination countries the workspace may send SMS to

Registration

NameDescription
sendersWhat a sender needs before it can send, country by country
10dlcRegister the brand and campaign US A2P SMS sending requires
tfnLicense a toll-free number to send in the US and Canada

Compliance

NameDescription
suppressionsManage who an SMS sender may not message
keyword-rulesConfigure what a reply to one of the workspace's numbers does

Analytics

NameDescription
statsRead aggregate SMS statistics