Přidání na blacklist

Přidá čísla do blacklistu. Na číslo v blacklistu neodejde promoční ani transakční zpráva.

API URL

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

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

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/add HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

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	-
numbers	Čísla k zařazení do blacklistu — pole, nebo řetězec oddělený čárkami	Ano	-
wallet	Peněženka, na které budou čísla přidána do blacklistu	Ne	Výchozí peněženka
source_id	Identifikátor skupiny čísel přidaných do blacklistu	Ne	`api-<náhodný řetězec>`
reason	Důvod zařazení čísla do blacklistu	Ne	-
type	Seznam, do kterého se čísla zařadí — `black-list`, nebo `opt-out`	Ne	`black-list`

Příklad požadavku

POST /api/1.0/black-list/add HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "numbers": ["420123456789", "420987654321"], "wallet": "bg1905014138000023", "source_id": "api-my-import", "reason": "Nechci dostávat obchodní sdělení." }

Odpověď

V případě úspěchu:

{ "data": { "message": "contacts have been blacklisted" } }

V případě chyby:

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

{ "type": "no_valid_numbers", "code": 400, "error": "No valid numbers", "detail": null }

{ "type": "number_already_exists", "code": 400, "error": "Number already exists", "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.
`no_valid_numbers`	V parametru `numbers` není žádné platné číslo.
`number_already_exists`	Odesíláte jediné číslo a to už v blacklistu je.

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

Zeptat se AI Zkopírováno