Stažení ceníku

API URL

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

https://portal.bulkgate.com/api/1.0/price-list/get

Poznámka

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

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

Poznámka

Api má nastavenou kvótu na 20 požadavků za minutu.

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	-
country	Pole kódů zemí žádaných ceníků.	Ano	-
wallet	Název peněženky.	Ne	Hlavní peněženka

Na rozdíl od ostatních endpointů odmítne price-list/get každý parametr, který není v tabulce výše, chybou invalid_input_parameters. country musí být vždy pole, i pro jedinou zemi.

Příklad úplného požadavku

POST /api/1.0/price-list/get HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "country": ["sk", "cz"], "wallet": "bg1905014138000023" }

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

V případě úspěchu:

{ "data": { "price_list": { "cz": [ { "operator": "Nordic Telecom", "operator_code": "23004", "type": "gSystem", "price": 0.79, "currency": "", "gate": 0, "economy": false, "unicode": true, "two_way": true, "registration": true, "registration_fee": 3.0, "registration_delay": 2, "monthly_fee": 1.0, "route_quality": "DIRECT", "route_note": "Pozn", "sender_note": "Poznamka 0", "default_senders": [ "+420602123456" ] }, { "operator": "O2", "operator_code": "23002", "type": "gSystem", "price": 0.79, "currency": "", "gate": 0, "economy": false, "unicode": true, "two_way": true, "registration": false, "registration_fee": 0.0, "registration_delay": 0, "monthly_fee": 0.0, "route_quality": "DIRECT", "route_note": null, "sender_note": null, "default_senders": [ "+420602123456" ] } ] } } }

Položka ceníku

data.price_list je objekt klíčovaný kódem země; pod každým klíčem je pole tras. Země, ke které ceník neexistuje, v odpovědi není vůbec.

POLE	HODNOTA
operator	Název operátora
operator_code	Kód operátora
type	Typ odesílatele na trase: `gTextOwn`, `gSystem`, `gShort`, `gText`, `gOwn`, `gMobile`, `gPush`, nebo `gNone`, když trasa žádný nemá
price	Cena jednoho dílu zprávy, zaokrouhlená na 4 desetinná místa a přepočtená do měny peněženky
currency	Měna peněženky, ke které ceník patří
gate	Číslo brány `0`–`6`, `985` pro Mobile Connect
economy	Ekonomická trasa
unicode	Trasa podporuje Unicode
two_way	Trasa podporuje obousměrnou komunikaci. Pro `gOwn` je vždy `true`
registration	Odesílatele je nutné před odesláním zaregistrovat, viz Registrace textového odesílatele
registration_fee	Jednorázový poplatek za registraci odesílatele. Dává smysl jen společně s `registration`
registration_delay	Jak dlouho registrace trvá. Dává smysl jen společně s `registration`
monthly_fee	Pravidelný měsíční poplatek za registrovaného odesílatele. Dává smysl jen společně s `registration`
route_quality	Jedna z hodnot `HQ`, `PARTNER DIRECT`, `DIRECT`, `SIM`, `WH`, `SS7`, `PARTNER SS7`, `OFFNET DIRECT - NATIONAL`, `OFFNET DIRECT - GROUP`, `OFFNET DIRECT - INTERNATIONAL` a jejich `PARTNER` varianty. Prázdný řetězec, když kvalita není známá
route_note	Poznámka k trase, `null` když žádná není
sender_note	Poznámka k odesílateli, `null` když žádná není
default_senders	Pole výchozích odesílatelů trasy

V případě chyby:

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

{ "type": "the_quota_of_send_per_minute_has_been_exceeded", "code": 400, "error": "The quota of send per minute has been exceeded", "detail": null }

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

{ "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "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ě

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

Zeptat se AI Zkopírováno