INinfobip
platform
blocklist

Get all blocklists

This method allows you to get all blocklist records or filter them based on specific parameters.

get/platform/1/blocklists

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

senderstring
Example:"10950"

The sender ID for which blocklist happened.

destinationstring
Example:"41793026727"

Blocklisted destination address.

channel'SMS' | 'EMAIL' | 'VOICE_OUTBOUND_TTS' | 'NEW_PUSH_NOTIF' | 'VIBER' | 'RCS' | 'WHATSAPP' | 'APPLE_MB' | 'MMS'

Channel used for sending for which blocklist happened.

Channel used for sending for which blocklist happened.

If you want to check blocklist records for all channels, this field can be left out.

sourceType'CUSTOM' | 'MO' | 'URL_OPT_OUT' | 'CAMPAIGN'

Represents the way blocklist record was created:

CUSTOM - blocklist record that was created manually

MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.

URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.

CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).

If source type is omitted while deleting, all blocklists that match delete request will be deleted regardless of the source type.

Represents the way blocklist record was created:

CUSTOM - blocklist record that was created manually

MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.

URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.

CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).

accountKeystring
Example:8F0792F86035A9F4290821F1EE6BC06A

Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. API to retrieve account key.

getAllAccountKeysBlocklistsboolean

If set to true, blocklist records for subaccounts will be returned as well.

createdDateFromstring date-time
Example:2022-08-18T12:33:42.123Z

Use with createDateTo to search for blocklists for a particular date range.

createdDateTostring date-time
Example:2022-08-18T13:33:42.123Z

Use with createDateFrom to search for blocklists for a particular date range.

campaignstring
Example:summersale

ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.

pageinteger

Requested page number.

sizeinteger
Example:10

Requested page size.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.