Sign inGet Started

bird amb conversations list

Usage

Przykład kodu
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

Przykład kodu
bird amb conversations list
bird amb conversations list | jq -r '.data[].id'
bird amb conversations list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--assigned-toFilter to conversations assigned to this user. Pass unassigned to match conversations with no assignee.
--business-idFilter to conversations belonging to this business.
--labelFilter to conversations that have this label.
--queueFilter to conversations in this queue. Pass an empty string to match unrouted conversations, the ones no routing rule has claimed.
--response-schemaPrint the fields this command returns, then exit
--statusFilter to conversations with this status. Omit to return both open and closed conversations. Possible values: open, closed.

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 conversations getGet a conversation
bird amb conversations list-messagesList messages in a conversation
bird amb conversations typingSend a typing indicator
bird amb conversations updateUpdate a conversation

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Uzyskaj brief wdrożeniowy