bird amb conversations list
Usage
Esempio di codice
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 for the Apple channel state, or inbox_status for open and resolved inbox work.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Esempio di codice
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 | Return conversations assigned to this workspace member. Pass me for the signed-in user or unassigned for conversations without an assignee. An API key cannot use me and receives a 422 response. |
--business-account-id | Filter to conversations belonging to this business. |
--group-id | Filter to conversations with this entry point group, as sent in Apple's groupID. Conversations whose entry point carried no group match only when this filter is omitted. |
--inbox-status | Filter by workspace inbox status. Omit to include open and resolved conversations. Possible values: open, resolved. |
--intent-id | Filter to conversations with this entry point intent, as sent in Apple's intentID. Conversations whose entry point carried no intent match only when this filter is omitted. |
--label <value>… | Return conversations carrying this label. Repeat the parameter to require every supplied 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. Allowed range: 1 to 100. |
--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 |
Risorse correlate
Continua con la documentazione, le guide e gli esempi per questo argomento.