bird whatsapp conversations list
Usage
Code example
bird whatsapp conversations list [flags]Description
List the workspace's WhatsApp conversations, most recently active first, as a cursor page. Each one says who answers it right now (meta_business_agent for the Meta Business Agent, bird for your workspace), when its 24-hour service window closes, how many messages are unread, and what the last message was. Filter by inbox_status, business_phone_number, control, assigned_to (a user ID, me or unassigned), service_window_status (open or closed) or label. Conversations exist only on numbers with conversations turned on in the dashboard. Reply with bird whatsapp send.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird whatsapp conversations list
bird whatsapp conversations list | jq -r '.data[].id'
bird whatsapp 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-phone-number | Return only conversations on this WhatsApp business phone number, in E.164 format. Omit to cover every number in the workspace. |
--control | Return only conversations the agent holds (meta_business_agent) or that your workspace holds (bird). Known values: bird, meta_business_agent (others may exist). |
--inbox-status | Filter by workspace inbox status. Omit to include open and resolved conversations. Possible values: open, resolved. |
--label <value>… | Return conversations carrying this label. Repeat the parameter to require every supplied label. |
--response-schema | Print the fields this command returns, then exit |
--service-window-status | Return only conversations whose customer-service window is open or closed. 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 whatsapp conversations counts | Get WhatsApp conversation counts |
bird whatsapp conversations get | Get a WhatsApp conversation |
bird whatsapp conversations get-message | Get a message in a WhatsApp conversation |
bird whatsapp conversations list-events | List WhatsApp conversation events |
bird whatsapp conversations list-messages | List messages in a WhatsApp conversation |
bird whatsapp conversations update | Update a WhatsApp conversation |
Related resources
Continue with the documentation, guides and examples for this topic.