Specifikace
API URL
Adresa URL používaná k odeslání požadavků HTTP:
https://portal.bulkgate.com/api/1.0/simple/transactional
Podporované HTTP metody
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 | - |
| text | Text SMS zprávy (max. 612 znaků nebo 268 znaků, jestliže je aktivován Unicode), UTF-8 kódování | Ano | - |
| 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, gText, gMobile, gProfile or gPush | 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 - Odešle SMS zprávu skrze vaši Mobile Connect aplikaci |
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 |
Odpověď na tento příkaz může být:
V případě úspěchu:
{
"data": {
"status": "accepted",
"sms_id": "tmpde1bcd4b1d1",
"price": 0.02,
"credit": 215.81380,
"number": "420777777777"
}
}
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.