bird amb conversations list
Usage
Code example
bird amb conversations list [flags]Description
Returns the conversations your business has with customers on Apple Messages for Business, newest first by last message. To page through older conversations, use starting_after. A closed conversation stays in this list; filter on status to separate them from open ones.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird amb conversations list
bird amb conversations list | jq -r '.data[].id'
bird amb conversations list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --assigned-to | Filter to conversations assigned to this user. Pass unassigned to match conversations with no assignee. |
| --business-id | Filter to conversations belonging to this business. |
| --label | Filter to conversations that have this label. |
| --queue | Filter to conversations in this queue. Pass an empty string to match unrouted conversations, the ones no routing rule has claimed. |
| --response-schema | Print the fields this command returns, then exit |
| --status | Filter to conversations with this status. Omit to return both open and closed conversations. Possible values: open, closed. |
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 conversations get | Get a conversation |
| bird amb conversations list-messages | List messages in a conversation |
| bird amb conversations typing | Send a typing indicator |
| bird amb conversations update | Update a conversation |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integrationImplementation guideSend your first email
Get an implementation brief