Propagačné SMS – špecifikácia

API URL

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

https://portal.bulkgate.com/api/1.0/simple/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

GET
POST - application/x-www-form-urlencoded
POST - application/json

Príklady pre každú z nich nájdete v metódach požiadavky.

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	Čísla príjemcov oddelené `;` (bodkočiarkou)	Áno	-
text	Text SMS správy (max. 612 znakov alebo 268 znakov, ak je aktivovaný Unicode), kódovanie UTF-8	Áno	-
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	-
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. Hodnota `now` odošle správu okamžite, rovnako ako keď parameter vynecháte.	Nie	Teraz
duplicates_check	Zvoľte možnosť `on`, ak chcete zabrániť odosielaniu duplicitných správ na rovnaké telefónne číslo. Správy s rovnakým textom zaslané na rovnaké číslo sa odstránia. Ak je aktívna možnosť `off`, ž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	-

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:

https://portal.bulkgate.com/api/1.0/simple/promotional ?application_id=451 &application_token=NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj &number=420777777777;420775123456;606123456 &text=test_sms &unicode=yes &sender_id=gText &sender_id_value=BulkGate &country=cz &schedule=2018-05-14T18:30:00-01:00

Príklad požiadavky s krajinou:

Príklad požiadavky s ISO 8601:

https://portal.bulkgate.com/api/1.0/simple/promotional ?application_id=451 &application_token=NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj &number=420775123456;420606123456 &text=test_sms &schedule=2018-05-14T18:30:00-01:00

Príklad požiadavky s unix timestamp:

Príklad POST JSON požiadavky:

POST /api/1.0/simple/promotional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777;420775123456;606123456", "text": "test_sms", "unicode": true, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "cz", "schedule": "2018-05-14T18:30:00-01:00" }

Odpoveď

V prípade úspechu:

{ "data": { "total": { "status": { "sent": 0, "accepted": 0, "scheduled": 2, "error": 1 } }, "response": [ { "status": "scheduled", "sms_id": "idfkvqrp-0", "part_id": [ "idfkvqrp-0_1", "idfkvqrp-0_2", "idfkvqrp-0" ], "number": "420775123456" }, { "status": "scheduled", "sms_id": "idfkvqrp-1", "part_id": [ "idfkvqrp-1_1", "idfkvqrp-1_2", "idfkvqrp-1" ], "number": "420606123456" }, { "status": "error", "code": 9, "error": "Invalid phone number", "number": "44771447678" } ] } }

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é