Odebrání z blacklistu

Odebere číslo z blacklistu, případně celou skupinu čísel podle source_id.

API URL

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

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

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/remove 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	-
wallet	Peněženka, ze které budou čísla odstraněna	Ne	Výchozí peněženka
number	Číslo, které bude odstraněno z blacklistu	Ano nebo `source_id`	-
source_id	Identifikátor skupiny čísel k odstranění z blacklistu	Ano nebo `number`	-
type	Seznam, ze kterého se čísla odeberou — `black-list`, nebo `opt-out`	Ne	`black-list`

Poznámka

Parametry number a source_id nelze zadat současně — použijte právě jeden z nich.

Příklad požadavku

POST /api/1.0/black-list/remove HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "wallet": "bg1905014138000023", "source_id": "api-my-import" }

Odpověď

V případě úspěchu:

{ "data": { "message": "Black list contacts have been removed" } }

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": "missing_parameters", "code": 400, "error": "Missing parameters", "detail": null }

{ "type": "use_number_or_source_id_not_both", "code": 400, "error": "Use number or source id not both", "detail": null }

{ "type": "number_doesnt_exist", "code": 400, "error": "Number doesnt exist", "detail": null }

{ "type": "invalid_number", "code": 400, "error": "Invalid number", "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`	Žádné z uvedených čísel není platné.
`missing_parameters`	Chybí `number` i `source_id`.
`use_number_or_source_id_not_both`	`number` a `source_id` byly zadány současně.
`number_doesnt_exist`	Číslo v blacklistu není.
`invalid_number`	`number` není platné telefonní číslo.

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

Zeptat se AI Zkopírováno