Sign inGet Started

bird amb suppressions create

Usage

Contoh kode
bird amb suppressions create [flags]

Description

Create an Apple Messages for Business suppression
Manually opens a suppression episode for a handle, blocking every outbound path to it: operator and automated replies, API sends, typing indicators, and invitations. Set business_id to block the handle for one brand only, or omit it to block the handle for every brand in the workspace. If the handle already has an active episode with reason manual, the API returns 200 with the existing episode instead of creating a second one.
Build the request from flags, a JSON AMBSuppressionCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Contoh kode
# print the body shape (no credentials needed)
bird amb suppressions create --example

# the body it prints:
Contoh kode
{
  "handle": "+15551234567",
  "handle_type": "phone_number"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--business-idSuppress the handle for this brand only. Omit or send null to block it for every brand in the workspace.
--handleThe phone number or opaque identifier to suppress. For a phone number, supply canonical E.164 with a leading plus sign. (required; or in --body-file)
--handle-typeWhat kind of value handle holds. - phone_number means handle is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind. - opaque_user_id means handle is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation. Possible values: phone_number, opaque_user_id. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird amb suppressions deleteEnd an Apple Messages for Business suppression
bird amb suppressions getGet an Apple Messages for Business suppression
bird amb suppressions listList Apple Messages for Business suppressions

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.

Dapatkan ringkasan implementasi