Blacklist

This method allows you to retrieve your blacklist. A contact who replies STOP or unsubscribe through the STOP link will automatically be moved into your blacklist.

GET

/blacklist

Examples


GET /blacklist HTTP/1.1
Host: api.smsfactor.com
Accept: application/json
Authorization: Bearer your.token

Result Format


{
  "status": 1,
  "message": "OK",
  "list": [
      {
          "id": "5a4e49d9fc5886067c13f533",
          "destination": "33612345678",
          "date": "2024-12-22 05:18:14"
          "info1": "Isaac",
          "info2": "Asimov",
          "info3": "1919",
          "info4": "Petrovichi",
          "user_information": [],
          "campaign_id": null,
          "batch_id": null
      },
      {
          "id": "5a4e4a00fc5886067c13f534",
          "destination": "33612345677",
          "date": "2024-12-22 05:18:14"
          "info1": "Howard",
          "info2": "Phillips",
          "info3": "Lovecraft",
          "info4": "",
          "user_information": [],
          "campaign_id": 47858459,
          "batch_id": null
      }
  ],
  "totalRecords": 2,
  "totalDisplayRecords": 2
}


<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>1</status>
    <message>OK</message>
    <list>
        <id>5a4e49d9fc5886067c13f533</id>
        <destination>33612345678</destination>
        <date>2024-12-22 05:18:14</date>
        <info1>Isaac</info1>
        <info2>Asimov</info2>
        <info3>1919</info3>
        <info4>Petrovichi</info4>
        <user_information></user_information>
        <campaign_id>null</campaign_id>
        <batch_id>null</batch_id>
    </list>
    <list>
        <id>5a4e4a00fc5886067c13f534</id>
        <destination>33612345677</destination>
        <date>2024-12-22 05:18:14</date>
        <info1>Howard</info1>
        <info2>Phillips</info2>
        <info3>Lovecraft</info3>
        <info4></info4>
        <user_information></user_information>
        <campaign_id>47858459</campaign_id>
        <batch_id>null</batch_id>
    </list>
    <totalRecords>2</totalRecords>
    <totalDisplayRecords>2</totalDisplayRecords>
</response>