Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Subscribers

Blocklisted Contact Information

When the contact has been added to a specific list, we proceed to get the information of the contact that the blocklist contains. That is, this endpoint allows you to get a contact from a blocklist that belongs to a specific sender.

You need to provide the following parameters to retrieve the information of a blocklisted contact:

get/v2/subscribers

Query parameters

type'SMS' | 'EMAIL' | 'WHATSAPP' | 'RCS' required
<p>Type of delivery channel, in which the contact will no longer receive messages.</p><p><ul><li><code>´SMS´</code></li><li><code>´EMAIL´</code></li><li><code>´WHATSAPP´</code></li><li><code>´RCS´</code></li></ul></p>
fromstring required
<p>Enter the sending identity (Sender) according to the delivery channel.</p><p>Each sender has its own blocklist.</p>
listType'BLACK' required
<p>Type of list to which the contact is added.</p><p><ul><li><code>´BLACK´</code></li></p>
tostring required
<p>Contact data added to the blocklist according to the sending entity and delivery channel.</p> <p>Enter the Phone number of the contact in case the contact was added to the blocklist via SMS, WhatsApp or RCS.</p> <p>Enter the email address of the contact in case the contact was added to the blocklist via Email.</p>

Response

Successfully deleted

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}