List SMS suppressions
/v1/sms/suppressionsfor await (const suppression of bird.smsSuppressions.list()) {
console.log(suppression.originator, suppression.destination, suppression.reason);
}for suppression in client.sms_suppressions.list():
print(suppression.originator, suppression.destination, suppression.reason)for suppression, err := range client.SmsSuppressions.List(context.Background(), bird.SmsSuppressionsListParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(suppression.Originator, suppression.Destination, *suppression.Reason)
}foreach ($bird->smsSuppressions->list() as $suppression) {
echo $suppression->getOriginator(), ' ', $suppression->getDestination(), PHP_EOL;
}bird sms suppressions listcurl -X GET "https://us1.platform.bird.com/v1/sms/suppressions" \
-H "Authorization: Bearer $TOKEN" \
--url-query "destination=+15550001234" \
--url-query "originator=+15557654321" \
--url-query "limit=25"{
"data": [
{
"id": "ssu_01krdgeqcxet5s7t44vh8rt9mg",
"destination": "+15550001234",
"originator": "+15557654321",
"reason": "keyword_stop",
"origin": "keyword",
"applies_to": "all",
"source_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
"ended_reason": "keyword_start",
"source_end_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the suppressions currently stopping your messages, most recent opt-out first. Pass destination to look up one subscriber before sending to them.
A suppression covers one sender and one subscriber, so the same number can appear more than once: opting out of one of your senders does not opt out of the others.
Ended suppressions are excluded. A subscriber who opted back in is reachable again and does not appear in this list.
Paramètres de requête
destinationstringReturn only suppressions for this exact subscriber number in E.164 form. Prefix matching is unsupported.
originatorstringReturn only suppressions covering this sender.
reasonstringReturn 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
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
dataPage of suppressions, most recent opt-out first.
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.