Stažení blacklistu

Načte záznamy z blacklistu — čísla, která si odesílání zpráv zakázala nebo byla do blacklistu vložena importem či přes API.

API URL

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

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

Poznámka

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

POST - application/json

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

Poznámka

API má nastavenou kvótu na 20 požadavků za den.

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	-
from	Vybere záznamy od konkrétního data. Přijímá formát unix timestamp nebo ISO 8601.	Ano	-
to	Vybere záznamy do konkrétního data. Přijímá formát unix timestamp nebo ISO 8601.	Ne	`now`
campaign_id	Vybere pouze záznamy konkrétní kampaně	Ne	-
wallet	Vybere pouze záznamy konkrétní peněženky	Ne	Výchozí peněženka

Poznámka

Maximální rozsah mezi from a to je 30 dní.

Příklad požadavku

POST /api/1.0/black-list/load HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "campaign_id": "id-bulkgate-000001", "wallet": "bg1905014138000023", "from": "2018-05-14T18:30:00-01:00", "to": "2018-05-15T18:30:00-01:00" }

Odpověď

V případě úspěchu:

{ "data": [ { "key": "198668", "id": "198668", "wallet": "bg1905014138000023", "phone_number": "420777777777", "country": "cz", "type": "black-list", "created": "2018-11-21T15:30:31+01:00", "modified": null, "source": "web", "source_key": null, "reason": "Nechci dostávat obchodní sdělení.", "campaign_id": "id-bulkgate-000001", "application_id": 451, "channel": null, "tag": null, "contact": null }, { "key": "198667", "id": "198667", "wallet": "bg1905014138000023", "phone_number": "420777777778", "country": "cz", "type": "black-list", "created": "2018-11-21T15:30:35+01:00", "modified": null, "source": "import", "source_key": "import.csv", "reason": null, "campaign_id": null, "application_id": 451, "channel": null, "tag": null, "contact": null } ] }

Kde:

key a id jsou identifikátor záznamu (shodná hodnota)
phone_number je číslo v mezinárodním formátu
type je black-list, nebo opt-out
created a modified jsou časy vytvoření a poslední změny záznamu v ISO 8601
source je způsob, jakým se číslo do blacklistu dostalo — web, import, api, manual, nebo auto
source_key je identifikátor skupiny, se kterou bylo číslo vloženo. U záznamů se source = import obsahuje název importovaného souboru.
reason je důvod uvedený při zařazení čísla do blacklistu

V případě chyby:

{ "type": "invalid_wallet", "code": 400, "error": "Invalid wallet", "detail": null }

{ "type": "invalid_input_parameters", "code": 400, "error": "Invalid input parameters", "detail": null }

{ "type": "maximal_date_range_is_30_days", "code": 400, "error": "Maximal date range is 30 days", "detail": null }

{ "type": "the_daily_quota_has_been_exceeded", "code": 400, "error": "The daily quota has been exceeded", "detail": null }

Kde:

type a error (popis chyby) najdete v tabulce typů chyb
code je HTTP kód chyby
detail je doplňující informace o chybě

Typy chyb Blacklist API

Vedle obecných typů vrací Blacklist API vlastní:

TYP	KDY NASTANE
`invalid_wallet`	Zadaná peněženka neexistuje nebo k ní nemáte přístup.
`invalid_input_parameters`	Chybí `from`, má neplatný formát, nebo není starší než `to`.
`maximal_date_range_is_30_days`	Rozsah mezi `from` a `to` je delší než 30 dní.
`the_daily_quota_has_been_exceeded`	Vyčerpaná kvóta požadavků.

Byla tato stránka užitečná?

Zeptat se AI Zkopírováno