List Apple Messages for Business suppressions
/v1/amb/suppressionsconst result = await bird.amb.suppressions.list({
business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
limit: 2,
});
console.log(result);result = client.amb.suppressions.list(business_account_id='abz_01krdgeqcxet5s7t44vh8rt9mg', limit=2)
print(result)for item, err := range client.Amb.Suppressions.List(ctx, bird.AmbSuppressionsListParams{BusinessAccountID: "abz_01krdgeqcxet5s7t44vh8rt9mg", Limit: 2}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(item)
}foreach ($bird->amb->suppressions->list(['business_account_id' => 'abz_01krdgeqcxet5s7t44vh8rt9mg', 'limit' => '2']) as $item) {
var_dump($item);
}bird amb suppressions listcurl -X GET "https://us1.platform.bird.com/v1/amb/suppressions" \
-H "Authorization: Bearer $TOKEN" \
--url-query "address=+15551234567" \
--url-query "limit=25"{
"data": [
{
"id": "asp_01krdgeqcxet5s7t44vh8rt9mg",
"business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
"address": "+15551234567",
"address_type": "opaque_user_id",
"reason": "manual",
"origin": "user",
"applies_to": "all",
"source_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
"source_event_id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
"source_end_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
"ended_reason": "user"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns a paginated list of the workspace's active Apple Messages for Business suppressions: customers who have opted out of one brand, or of the whole workspace. Episodes that have ended are left out; fetch one by ID to read it. Filter by business_account_id to see one brand's suppressions, including the workspace-wide ones that block it too.
Paramètres de requête
business_account_idstringKeep only suppressions for this brand, including the workspace-wide ones that block it too. Omit to see suppressions for every brand in the workspace.
addressstringPrefix filter on the suppressed phone number or opaque identifier (case-insensitive). A complete value returns only that address; a partial value returns every match.
address_typestringKeep only suppressions of this kind.
Possible values: phone_number, opaque_user_id
reasonstringKeep only suppressions with this reason.
Possible values (may grow over time): manual, opted_out
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor 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.
Contenu de la réponse
dataActive suppression episodes for the workspace, most recently effective first. Episodes that have ended are left out; fetch one by ID to read it.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.