/
Dokumentácia pre vývojárov BulkGate
/
Simple API
/
Transakčné SMS – príklady
Transakčné SMS – príklady
Príklady použitia Simple transactional . Simple API odošle jednu SMS jednou požiadavkou - pole príjemcov a alternatívne kanály ponúka až Advanced API .
Najmenšia možná požiadavka, ktorá odošle notifikáciu. number je jedno telefónne číslo v medzinárodnom formáte.
POST /api/1.0/simple/transactional HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"number" : "420777777777" ,
"text" : "Your order 4517 has been shipped."
}
gText odošle správu z registrovaného textového odosielateľa. unicode zapnite vždy, keď text obsahuje znaky mimo 7-bitovej abecedy - skráti správu na 268 znakov na jednu časť.
POST /api/1.0/simple/transactional HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"number" : "420777777777" ,
"text" : "Vaša zásielka 4517 je na ceste." ,
"sender_id" : "gText" ,
"sender_id_value" : "BulkGate" ,
"unicode" : true
}
Vďaka country môžete zadať číslo bez medzinárodnej predvoľby. schedule prijíma ISO 8601 alebo unix timestamp; hodnota now alebo vynechanie parametra odošle správu okamžite.
POST /api/1.0/simple/transactional HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"number" : "777777777" ,
"country" : "cz" ,
"text" : "Your order 4517 arrives tomorrow." ,
"schedule" : "2026-09-14T09:00:00+02:00"
}
duplicates_check nastavený na on zahodí správu s rovnakým textom na rovnaké číslo do piatich minút; tag označí správu na neskoršie dohľadanie.
POST /api/1.0/simple/transactional HTTP/1.1
Host : portal.bulkgate.com
Content-Type : application/json
{
"application_id" : 451,
"application_token" : "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" ,
"number" : "420777777777" ,
"text" : "Your order 4517 has been shipped." ,
"duplicates_check" : "on" ,
"tag" : "orders"
}
Odpoveď je popísaná v špecifikácii .
Nižšie uvádzame príklady implementácie Simple API na odoslanie transakčných (informačných) SMS s textovým odosielateľom v rôznych programovacích jazykoch:
Význam jednotlivých parametrov nájdete v špecifikácii , holé požiadavky bez obalu v metódach požiadavky .
php.net
$context = stream_context_create (['http' => [
'method' => 'POST' ,
'header' => 'Content-Type: application/json' ,
'content' => json_encode ([
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'number' => '420777777777' ,
'text' => 'Text správy' ,
'sender_id' => 'gText' ,
'sender_id_value' => 'BulkGate' ,
], JSON_THROW_ON_ERROR ),
'timeout' => 30,
'ignore_errors' => true ,
]]);
$body = file_get_contents ('https://portal.bulkgate.com/api/1.0/simple/transactional' , false , $context );
if ($body === false )
{
throw new RuntimeException ('BulkGate API neodpovedalo.' );
}
$response = json_decode ($body , true , flags : JSON_THROW_ON_ERROR );
if (isset ($response ['error' ]))
{
throw new RuntimeException ("BulkGate: {$response['error']} ({$response['type']})" );
}
echo "Odoslané: {$response['data']['sms_id']}\n" ;
php.net/curl
$curl = curl_init ();
curl_setopt_array ($curl , [
CURLOPT_URL => 'https://portal.bulkgate.com/api/1.0/simple/transactional' ,
CURLOPT_POST => true ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => ['Content-Type: application/json' ],
CURLOPT_POSTFIELDS => json_encode ([
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'number' => '420777777777' ,
'text' => 'Text správy' ,
'sender_id' => 'gText' ,
'sender_id_value' => 'BulkGate' ,
], JSON_THROW_ON_ERROR ),
]);
$body = curl_exec ($curl );
$status = curl_getinfo ($curl , CURLINFO_RESPONSE_CODE );
if ($body === false )
{
throw new RuntimeException ('BulkGate: ' . curl_error ($curl ));
}
$response = json_decode ($body , true , flags : JSON_THROW_ON_ERROR );
if ($status !== 200)
{
throw new RuntimeException ("BulkGate: {$response['error']} ({$response['type']})" );
}
echo "Odoslané: {$response['data']['sms_id']}\n" ;
docs.guzzlephp.org
use GuzzleHttp\Client ;
use GuzzleHttp\Exception\GuzzleException ;
$client = new Client (['timeout' => 30, 'http_errors' => false]);
try
{
$result = $client ->post ('https://portal.bulkgate.com/api/1.0/simple/transactional' , ['json' => [
'application_id' => 451,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'number' => '420777777777' ,
'text' => 'Text správy' ,
'sender_id' => 'gText' ,
'sender_id_value' => 'BulkGate' ,
]]);
}
catch (GuzzleException $e )
{
throw new RuntimeException ('BulkGate: ' . $e ->getMessage (), previous : $e );
}
$response = json_decode ((string ) $result ->getBody (), true , flags : JSON_THROW_ON_ERROR );
if ($result ->getStatusCode () !== 200)
{
throw new RuntimeException ("BulkGate: {$response['error']} ({$response['type']})" );
}
echo "Odoslané: {$response['data']['sms_id']}\n" ;
go.dev
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main ( ) {
url := "https://portal.bulkgate.com/api/1.0/simple/transactional"
payload := strings. NewReader ( "{\"application_id\": 451, \"application_token\": \"NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj\", \"number\": \"420777777777\", \"text\": \"Správa\", \"sender_id\": \"gText\", \"sender_id_value\": \"BulkGate\"}" )
req, _ := http. NewRequest ( "POST" , url, payload)
req. Header. Add ( "Content-Type" , "application/json" )
res, _ := http. DefaultClient. Do ( req)
defer res. Body. Close ( )
body, _ := ioutil. ReadAll ( res. Body)
fmt. Println ( string ( body) )
}
python.org
import requests
response = requests.post('https://portal.bulkgate.com/api/1.0/simple/transactional' , json = {
'application_id' : 451 ,
'application_token' : 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'number' : '420777777777' ,
'text' : 'Správa' ,
'sender_id' : 'gText' ,
'sender_id_value' : 'BulkGate' ,
}, timeout = 30 )
data = response.json()
if 'error' in data:
raise RuntimeError(f"BulkGate: {data['error']} ({data['type']})" )
print ('Odoslané:' , data['data' ]['sms_id' ])
nodejs.org
const response = await fetch ('https://portal.bulkgate.com/api/1.0/simple/transactional' , {
method : 'POST' ,
headers : {'Content-Type' : 'application/json' },
body : JSON .stringify ({
application_id : 451,
application_token : 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
number : '420777777777' ,
text : 'Správa' ,
sender_id : 'gText' ,
sender_id_value : 'BulkGate' ,
}),
});
const data = await response.json ();
if (!response.ok ) {
throw new Error (`BulkGate : ${data.error } (${data.type })`);
}
console.log ('Odoslané:' , data.data .sms_id );
java.net.http.HttpClient
import java. net. URI ;
import java. net. http. HttpClient ;
import java. net. http. HttpRequest ;
import java. net. http. HttpResponse ;
HttpClient client = HttpClient . newHttpClient ( ) ;
HttpRequest request = HttpRequest . newBuilder ( )
. uri ( URI . create ( "https://portal.bulkgate.com/api/1.0/simple/transactional" ) )
. header ( "Content-Type" , "application/json" )
. POST ( HttpRequest . BodyPublishers . ofString ( """
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"number": "420777777777",
"text": "Správa",
"sender_id": "gText",
"sender_id_value": "BulkGate"
}""" ) )
. build ( ) ;
HttpResponse < String > response = client. send ( request, HttpResponse . BodyHandlers . ofString ( ) ) ;
System . out. println ( response. statusCode ( ) + " " + response. body ( ) ) ;
kotlinlang.org
import java. net. URI
import java. net. http. HttpClient
import java. net. http. HttpRequest
import java. net. http. HttpResponse
val payload = """
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"number": "420777777777",
"text": "Správa",
"sender_id": "gText",
"sender_id_value": "BulkGate"
}
""" . trimIndent ( )
val request = HttpRequest . newBuilder ( )
. uri ( URI . create ( "https://portal.bulkgate.com/api/1.0/simple/transactional" ) )
. header ( "Content-Type" , "application/json" )
. POST ( HttpRequest . BodyPublishers . ofString ( payload) )
. build ( )
val response = HttpClient . newHttpClient ( ) . send ( request, HttpResponse . BodyHandlers . ofString ( ) )
println ( "${response.statusCode()} ${response.body()}" )
learn.microsoft.com
using System. Net. Http ;
using System. Text ;
var payload = """
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"number": "420777777777",
"text": "Správa",
"sender_id": "gText",
"sender_id_value": "BulkGate"
}
""" ;
using var client = new HttpClient ( ) ;
var response = await client. PostAsync (
"https://portal.bulkgate.com/api/1.0/simple/transactional" ,
new StringContent ( payload, Encoding . UTF8 , "application/json" ) ) ;
Console . WriteLine ( $"{(int) response.StatusCode} {await response.Content.ReadAsStringAsync()}" ) ;
curl.se/libcurl
#include <curl/curl.h>
#include <iostream>
#include <string>
static size_t collect ( char * data, size_t size, size_t nmemb, std :: string * out)
{
out-> append ( data, size * nmemb) ;
return size * nmemb;
}
int main ( )
{
const std :: string payload = R"json(
{
"application_id": 451,
"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
"number": "420777777777",
"text": "Správa",
"sender_id": "gText",
"sender_id_value": "BulkGate"
}
)json" ;
CURL * curl = curl_easy_init ( ) ;
if ( curl == nullptr )
{
std :: cerr << "curl_easy_init failed\n" ;
return 1 ;
}
curl_slist * headers = curl_slist_append ( nullptr , "Content-Type: application/json" ) ;
std :: string body;
curl_easy_setopt ( curl, CURLOPT_URL, "https://portal.bulkgate.com/api/1.0/simple/transactional" ) ;
curl_easy_setopt ( curl, CURLOPT_HTTPHEADER, headers) ;
curl_easy_setopt ( curl, CURLOPT_POSTFIELDS, payload. c_str ( ) ) ;
curl_easy_setopt ( curl, CURLOPT_WRITEFUNCTION, collect) ;
curl_easy_setopt ( curl, CURLOPT_WRITEDATA, & body) ;
const CURLcode result = curl_easy_perform ( curl) ;
long status = 0 ;
curl_easy_getinfo ( curl, CURLINFO_RESPONSE_CODE, & status) ;
curl_slist_free_all ( headers) ;
curl_easy_cleanup ( curl) ;
if ( result != CURLE_OK)
{
std :: cerr << curl_easy_strerror ( result) << "\n" ;
return 1 ;
}
std :: cout << status << " " << body << "\n" ;
return 0 ;
}
ruby-lang.org
require 'json'
require 'net/http'
uri = URI ('https://portal.bulkgate.com/api/1.0/simple/transactional' )
response = Net ::HTTP .post(uri, {
'application_id' => 451 ,
'application_token' => 'NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj' ,
'number' => '420777777777' ,
'text' => 'Správa' ,
'sender_id' => 'gText' ,
'sender_id_value' => 'BulkGate'
}.to_json, 'Content-Type' => 'application/json' )
puts "#{response.code} #{response.body}"
curl.se
curl --request POST \
--url https://portal.bulkgate.com/api/1 .0 /simple/transactional \
--header 'Content-Type: application/json' \
--data '{"application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777", "text": "Správa", "sender_id": "gText", "sender_id_value": "BulkGate"}'
Bola táto stránka užitočná?
thumb_up Áno
thumb_down Nie
Ďakujeme za spätnú väzbu.