bird sms list
Usage
Przykład kodu
bird sms list [flags]Description
List SMS messages, newest first, as a cursor page (data, next_cursor). Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, category, recipient, sender, or tag.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Przykład kodu
bird sms list
bird sms list | jq -r '.data[].id'
bird sms list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --category | Filter by category. Possible values: transactional, marketing, authentication, service. |
| --created-after | Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset. |
| --created-before | Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset. |
| --direction | Filter by direction. Omit for both. Possible values: outbound, inbound. |
| --error-code <value>… | Keep only messages whose failure reason (last_error.code) matches; repeat the parameter to match any of several. One of invalid_destination, unreachable, blocked_by_carrier, blocked_by_recipient, landline_unreachable, content_rejected, sender_unregistered, recipient_opted_out, provider_unavailable, insufficient_balance, or unknown. |
| --from | Filter by sender (E.164, alphanumeric, or short code; exact match). |
| --response-schema | Print the fields this command returns, then exit |
| --status <value>… | Keep only messages whose current status matches; repeat the parameter to match any of several. One of scheduled, accepted, sent, delivered, undelivered, failed, rejected, canceled, expired, or received. scheduled and canceled are accepted but match nothing until send-later scheduling ships. |
| --tag <value>… | Filter by tag. Accepts name to match any record carrying that tag name, or name:value to match a specific tag pair (for example category:welcome). Repeat the parameter to add more tags. A record must match every tag listed to be returned. |
| --to | Filter by recipient phone number (E.164 exact match). |
Pagination
| Name | Description |
|---|---|
| --ending-before | Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. |
| --limit <n> | Maximum number of items to return per page. |
| --starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
| bird sms get | Get an SMS message |
| bird sms list-events | List events for an SMS message |
| bird sms send | Send an SMS message to one recipient |