Transakčné správy – špecifikácia

API URL

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

https://portal.bulkgate.com/api/1.0/integration/transactional

Poznámka

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

POST /api/1.0/integration/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Pozor

Je prísne zakázané využívať transakčné SMS na propagačné/marketingové účely. Smú sa používať len na oznamovacie účely – ako SMS oznámenia.

Poznámka

Ak chcete transakčnú routu použiť na zasielanie hromadných transakčných správ, obráťte sa na našu podporu. Z opodstatnených dôvodov vám túto možnosť môžeme povoliť.

Upozornenie

Správu dostanú aj príjemcovia, ktorí sa z odberu odhlásili (odhlásenie z odberu platí len pre propagačné správy).

Tabuľka s parametrami

NÁZOV PARAMETRA	HODNOTA	POVINNÝ	PREDVOLENÁ HODNOTA
application_id	ID aplikácie	Áno	-
application_token	Overovací token aplikácie	Áno	-
tag	Vlastná identifikačná značka	Nie	-
primary_channel	Primárny kanál, ktorý sa v kaskáde použije ako prvý	Nie	`sms`
phone_number	Telefónne číslo príjemcu	Áno	-
country	Zadajte čísla príjemcov v medzinárodnom formáte (s predvoľbou, napr. `420`) alebo pridajte kód krajiny (`775123456` + `CZ` = `420775123456`). Pozrite si príklad požiadavky s krajinou. Ak je hodnota `null`, na doplnenie informácie sa použije vaše nastavené časové pásmo	Nie	`null`
schedule	Naplánujte čas a dátum odoslania v unixovom čase. Pozrite si príklady uvedené nižšie.	Nie	`null`
channels	Asociatívne pole objektov kanálov	Áno	Objekt kanála
duplicates_check	Zvoľte `true`, ak chcete zabrániť odosielaniu duplicitných správ na uvedené telefónne číslo. Ak je aktívna možnosť `false`, žiadne duplicity sa neodstránia.	Nie	`false`

Tabuľka parametrov objektu Viber

NÁZOV PARAMETRA	HODNOTA	POVINNÝ	PREDVOLENÁ HODNOTA
sender	Názov textového odosielateľa	Nie	-
expiration	Čas, po ktorom platnosť správy vyprší	Nie	`3600`
button_caption	Text tlačidla	Nie	`OK`
button_url	URL tlačidla	Nie	`#`
image	URL obrázka obsiahnutého v správe	Nie	`null`
image_zoom	Či sa dá obrázok zväčšiť	Nie	`false`
text	Text správy. Do šablóny je možné doplniť premenné z poľa `variables` (ďalší parameter) `Hello <first_name> <last_name> ....`	Áno	-
variables	Asociatívne pole na doplnenie premenných do textu, napr.: `{"first_name": "John", "last_name": "Doe"}`	Nie	`[]`

Tabuľka parametrov objektu SMS

NÁZOV PARAMETRA	HODNOTA	POVINNÝ	PREDVOLENÁ HODNOTA
sender_id	ID odosielateľa, pozrite typ ID odosielateľa	Nie	`gSystem`
sender_id_value	Hodnota odosielateľa – `gOwn` (napr. "420 777 777 777"), `gText` (napr. "BulkGate"), `gProfile` (napr. "423"), `gMobile` alebo `gPush` (KEY)	Nie	`''`
unicode	`Yes`/`true`/`1` pre Unicode SMS, `no`/`false`/`0` pre 7-bitové SMS	Nie	`false`
text	Text SMS správy (max. 612 znakov alebo 268 znakov, ak je aktivovaný Unicode), kódovanie UTF-8. Do šablóny je možné doplniť premenné z poľa `variables` (ďalší parameter) `Hello <first_name> <last_name> ....`	Áno	-
variables	Asociatívne pole na doplnenie premenných do textu, napr.: `{"first_name": "John", "last_name": "Doe"}`	Nie	`[]`

Typ ID odosielateľa `sender_id`

HODNOTA	POPIS
`gSystem`	Systémové číslo
`gShort`	Short Code
`gText`	Textový odosielateľ
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push – odošle notifikáciu do vašej aplikácie Mobile Connect
`gOwn`	Vlastné číslo (vyžaduje overenie čísla)
`gProfile`	ID profilu odosielateľa
`<int>`	ID profilu odosielateľa

Príklad úplnej požiadavky:

POST /api/1.0/integration/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "tag": "", "primary_channel": "sms", "phone_number": "420777777777", "country": "cz", "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "text": "test <variable_1>", "variables": { "variable_1": "name" } }, "sms": { "sender_id": "gSystem", "sender_id_value": "BulkGate", "unicode": false, "text": "test <variable_1>", "variables": { "variable_1": "name" } } } }

Odpoveď na tento príkaz môže byť:

V prípade úspechu

{ "data": { "status": "accepted", "message_id": "omni-############", "part_id": [ "omni-##############" ], "number": "420777777777", "channel": "sms" } }

V prípade chyby:

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "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
code predstavuje HTTP chybu
detail je doplňujúca informácia o chybe

Všetky typy chýb pre Simple API a Advanced API nájdete tu.

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

Opýtať sa AI Skopírované