Specifikace

API URL

Adresa URL používaná k odeslání požadavků HTTP:

https://portal.bulkgate.com/api/1.0/black-list/load

POST /api/1.0/black-list/load HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

Api má nastavenou kvótu na 20 požadavků denně.

Tabulka s parametry

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
application_id	Aplikační identifikátor	Ano	-
application_token	Aplikační ověřovací token	Ano	-
campaign_id	Vybere pouze záznamy konkrétní kampaně	Ano nebo from	-
from	Vybere záznamy od konkrétního data. Přijímá následující formát: unix timestamp, nebo ISO 8601.	Ano nebo campaign_id	-
to	Vybere záznamy do konkrétního data. Přijímá následující formát: unix timestamp, nebo ISO 8601.	ne	now

Příklad úplného požadavku:

POST /api/1.0/black-list/load HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",     
  "campaign_id": "id-bulkgate-000001",
  "from": "2018-05-14T18:30:00-01:00",
  "to": "2018-05-15T18:30:00-01:00"
}

Odpověď na tento příkaz může být:

V případě úspěchu:

{
    "data": [ 
        {
            "id": 198668,
            "wallet": "bg1905014138000023",
            "number": "420777777777",
            "date": "2018-11-21T15:30:31+01:00",
            "unix_date": 1542810631,
            "campaign_id": "id-bulkgate-000001",
            "source": "web",
            "source_id": "",
            "reason": "Nechci dostávat od Vás obchodní sdělení."
        },
        {
            "id": 198667,
            "wallet": "bg1905014138000023",
            "number": "420777777778",
            "date": "2018-11-21T15:30:35+01:00",
            "unix_date": 1542810635,
            "campaign_id": "",
            "source": "import",
            "source_id": "import.csv",
            "reason": ""
        }
    ]
}

V případě chyby:

{
  "error": "The daily quota (20 requests) has been exceeded.",
  "code": 400
}