Get an SMS suppression
GET
/v1/sms/suppressions/{suppression_id}
const suppression = await bird.smsSuppressions.get("sup_abc123");
console.log(suppression.reason, suppression.blocking);suppression = client.sms_suppressions.get("sup_abc123")
print(suppression.reason, suppression.blocking)suppression, err := client.SmsSuppressions.Get(context.Background(), "sup_01j9x2k3m4n5p6q7r8s9t0v1w2")
if err != nil {
log.Fatal(err)
}
fmt.Println(suppression.Originator, suppression.Destination, *suppression.Blocking)$suppression = $bird->smsSuppressions->get('sup_abc123');
echo $suppression->getReason(), ' ', var_export($suppression->getBlocking(), true);bird sms suppressions get <suppression-id>curl -X GET "https://us1.platform.bird.com/v1/sms/suppressions/{suppression_id}" \
-H "Authorization: Bearer $TOKEN"Returns one suppression: the sender and subscriber it covers, why messages are stopped, how the record came to exist, what it blocks, and whether it is still in force.
Unlike the list, this answers for a suppression that has already ended: blocking is false and the ended_* fields say when and why, so an ID you kept from a create or a delete stays readable. To find one when you only know the number, use GET /v1/sms/suppressions with the destination parameter. An ID that does not exist in the workspace returns 404.
Response Payload
id
string
verplicht
destination
string
verplicht
The subscriber, in E.164 format.
originator
string
verplicht
The sender this stops. A suppression covers one sender, so your other senders still reach this subscriber. Opting out of one of your programmes is not opting out of all of them.
reason
string
verplicht
origin
string
verplicht
applies_to
string
verplicht
blocking
boolean
verplicht
Whether this is stopping messages right now. Always true in a list, which carries only the suppressions in force; false when you fetch one by ID that has since ended, which is also when ended_at is set.
source_sms_id
nullable string
The inbound message the subscriber opted out with, or the outbound message whose delivery report reported the opt-out. Null when neither applies.
effective_at
string
verplicht
When the subscriber opted out, as reported by whoever reported it. This is what orders one subscriber's history, and it can be earlier than created_at when a message reached us late.
ended_at
nullable string
When this stopped applying. Null while it is still stopping messages.
ended_reason
nullable string
What ended it. Null while it is still stopping messages.
ended_effective_at
nullable string
When the subscriber opted back in, as reported. Null while it is still stopping messages.
source_end_sms_id
nullable string
The inbound message the subscriber opted back in with, when there was one. Null while it is still stopping messages, and when something other than a start keyword ended it.
created_at
string
verplicht
When we recorded it.
last_asserted_at
string
verplicht
When we last recorded the subscriber opting out of this sender. Later than created_at when they texted a stop keyword again while already suppressed, which adds no new record but does earn another confirmation reply.