bird amb list
Usage
Codevoorbeeld
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
Codevoorbeeld
bird amb list
bird amb list | jq -r '.data[].id'
bird amb list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --business-id | Filter to messages belonging to this business. |
| --category | Filter to outbound messages sent with this category, exact match. |
| --conversation-id | Filter to messages belonging to this conversation. |
| --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 to received (inbound) or sent (outbound) messages. Possible values: outbound, inbound. |
| --kind | Filter 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-schema | Print the fields this command returns, then exit |
| --status | Filter 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
| 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 amb get | Get a message |
| bird amb list-events | List events for a message |
| bird amb send | Reply to an Apple Messages conversation |
Gerelateerde bronnen
Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.
Begrijp het conceptShould I use a Bird SDK or call the API directly?Volg het leerpadBuild your first integrationImplementatiegidsSend your first email
Ontvang een implementatieoverzicht