Specifikace v1

API URL

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

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

POST /api/1.0/advanced/transactional HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

Zneužití transakční SMS pro propagační/marketingové účely je přísně zakázáno! Musí být použito pouze pro informační účely - jako informační SMS.

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	-
number	Číslo příjemce	Ano nebo admin	-
admin	Číslo notifikačního admina BulkGate. Více zde	Ano nebo number	-
text	Text SMS zprávy (max. 612 znaků nebo 268 znaků, jestliže je aktivován Unicode), UTF-8 kódování. Je možné doplnit proměnné do šablony z pole variables (další parametr) Hello <first_name> <last_name> ....	Ano	-
variables	Asociativní pole pro doplnění proměnných do textu např: {"first_name": "John", "last_name": "Doe"}	ne	[]
unicode	Yes/true/1 pro Unicode SMS, no/false/0 pro 7bit SMS	Ne	false
sender_id	ID odesílatele, viz typ ID odesílatele	Ne	gSystem
sender_id_value	Hodnota odesílatele - gOwn (např. "420 777 777 777"), gText (např. "BulkGate"), gProfile (např. "423"), gMobile or gPush (KEY)	Ne	null
country	Poskytněte čísla příjemců v mezinárodním formátu (s prefixem, např. 420) nebo přidejte kód země ve formátu ISO 3166-1 alpha-2 (775123456 + CZ = 420775123456). Podívejte se na příklad požadavku země. Pokud je hodnota null, je použita země z vašeho uživatelského profilu.	Ne	null
schedule	Naplánujte čas a datum odesílání v unix timestamp, nebo ISO 8601.	Ne	Nyní
duplicates_check	Zvolte možnost on, chcete-li zabránit odesílání duplicitních zpráv na stejné telefonní číslo. Zprávy se stejným textem zaslaným na stejné číslo budou odstraněny, pokud je časový interval kratší než 5 minut. Pokud je aktivní možnost off, žádné duplikáty nebudou odstraněny.	Ne	off
tag	Označení zpráv pro následné dohledání uživatele	Ne	-

Typ ID odesílatele sender_id

HODNOTA	VÝZNAM
gSystem	Systémové číslo
gShort	Short Code
gText	Textový odesílatel
gMobile	Mobile Connect
gPush	Mobile Connect push - Odešle notifikaci do vaší Mobile Connect aplikace
gOwn	Vlastní číslo (vyžaduje ověření čísla)
gProfile	BulkGate Profil ID
<int>	BulkGate Profil ID

Příklad úplného požadavku:

POST /api/1.0/advanced/transactional HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "APPLICATION_ID",
    "application_token": "APPLICATION_TOKEN",   
    "number": "420775123456",
    "unicode": true,
    "text": "Ahoj, <first_name> <last_name>",
    "variables": {"first_name": "John", "last_name": "Doe"},
    "sender_id": "gText",
    "sender_id_value": "BulkGate",
    "country": "cz",
    "schedule": "2018-05-14T18:30:00-01:00"
}

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

V případě úspěchu:

{
    "data": {
        "status": "accepted",
        "sms_id": "tmpde1bcd4b1d1",
        "part_id": [
            "tmpde1bcd4b1d1_1",
            "tmpde1bcd4b1d1"
        ],
        "number": "420777777777"
    }
}

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 info zde.

V případě chyby:

{
    "type": "invalid_phone_number",
    "code": 400,
    "error": "Neplatné číslo",
    "detail": null
}

{
    "type": "unknown_identity",
    "code": 401,
    "error": "Neznámá identita / neautorizovaná / prázdná application_id",
    "detail": null
}

Kde:

• type a error (popisek erroru) můžete vidět v tabulce typů errorů,
• 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.