Sign inGet Started

bird amb list

Usage

Codebeispiel
bird amb list [flags]

Description

Lists your workspace's incoming and outgoing Apple messages with cursor pagination. Filter by business or conversation to inspect one exchange; sent records Apple gateway acceptance.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Codebeispiel
bird amb list
bird amb list | jq -r '.data[].id'
bird amb list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--business-idFilter to messages belonging to this business.
--categoryFilter to outbound messages sent with this category, exact match.
--conversation-idFilter to messages belonging to this conversation.
--created-afterLimits 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-beforeLimits 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.
--directionFilter to received (inbound) or sent (outbound) messages. Possible values: outbound, inbound.
--kindFilter to messages whose content is this shape. Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive.
--response-schemaPrint the fields this command returns, then exit
--statusFilter to messages with this status. Possible values: accepted, sent, send_failed, rejected, received.
--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.

Pagination

NameDescription
--ending-beforeCursor 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-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird amb getGet a message
bird amb list-eventsList events for a message
bird amb sendReply to an Apple Messages conversation