Pridanie na blacklist

Pridá čísla do blacklistu. Na číslo v blackliste neodíde propagačná ani transakčná správa.

API URL

Adresa URL, na ktorú sa posielajú požiadavky HTTP:

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

Poznámka

Ak sa požiadavka nedostane do cieľa, zopakujte ju na záložnom serveri backup1.bulkgate.com.

Podporované HTTP metódy

POST - application/json

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

Tabuľka s parametrami

NÁZOV PARAMETRA	HODNOTA	POVINNÝ	PREDVOLENÁ HODNOTA
application_id	Identifikátor aplikácie	Áno	-
application_token	Overovací token aplikácie	Áno	-
numbers	Čísla na zaradenie do blacklistu — pole alebo reťazec oddelený čiarkami	Áno	-
wallet	Peňaženka, v ktorej sa čísla pridajú do blacklistu	Nie	Predvolená peňaženka
source_id	Identifikátor skupiny čísel pridaných do blacklistu	Nie	`api-<náhodný reťazec>`
reason	Dôvod zaradenia čísla do blacklistu	Nie	-
type	Zoznam, do ktorého sa čísla zaradia — `black-list` alebo `opt-out`	Nie	`black-list`

Príklad požiadavky

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": "Nechcem dostávať obchodné oznámenia." }

Odpoveď

V prípade úspechu:

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

V prípade 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) nájdete v tabuľke typov chýb
code je HTTP kód chyby
detail je doplňujúca informácia o chybe

Typy chýb Blacklist API

Popri všeobecných typoch vracia Blacklist API vlastné:

TYP	KEDY NASTANE
`invalid_wallet`	Zadaná peňaženka neexistuje alebo k nej nemáte prístup.
`no_valid_numbers`	V parametri `numbers` nie je žiadne platné číslo.
`number_already_exists`	Odosielate jediné číslo a to už v blackliste je.

Bola táto stránka užitočná?

Opýtať sa AI Skopírované