## API URL Adresa URL používaná k odeslání požadavků HTTP: ```url https://portal.bulkgate.com/api/2.0/advanced/promotional ``` > [!NOTE] > Nedostane-li se požadavek k cíli, zopakujte ho na [záložním serveru](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/zalozni-server/) `backup1.bulkgate.com`. ## Podporované HTTP metody - `POST` - `application/json` ```http POST /api/2.0/advanced/promotional 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](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/administrace-api/) | **Ano** | - | | application_token | [Aplikační ověřovací token](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-tokeny/) | **Ano** | - | | number | Pole příjemců - [Hodnota number](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-promotional/2.0/) | **Ano** nebo `admins` nebo `groups` | - | | groups | Pole čísel skupin v adresáři BulkGate. [Více zde](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-promotional-posilani-zprav-skupinam-z-adresare/) | **Ano** nebo `number` nebo `admins` | - | | admins | Pole čísel notifikačních administrátorů BulkGate. [Více zde](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-promotional-posilani-propagacnich-zprav-administratorum/) | **Ano** nebo `number` nebo `groups` | - | | text | Text SMS zprávy (max. 612 znaků nebo 268 znaků, jestliže je aktivován Unicode), UTF-8 kódování. | **Ano**, pokud je `number` zadán polem čísel nebo je použit parametr `groups` nebo `admin` | - | | channel | Alternativní kanály. Kanály se zkoušejí v kaskádě v pořadí, v jakém je v objektu uvedete - pokud nebude možné doručit zprávu prvním kanálem, použije se další v pořadí. SMS se na konec kaskády **nepřidává** automaticky; pokud ji chcete jako poslední záchranu, uveďte v kaskádě objekt `sms`. Když není zadaný žádný kanál, odešle se zpráva jako SMS. | Ne | [SMS objekt](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-sms/) | | country | Poskytněte čísla příjemců v mezinárodním formátu (s prefixem, např. `420`) nebo přidejte [kód země](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) (`777777777` + `CZ` = `420777777777`). Podívejte se na příklad požadavku země. Pokud je hodnota **`null,`** poté se použije vaše nastavená časová zóna pro doplnění informace. | Ne | `null` | | schedule | Naplánujte čas a datum odesílání v [unix timestamp,](https://en.wikipedia.org/wiki/Unix_time) nebo [ISO 8601.](https://en.wikipedia.org/wiki/ISO_8601) Podívejte se na níže uvedené příklady. | Ne | Now | | duplicates_check | Zvolte možnost **`same_text`**, chcete-li zabránit odesílání duplicitních zpráv na stejné telefonní číslo. Zakažte možnost odeslat zprávu se stejným nebo jiným textem na stejné číslo s možností **`same_number`**. Pokud je aktivní **`null`**, žádné duplikáty nebudou odstraněny. Duplicity se odstraňují **jen v rámci jedné dávky**, ne napříč požadavky. | Ne | `null` | | tag | Označení zpráv pro následné dohledání uživatele. | Ne | - | ### Hodnota `number` Hodnotu number lze zapsat dvěma způsoby: - Pole telefonních čísel ```json [ "420777777777", "420888888888", "420999999999" ] ``` - Asociativní pole se schématem `number`, `text` a `variables`, kde jediný povinný parametr je `number`. Pokud `number` není vyplněn, zpráva se přeskočí. ```json [ {"number": "420777777777", "text": "test1 ", "variables": {"a": 5}}, {"number": "420888888888", "text": "test2 ", "variables": {"b": 5}}, {"number": "420999999999", "text": "test3 ", "variables": {"c": 3, "d": "abc"}} ] ``` Do šablony parametru `text` je možné doplnit proměnné z pole `variables`. ## Kanály Objekt `channel` určuje, kterými kanály se zpráva odešle a v jakém pořadí. **Pořadí klíčů v requestu je pořadím kaskády** a SMS se do ní nepřidává automaticky - viz [Kaskáda kanálů](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-kaskada/). | KLÍČ | OBJEKT KANÁLU | |:-------------|:-----------------------------------------------------------------| | `sms` | [SMS](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-sms/) | | `viber` | [Viber – promo](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-viber-promo/) | | `rcs` | [RCS](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-rcs/) | | `whatsapp` | [WhatsApp](https://www.bulkgate.com/cs/dokumentace/advanced-api/advanced-whatsapp/) | ## Příklady požadavků **Příklad úplného požadavku:** ```http-json POST /api/2.0/advanced/promotional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": [ {"number": "420777777777", "text": "test1 ", "variables": {"a": 5}}, {"number": "420888888888", "text": "test2 ", "variables": {"b": 5}}, {"number": "420999999999", "text": "test3 ", "variables": {"c": 3, "d": "abc"}} ], "groups": [1, 2], "admins": [1, 4], "text": "Hello, ", "country": "cz", "schedule": "2018-05-14T18:30:00-01:00", "channel": { "whatsapp": { "sender": "420777777777", "expiration": 300, "message": { "text": "text" } }, "rcs": { "sender": "BulkGate", "expiration": 300, "message": { "text": "text" } }, "viber": { "sender": "Lt. Hagan", "expiration": 100, "button": { "caption": "Jít na BulkGate", "url": "https://www.bulkgate.com/cs/blog/rcs-budoucnost-mobilnich-zprav-pro-firmy/" }, "image": "https://www.bulkgate.com/assets/illustrations/rcs-rich-communication-services.jpg", "text": "*RCS: Budoucnost mobilních zpráv pro firmy*\n\nPřáli jste si někdy, abyste mohli v SMS zprávě poslat víc než jen text, například obrázek ve vysokém rozlišení nebo interaktivní tlačítko? Nebo jste si přáli obdržet potvrzení o přečtení, abyste si ověřili, že byla vaše zpráva úspěšně doručena? Služba Rich Communication Services (RCS) je tu, aby revolučním způsobem změnila způsob obchodní komunikace, zlepšila zážitek ze zasílání zpráv a překonala tato omezení." }, "sms": { "sender_id": "gText", "sender_id_value": "Lt-Hagan", "unicode": true, "text": "RCS: Budoucnost mobilních zpráv pro firmy" } } } ``` **Příklad požadavku zadání příjemců polem čísel a naplánování čas v unix timestamp:** ```http-json POST /api/2.0/advanced/promotional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": [ "420777777777", "420888888888", "420999999999" ], "text": "Hello, ", "schedule": "1526992636" } ``` ## Odpověď **V případě úspěchu:** ```json { "data": { "total": { "status": { "sent": 0, "accepted": 0, "scheduled": 2, "error": 0, "blacklisted": 0, "invalid_number": 1, "invalid_sender": 0 } }, "response": [ { "status": "scheduled", "sms_id": "idyrcmdd-0", "part_id": [ "idyrcmdd-0_1", "idyrcmdd-0" ], "number": "420777777777", "channel": "sms" }, { "status": "scheduled", "sms_id": "idyrcmdd-1", "part_id": [ "idyrcmdd-1_1", "idyrcmdd-1" ], "number": "420888888888", "channel": "sms" }, { "status": "invalid_number", "code": 400, "error": "Invalid phone number", "detail": null, "number": "420999999999", "channel": "sms" } ] } } ``` Kde: - **part_ID** je pole ID částí původní dlouhé zprávy, která byla rozdělena, protože nesplňovala limit 160 znaků pro jednu zprávu. Více [zde.](https://www.bulkgate.com/cs/centrum-napovedy/sms/zretezeni-zprav/) **V případě chyby:** ```json { "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null } ``` ```json { "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null } ``` Kde: - **type** a **error** (popisek erroru) můžete vidět v [tabulce typů errorů](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/) - **code** představuje http error - **detail** je dodatečná informace o erroru Všechny typy errorů pro Simple API a Advanced API můžete najít [zde.](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/)