bird whatsapp groups list
Usage
Contoh kode
bird whatsapp groups list [flags]Description
List the WhatsApp groups your workspace created, newest first, as a cursor page. Each carries its subject, status, invite link and participant count. Filter by the business number that administers the group (number), by the WhatsApp Business Account it sends under (waba), by status, or search subjects and descriptions with q. Each group includes its participants.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Contoh kode
bird whatsapp groups list
bird whatsapp groups list | jq -r '.data[].id'
bird whatsapp groups list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --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. |
| --number | Filter by the business number that administers the group, as either the number in E.164 format or the number's id (wan_ prefix). A value that parses as a valid ID resolves by ID; any other value must be an E.164 number, and anything else is a 422. The E.164 form is matched against the group's stored record of the number it was created on. |
| --q | Case-insensitive substring match against the group's subject or description. |
| --response-schema | Print the fields this command returns, then exit |
| --status <value>… | Filter by status. Repeat the parameter to match any of several statuses. Possible values: pending, active, suspended, deleted, failed. |
| --waba | Filter by the WABA identifier returned on the group. Groups with waba: null do not match this filter. |
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. |
| --order | Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc. |
| --sort | Field to sort by. Possible values: created_at. |
| --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 groups create | Create a WhatsApp group |
| bird whatsapp groups delete | Delete a WhatsApp group |
| bird whatsapp groups get | Get a WhatsApp group |
| bird whatsapp groups update | Update a WhatsApp group |
Sumber daya terkait
Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.
Pahami konsepnyaShould I use a Bird SDK or call the API directly?Ikuti jalur pembelajaranBuild your first integrationPanduan implementasiSend your first email
Dapatkan ringkasan implementasi