## API URL Adresa URL používaná na odosielanie HTTP požiadaviek: ```url https://portal.bulkgate.com/api/1.0/price-list/get ``` > [!NOTE] > Ak sa požiadavka nedostane k cieľu, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`. ```http POST /api/1.0/price-list/get HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json ``` > [!NOTE] > API má nastavenú kvótu na 20 požiadaviek za minútu. ### Tabuľka s parametrami | NÁZOV PARAMETRA | HODNOTA | POVINNÝ | PREDVOLENÁ HODNOTA | |:------------------|:-------------------------------------------------------|:---------|:-----------------| | application_id | [Aplikačný identifikátor](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/) | **Áno** | - | | application_token | [Aplikačný overovací token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/) | **Áno** | - | | country | Pole kódov krajín požadovaných cenníkov. | **Áno** | - | | wallet | Názov peňaženky. | Nie | Hlavná peňaženka | > Na rozdiel od ostatných endpointov zamietne `price-list/get` každý parameter, ktorý nie je v tabuľke vyššie, chybou `invalid_input_parameters`. `country` musí byť vždy pole, aj pre jedinú krajinu. ### Príklad úplnej požiadavky ```http-json 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" } ``` ## Odpoveď na tento príkaz môže byť: **V prípade úspechu:** ```json { "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 cenníka `data.price_list` je objekt s kľúčmi podľa kódu krajiny; pod každým kľúčom je pole trás. Krajina, ku ktorej cenník neexistuje, v odpovedi **vôbec nie je**. | POLE | HODNOTA | |:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| | operator | Názov operátora | | operator_code | Kód operátora | | type | Typ odosielateľa na trase: `gTextOwn`, `gSystem`, `gShort`, `gText`, `gOwn`, `gMobile`, `gPush`, alebo `gNone`, keď trasa žiadny nemá | | price | Cena jednej časti správy, zaokrúhlená na 4 desatinné miesta a prepočítaná do meny peňaženky | | currency | Mena peňaženky, ku ktorej cenník patrí | | gate | Číslo brány `0`–`6`, `985` pre [Mobile Connect](https://www.bulkgate.com/sk/centrum-pomoci/mobile-connect/instalacia-aplikacie-mobile-connect/) | | economy | Ekonomická trasa | | unicode | Trasa podporuje Unicode | | two_way | Trasa podporuje [obojsmernú komunikáciu](https://www.bulkgate.com/sk/produkty/2-way-sms/). Pre `gOwn` je vždy `true` | | registration | Odosielateľa je potrebné pred odoslaním zaregistrovať, pozrite [Registrácia textového odosielateľa](https://www.bulkgate.com/sk/centrum-pomoci/sms/ako-zaregistrovat-textoveho-odosielatela/) | | registration_fee | Jednorazový poplatok za registráciu odosielateľa. Dáva zmysel len spolu s `registration` | | registration_delay | Ako dlho registrácia trvá. Dáva zmysel len spolu s `registration` | | monthly_fee | Pravidelný mesačný poplatok za registrovaného odosielateľa. Dáva zmysel len spolu s `registration` | | route_quality | Jedna z hodnôt `HQ`, `PARTNER DIRECT`, `DIRECT`, `SIM`, `WH`, `SS7`, `PARTNER SS7`, `OFFNET DIRECT - NATIONAL`, `OFFNET DIRECT - GROUP`, `OFFNET DIRECT - INTERNATIONAL` a ich `PARTNER` varianty. **Prázdny reťazec**, keď kvalita nie je známa | | route_note | Poznámka k trase, `null`, keď žiadna nie je | | sender_note | Poznámka k odosielateľovi, `null`, keď žiadna nie je | | default_senders | Pole predvolených odosielateľov trasy | **V prípade chyby:** ```json { "type": "invalid_wallet", "code": 400, "error": "Invalid wallet", "detail": null } ``` ```json { "type": "the_quota_of_send_per_minute_has_been_exceeded", "code": 400, "error": "The quota of send per minute has been exceeded", "detail": null } ``` ```json { "type": "invalid_input_parameters", "code": 400, "error": "Invalid input parameters", "detail": null } ``` ```json { "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null } ``` Kde: - **type** a **error** (popis chyby) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/) - **code** je HTTP kód chyby - **detail** je doplňujúca informácia o chybe