Propagačné SMS – špecifikácia (Advanced API 1.0)

API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

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

Poznámka

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

Podporované HTTP metódy

POST - application/json

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

Tabuľka s parametrami

NÁZOV PARAMETRA	HODNOTA	POVINNÝ	PREDVOLENÁ HODNOTA
application_id	Aplikačný identifikátor	Áno	-
application_token	Aplikačný overovací token	Áno	-
number	Pole príjemcov - Hodnota number	Áno alebo `admins` alebo `groups`	-
groups	Pole čísel skupín v adresári BulkGate. Viac tu	Áno alebo `number` alebo `admins`	-
admins	Pole čísel notifikačných administrátorov BulkGate. Viac tu	Áno alebo `number` alebo `groups`	-
text	Text SMS správy (max. 612 znakov alebo 268 znakov, ak je aktivovaný Unicode), kódovanie UTF-8.	Áno, ak je `number` zadaný poľom čísel alebo je použitý parameter `groups` alebo `admin`	-
unicode	`Yes`/`true`/`1` pre Unicode SMS, `no`/`false`/`0` pre 7bit SMS	Nie	`false`
sender_id	ID odosielateľa, pozri 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	`null`
country	Uveďte čí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 unix timestamp, alebo ISO 8601. Pozrite si príklady uvedené nižšie	Nie	Teraz
duplicates_check	Zvoľte možnosť `same_text`, ak chcete zabrániť odosielaniu duplicitných správ na rovnaké telefónne číslo. Možnosťou `same_number` zakážete odoslanie správy s rovnakým alebo iným textom na rovnaké číslo. Ak je aktívna hodnota `null`, žiadne duplicity sa neodstránia. Duplicity sa odstraňujú len v rámci jednej dávky, nie naprieč požiadavkami.	Nie	`null`
tag	Označenie správ na ich neskoršie dohľadanie používateľom	Nie	-

Hodnota `number`

Hodnotu number je možné zapísať dvoma spôsobmi:

Pole telefónnych čísel

[ "420775123456", "420606123456", "44771447678" ]

Asociatívne pole so schémou number, text a variables, kde jediný povinný parameter je number. Ak number nie je vyplnený, správa sa preskočí.

[ {"number": "420775123456", "text": "test1 <a>", "variables": {"a": 5}}, {"number": "420606123456", "text": "test2 <a>", "variables": {"b": 5}}, {"number": "44771447678", "text": "test3 <b> <d>", "variables": {"c": 3, "d": "abc"}} ]

Do šablóny parametra text je možné doplniť premenné z poľa variables.

Typ ID odosielateľa `sender_id`

HODNOTA	VÝZNAM
`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`	BulkGate Profil ID
`<int>`	BulkGate Profil ID

Príklady požiadaviek

Príklad úplnej požiadavky:

POST /api/1.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": "420775123456", "text": "test1 <a>", "variables": {"a": 5}}, {"number": "420606123456", "text": "test2 <a>", "variables": {"b": 5}}, {"number": "44771447678", "text": "test3 <b> <d>", "variables": {"c": 3, "d": "abc"}} ], "unicode": true, "groups": [1, 2], "admins": [1, 4], "text": "Hello, <first_name> <last_name>", "sender_id": "gText", "sender_id_value": "BulkGate", "country": "cz", "schedule": "2018-05-14T18:30:00-01:00" }

Príklad požiadavky so zadaním príjemcov poľom čísel a naplánovaním času v unix timestamp:

POST /api/1.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": [ "420775123456", "420606123456", "44771447678" ], "text": "Hello, <first_name> <last_name>", "schedule": "1526992636" }

Odpoveď

V prípade úspechu:

{ "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": "420775123456", "channel": "sms" }, { "status": "scheduled", "sms_id": "idyrcmdd-1", "part_id": [ "idyrcmdd-1_1", "idyrcmdd-1" ], "number": "420606123456", "channel": "sms" }, { "status": "invalid_number", "code": 400, "error": "Invalid phone number", "detail": null, "number": "44771447678", "channel": "sms" } ] } }

Kde:

part_ID je pole ID častí pôvodnej dlhej správy, ktorá bola rozdelená, pretože nespĺňala limit 160 znakov pre jednu správu. Viac informácií tu.

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é