`bird sms suppressions list`

Usage

Code example

bird sms suppressions list [flags]

List the workspace's SMS suppressions (sender-and-subscriber pairs blocked from delivery) as a cursor page.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Code example

bird sms suppressions list
bird sms suppressions list | jq -r '.data[].id'
bird sms suppressions list --limit 50 --starting-after <cursor>

Name	Description
`--destination`	Return only suppressions for this exact subscriber number in E.164 form. Prefix matching is unsupported.
`--originator`	Return only suppressions covering this sender.
`--reason`	Return only suppressions with this reason: - keyword_stop: The subscriber texted a stop keyword to the sender. - carrier_opted_out: Their carrier reported the opt-out. - manual: Added through the API or dashboard. Possible values: keyword_stop, carrier_opted_out, manual.
`--response-schema`	Print the fields this command returns, then exit

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.

Name	Description
`bird sms suppressions add`	Create an SMS suppression
`bird sms suppressions get`	Get an SMS suppression
`bird sms suppressions remove`	Delete an SMS suppression

Continue with the documentation, guides and examples for this topic.