sms-suppressions

Get an SMS suppression

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.

This operation also returns a suppression that has already ended. The blocking field is false, and the ended_* fields say when and why. An ID you kept from a create or delete therefore 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.

get/v1/sms/suppressions/{suppression_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/suppressions/{suppression_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

SMS suppression.

idstring required
destinationstring required

The subscriber, in E.164 format.

originatorstring required

The sender this stops. A suppression covers one sender, so your other senders still reach this subscriber. Opting out of one of your programs does not opt out of the others.

reasonstring required

Reason this sender cannot message the subscriber:

  • keyword_stop: The subscriber sent a stop keyword. A start keyword clears it.
  • carrier_opted_out: The carrier reported the opt-out.
  • manual: Your workspace added the suppression through the API or dashboard.

This is an open enum. Accept unrecognized values.

originstring required

How the opt-out reached us:

  • keyword: an inbound message from the subscriber.
  • dlr_event: a carrier delivery report.
  • api_key: an API call.
  • user: someone acting in the dashboard.

Kept beside the reason because one reason can arrive by more than one route.

This list grows over time, so treat an unknown value as informational rather than rejecting the record.

applies_tostring required

Message categories blocked for this sender and subscriber. all blocks every category, including authentication and transactional messages. non_transactional blocks marketing messages only. Responses currently use all. Treat unrecognized values as blocking every category.

blockingboolean required

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_idstring
effective_atstring date-time required

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_atstring date-time nullable

When this stopped applying. Null while it is still stopping messages.

ended_reasonstring

What ended it:

  • keyword_start: the subscriber texting a start keyword to the same sender.
  • api_key: an API call.
  • user: someone acting in the dashboard.
  • carrier_cleared: the carrier reporting its own opt-out cleared.

This list grows over time, so treat an unknown value as informational rather than rejecting the record.

ended_effective_atstring date-time nullable

When the subscriber opted back in, as reported. Null while it is still stopping messages.

source_end_sms_idstring
created_atstring date-time required

When we recorded it.

last_asserted_atstring date-time required

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.

Example response

{
  "id": "ssu_01krdgeqcxet5s7t44vh8rt9mg",
  "destination": "+15550001234",
  "originator": "+15557654321",
  "source_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
  "source_end_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.