SMS gateway API

collection
Berichten
Saldo opvragen
OTP versturen
Mobiele nummer validatie
Nummer format
Voice
Telefoonboek (beta)
- Contacten
- Groepen
Authenticate
WordPress smsbox
Zapier smsbox

Bericht versturen

Met onze SMS API kan je jouw eigen software verbinden met onze SMS gateway.

Testomgeving nodig? Je kan als nummer 3211111111 gebruiken om onze API te testen, zonder dat er effectief een SMS verzonden wordt.

.NET developers opgelet

De APIs op deze pagina zijn enkel compatibel met het TLS 1.2 protocol. Hiervoor is minimaal .NET framework 4.6 vereist.
Heb je toch nood aan een alternatief (< TLS 1.2), contacteer support.

Parameters
Response

Base URL:

POST: https://core.smsbox.be/api/v1/sendsms

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey POST parameter X-Api-Key request header	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	numbers	32496123456,32479123456	mobiele nummers gescheiden door een komma (countrycode+nummer)
Required	message	uw bericht (urlencoded)	max. 160 tekens, zie uitzonderingen
Optional	from	alphanumeriek tot max. 11 tekens, numeriek 16 tekens	Enkel van toepassing voor NIET BE bestemmelingen. BE = geen eigen afzender mogelijk.
Optional	longsms	0/1	longsms max. 918 tekens (opgelet : 1 sms-kost = 160 tekens). Zie uitzonderingen
Optional	noti	https://www.domein.be/script.php	Doorsturen van afleverrapporten naar uw webserver via HTTP-POST met velden msgid,status. Zie de statuscodes in het tab Response
Optional	unicode	0/1 (default: 0)	"Unicode SMS" verwijst naar verzonden SMS-berichten die tekens bevatten die niet in de GSM-7-tekenset voorkomen. OPGELET max lengte per bericht wordt 70 ipv 160 tekens (=hogere sms kost).

Ik tel 160 tekens via notepad/word, maar er wordt een hogere sms kost aangerekend? Sommige tekens tellen voor meerdere tekens in een sms bericht. Dit heeft te maken met GSM encoding. De volgende tekens tellen in een GSM-7 encodering voor 2 tekens \r\n, [, \, ], ^, {, |, }, ~, €. Dit kan resulteren in een hogere sms-kost. Bekijk zeker ook onze F.A.Q & online SMS-lengtecalculator voor aanvullende info.

	Name		Name		Name
€	Euro symbol	\	Backslash	}	Right brace
[	Open bracket	^	Caret	~	Tilde
]	Close bracket	{	Left brace	\|	Vertical bar

Code	Messsage	Omschrijving
100	[{"number":32412345678","msgid":123}]	SMS verzonden, in message ontvangt u het nummer en msgid. Msgid is de referentie van het afleverrapport die naar noti wordt verstuurd.
01	Sender not ok	Afzender NOK
04	Apikey not allowed	ApiKey niet correct
05	No prefix	Geen prefix opgegeven
06	No message	Geen bericht opgegeven
07	Max char reached	longsms=0, bericht max. 160 tekens longsms=1, bericht max. 918 tekens
08	No number	Geen GSM-nummer opgegeven
09	No valid number	Geen geldig GSM-nummer
10	Not enough credits	Geen genoeg credits meer
11	Max 500 number allowed	> 500 gsm-nummers opgegeven
13	Sender too long	Afzender te lang. max. 16 tekens voor numeriek, 11 tekens voor alphanumeriek
14	Invalid channel	De channel is ongeldig. Contacteer support voor meer informatie.
15	Invalid template	De template_id is ongeldig. Contacteer support voor meer informatie.

	Status	Omschrijving
	10	Sent
	11	Delivered
	12	Buffered
	13	Undelivered
	14	Expired
	15	Rejected
	16	Unknown
	20	Blacklist
	01	Error

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$numbers = ""; // 32496123456, multiple numbers are divided by a comma
$message = "This is a test message from smsbox";

// SendSMS
print_r(sendsms($apikey, $numbers, $message));

function sendsms($apikey, $numbers, $message) {

    $data = array();
    $data["numbers"] = $numbers;
    $data["message"] = $message;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/sendsms", json_encode($data));
    return $response;

}

function sendToHost($apikey, $url, $data) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;

    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":100,
"message":[{
"number":"32498765432",
"msgid":15547355
}]
}

Example .NET: (required .NET Framework > 4.5)


//on top of your .cs file
using System.Net.Http;
using Newtonsoft.Json.Linq;

//call this code inside your function
var response = await sendSMS("324xxxxxxxx","This is a test message from smsbox");

//parse JSON response
JObject json = JObject.Parse(response);
int code = (int)json.GetValue("code");
if (code == 100)
{
    // OK, message has been send
    // if necessary you can parse the message field to retrieve the number and msgid (= message ID)
    // this message ID will also be send to the "noti" variable, see documentation for more info
    JArray message = (JArray)json.GetValue("message");
    // Loop through the array
    // [{"number":324xxxxxxxx","msgid":123}]
}
else
{
    // Send message has failed, check documentation to get the description of the code.
}

private async Task<string> sendSMS(string number, string message)
{
    var token = "ENTER_YOUR_APIKEY";

    HttpClient client = new HttpClient();
    client.DefaultRequestHeaders.Add("X-Api-Key", token);

    var values = new Dictionary<string, string>
    {
        { "numbers", number },
        { "message", message },
    };

    var content = new FormUrlEncodedContent(values);
    var response = await client.PostAsync("https://core.smsbox.be/api/v1/sendsms", content);
    var responseString = await response.Content.ReadAsStringAsync();
    return responseString;
}

Example VBA: (Microsoft Office)

Download Excel voorbeeld

Download Access voorbeeld

Example powershell


$apikey="YOUR_APIKEY_HERE" # SMS Box Apikey
$mobile = "32498765432" # Mobile number international format
$message = "Your message"

$headers = @{
 "Accept"="application/json"
 "X-Api-Key"=$apikey
}

$postParams = @{numbers=$mobile;message=$message;longsms=1}

# [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 #optional for older servers to set TLS 1.2
$result = Invoke-WebRequest -Uri https://core.smsbox.be/api/v1/sendsms -Method POST -Body $postParams -Headers $headers
Write-Output $result.Content

# $json = $result | ConvertFrom-Json
# Write-Output $json.code
# Write-Output $json.message

Exit-PSSession

Example Python


import requests # pip install requests or pip3 install requests
from pprint import pprint
import json

apikey = 'YOUR_API_KEY'
numbers = '32498765432' #multiple numbers comma separated
message = 'System test'
longsms = 1

headers = {"Content-Type": "application/json",'X-Api-Key': apikey}
params = {'numbers': numbers,'message': message,'longsms': 1}
url = 'https://core.smsbox.be/api/v1/sendsms'

response = requests.post(url, data=json.dumps(params), headers=headers)
pprint(response.json())

SMS/WhatsApp bericht versturen

Met onze SMS API kan je jouw eigen software verbinden met onze SMS gateway.

Testomgeving nodig? Je kan de parameter test gebruiken om onze API te testen,
zonder dat er effectief een SMS verzonden wordt.

Parameters
Response

Base URL:

POST: https://core.smsbox.be/api/v2/message/send

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	mobile	32496123456,32479123456	mobiele nummers gescheiden door een komma (countrycode+nummer)
Required	message	uw bericht (urlencoded)	max. 160 tekens, zie uitzonderingen
Optional	date	Datum/tijd waarop uw bericht verzonden moeten worden	Formaat: jjjj-MM-dd UU:mm. Indien niet opgegeven, wordt het bericht zo snel mogelijk verzonden
Optional	channel	Zie controle paneel voor meer informatie
Optional WHATSAPP ONLY	template_id	TEMPLATENAAM	Naam van de template
Optional WHATSAPP ONLY	template_lang	NL/EN/FR	Taalcode waarmee de template moet verstuurd worden
Optional WHATSAPP ONLY	template_vars	[123,456]	Array met variables waarmee de template moet ingevuld worden.
Optional WHATSAPP ONLY	media_url	https://www.mydownloadhost.com/myImageName.jpg (jpg/png/pdf)	Url van de door te sturen media.
Optional	noti	https://www.domein.be/script.php	Doorsturen van afleverrapporten naar uw webserver via HTTP-POST met velden msgid,status. Zie de statuscodes in het tab Response
Optional WHATSAPP ONLY	fallback	true/false, default: true	Fallback to SMS message.
Optional	test	true/false	Test environment

	Name		Name		Name
€	Euro symbol	\	Backslash	}	Right brace
[	Open bracket	^	Caret	~	Tilde
]	Close bracket	{	Left brace	\|	Vertical bar

Tip: bekijk foutieve API responses in je account

Code	Messsage	Omschrijving
100	[{"mobile":32412345678","msgid":123}]	SMS verzonden, in message ontvangt u het nummer en msgid. Msgid is de referentie van het afleverrapport die naar noti wordt verstuurd.
01	Sender not ok	Afzender NOK
04	Apikey not allowed	ApiKey niet correct
05	No prefix	Geen prefix opgegeven
06	No message	Geen bericht opgegeven
07	Max char reached	longsms=0, bericht max. 160 tekens longsms=1, bericht max. 918 tekens
08	No number	Geen GSM-nummer opgegeven
09	No valid number	Geen geldig GSM-nummer
10	Not enough credits	Geen genoeg credits meer
11	Max 500 number allowed	> 500 gsm-nummers opgegeven
13	Sender too long	Afzender te lang. max. 16 tekens voor numeriek, 11 tekens voor alphanumeriek
14	Invalid channel	De channel is ongeldig. Contacteer support voor meer informatie.
15	Invalid template	De template_id is ongeldig. Contacteer support voor meer informatie.
16	Invalid media type	De media url is geen geldige type.

	Status	Omschrijving
	10	Sent
	11	Delivered
	12	Buffered
	13	Undelivered
	14	Expired
	15	Rejected
	16	Unknown
	20	Blacklist
	01	Error

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$mobile = ""; // 32496123456, multiple numbers are divided by a comma
$message = "This is a test message from smsbox";

// SendSMS
print_r(sendsms($apikey, $mobile, $message));

function sendsms($apikey, $mobile, $message) {

    $data = array();
    $data["mobile"] = $mobile;
    $data["message"] = $message;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v2/message/send", json_encode($data));
    return $response;

}

function sendToHost($apikey, $url, $data) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;

    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":100,
"timestamp": "2022-06-10 12:35:10",
"message":
[{
"mobile":"32498765432",
"msgid":15547355,
"type":"WHATSAPP"
}],
}

Example .NET: (required .NET Framework > 4.5)

Example VBA: (Microsoft Office)

Download Excel voorbeeld

Download Access voorbeeld

Example powershell

Example Python

Inkomende berichten ophalen

Met onze SMS API kan je jouw eigen software verbinden met onze SMS gateway.

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v2/message/inbox

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Optional	channel	CHANNEL_NAME	Filter op een channel/keyword

Tip: bekijk foutieve API responses in je account

	Code	Messsage	Omschrijving
	10	Messages found
	20	Apikey not provided
	21	Apikey not allowed

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$channel = "MY_CHANNEL"; //Optional

// SendSMS
print_r(getMessages($apikey, $channel));

function getMessages($apikey, $channel) {

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v2/message/inbox?channel=$channel");
    return $response;

}

function sendToHost($apikey, $url) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;

    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":10,
"data":
[{
"sender":"32498765432",
"msgid":15547355,
"channel":"MY_CHANNEL",
"message":"Test message",
"readen":true,
"datetime":"2022-08-02 15:20:21",
"name":"Jos Vereecke"
}],
}

Example .NET: (required .NET Framework > 4.5)

Example VBA: (Microsoft Office)

Download Excel voorbeeld

Download Access voorbeeld

Example powershell

Example Python

Uitgaande berichten ophalen

Met onze SMS API kan je jouw eigen software verbinden met onze SMS gateway.

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v2/message/outbox

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Optional	channel	CHANNEL_NAME	Filter op een channel/keyword

Tip: bekijk foutieve API responses in je account

	Code	Messsage	Omschrijving
	10	Messages found
	20	Apikey not provided
	21	Apikey not allowed

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$channel = "MY_CHANNEL"; //Optional

// SendSMS
print_r(getMessages($apikey, $channel));

function getMessages($apikey, $channel) {

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v2/message/outbox?channel=$channel");
    return $response;

}

function sendToHost($apikey, $url) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;

    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":10,
"data":
[{
"recipient":"32498765432",
"msgid":15547355,
"channel":"MY_CHANNEL",
"message":"Test message",
"datetime":"2022-08-02 15:20:21",
"name":"Jos Vereecke"
}],
}

Example .NET: (required .NET Framework > 4.5)

Example VBA: (Microsoft Office)

Download Excel voorbeeld

Download Access voorbeeld

Example powershell

Example Python

Saldo opvragen

Met deze API kan je het resterend aantal credits opvragen.

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v1/balance

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey POST parameter X-Api-Key request header	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.

	Code	Messsage
	04	Apikey not allowed
	100	Success, credits are shown in the message tag

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token

// Get balance
print_r(getBalance($apikey));

function getBalance($apikey) {

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/balance");

    return $response;

}

function sendToHost($apikey, $url) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;
    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":100,
"message":"1630.38"
}

One Time Passwords (OTP) versturen

Twee-Factor Authenticatie API om je gegevens, accounts en gebruikerstransacties te beveiligen.

Een handige test tool is beschikbaar in uw SMSBOX account onder OTP Service

Parameters
Response

Kostprijs: e-mail: 0.50 credits, SMS: volgens netwerk

INFO:
Er worden enkel credits aangerekend voor één verzonden sms/email (send api), verify api is gratis.

Base URL:

POST: https://core.smsbox.be/api/v1/otp/send

GET: https://core.smsbox.be/api/v1/otp/verify

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required (send API)	number en/of e-mail	32496123456 name@domain.domain	1 mobiele nummer 1 e-mailadres
Required (verify API)	otp	123456	OTP code
Optional (send API)	text	{OTP}	gebruik je eigen tekst ipv de standaard tekst. Gebruik {OTP} om de plaats van de code aan te geven in de tekst. Voorbeeld: Beste klant, uw code is {OTP}. Vul deze in op de website. {OTP} wordt vervangen door een OTP code. Indien je geen {OTP} tag meegeeft in de tekst wordt de standaard tekst verzonden.

Code	Messsage	Number
10	Code has been sent	The recipient number
11	Number is verified	The recipient number
20	Apikey not provided
21	Apikey not allowed
40	Number verification failed
41	Number not provided
42	Only one number allowed
50	OTP not provided
51	OTP not correct
60	Credits to low
90	Custom error
98	Try again later
99	Unknown status, contact support

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$number = ""; // 32496123456

// Send OTP
print_r(sendOTP($apikey, $number));

// Verify OTP
print_r(verifyOTP($apikey, '858083'));

function sendOTP($apikey, $number) {

    $data = array();
    $data["number"] = $number;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/otp/send", json_encode($data), "POST");
    return $response;

}

function verifyOTP($apikey, $otp) {

    $data = array();
    $data["otp"] = $otp;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/otp/verify", json_encode($data), "GET");
    return $response;

}

function sendToHost($apikey, $url, $data, $type) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;
    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $type);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

ACTION send:
HTTP/1.1 200 OK
Content-Type: application/json

{
"code" : 10,
"message" : "Code has been sent",
"number" : "32496123456" //your reference, always use this value instead of the provided POST number
}

ACTION verify:
//example correct OTP code
HTTP/1.1 200 OK
Content-Type: application/json

{
"code" : 11,
"message" : "Number is verified",
"number" : "32496123456" //your reference
}

//example bad OTP code
HTTP/1.1 400 Bad Request
Content-Type: application/json

{
"code" : 51,
"message" : "OTP not correct"
}

Mobiele nummer validatie

Met onze Mobiele nummer validatie API kan je het "Home Location Register" (HLR) opvragen van een mobiel nummer en weet je direct of een nummer 100% geldig en aangesloten/actief is op het netwerk van de GSM operator. Prijs per aanvraag is 0.25 credits.
Door regelmatig te valideren, blijft jouw telefoonlijst altijd up2date en verstuur je nooit een SMS naar een ongeldig nummer (=kostenbesparend)

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v1/hlr

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	number	32496123456	mobiele nummer (countrycode+nummer)

	Code	Messsage
	10	Success, lookup array is shown in message tag
	20	Apikey not provided
	21	Apikey not allowed
	30	Number not provided
	40	Lookup failed
	60	Credits low

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$number = ""; // The mobile number that you want to lookup

// Get hlr
print_r(getHlr($apikey, $number));

function getHlr($apikey, $number) {

    $data = array();
    $data["number"] = $number;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/hlr" . json_encode($data));
    return $response;

}

function sendToHost($apikey, $url) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;
    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":10,
"message":
{
"issueing_info":
{
"verified":true,
"timezone":"Europe/Brussels",
"location":"Belgium",
"network_name":"Orange",
"country_code":32,
"area":"Belgium"
},
"home_info":
{
"verified":true,
"timezone":"Europe/Brussels",
"location":"Belgium",
"network_name":"Proximus",
"country_code":32,
"area":"Belgium"
},
"type":"Mobile",
"msisdn":"32498765432",
"error_code":0,
"error_text":"Live",
"status":"Delivered",
"mccmnc":"20601",
"is_ported":true,
"is_roaming":false
},
"number":"32498765432"
}

Nummer format

Met onze nummer format API kan je een nummer omzetten naar het internationaal formaat.

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v1/number/format

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	number	0498765432	Your unformatted number
Required	countryCode	BE	The country code

	Code	Messsage
	10	Success
	20	Apikey not provided
	21	Apikey not allowed
	30	Number not provided
	31	Country code not provided

Example PHP:

Response:

Voice bericht versturen

Met onze VOICE API kan je jouw eigen software verbinden met onze VOICE gateway.

Parameters
Response

Kostprijs: 1.40 credits

Base URL:

POST: https://core.smsbox.be/api/v1/voice/send

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey POST parameter X-Api-Key request header	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	number	32496123456	mobiele nummer (countrycode+nummer)
Required	message	uw bericht (urlencoded)
Optional	lang	NL/FR/EN	De taal van het bericht. Standaard: NL
Optional	gender	M/F	Vrouw of mannelijke stem. Standaard: M
Optional	send_at	2022-12-09T03:58:15Z	Verstuur in de toekomst. Bij een ongeldige datum/tijd wordt standaard de huidige datum/tijd genomen. Standaard: huidige datum/tijd

	Code	Messsage
	10	Success, voicecall is sent
	20	Apikey not provided
	21	Apikey not allowed
	30	Number not provided
	31	Number invalid
	40	Message not provided
	50	Send voice failed
	60	Credits low

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token
$number = ""; // 32496123456
$message = "This is a test message from smsbox";

// SendVoice
print_r(sendVoice($apikey, $number, $message));

function sendVoice($apikey, $number, $message) {

    $data = array();
    $data["number"] = $number;
    $data["message"] = $message;

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/voice", json_encode($data));
    return $response;

}

function sendToHost($apikey, $url, $data) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;
    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":10,
"message":"Voice is sent",
"number":"32498765432"
}

Telefoonboek CONTACTEN

Met onze PHONEBOOK API kan je jouw eigen telefoonboek samenstellen en onderhouden.

All contacts
Get contact
Add contact
Edit contact
Delete contact

METHOD+Base URL:

GET: https://core.smsbox.be/api/v1/phonebook/contact

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.

METHOD+Base URL:

GET: https://core.smsbox.be/api/v1/phonebook/contact/:contact_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	contact_id	12345	contact id

METHOD+Base URL:

POST: https://core.smsbox.be/api/v1/phonebook/contact

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	mobile	32496123456	mobiele nummer (countrycode+nummer)
Required	name	naam van je contact (urlencoded)

METHOD+Base URL:

PUT: https://core.smsbox.be/api/v1/phonebook/contact/:contact_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	contact_id	12345	contact id
Optional	mobile	32496123456	mobiele nummer (countrycode+nummer)
Optional	name	naam van je contact (urlencoded)

METHOD+Base URL:

DELETE: https://core.smsbox.be/api/v1/phonebook/contact/:contact_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	contact_id	12345	contact id

Telefoonboek GROEPEN

Met onze PHONEBOOK API kan je jouw eigen telefoonboek samenstellen en onderhouden.

All groups
Get group
Add group
Edit group
Delete group

METHOD+Base URL:

GET: https://core.smsbox.be/api/v1/phonebook/groups

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.

METHOD+Base URL:

GET: https://core.smsbox.be/api/v1/phonebook/groups/:group_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	group_id	12345	group id

METHOD+Base URL:

POST: https://core.smsbox.be/api/v1/phonebook/groups

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	name	naam van je groep (urlencoded)
Optional	desc	omschrijving van je groep (urlencoded)

METHOD+Base URL:

PUT: https://core.smsbox.be/api/v1/phonebook/groups/:group_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	group_id	12345	group id
Optional	name	naam van je groep (urlencoded)
Optional	desc	omschrijving van je groep (urlencoded)

METHOD+Base URL:

DELETE: https://core.smsbox.be/api/v1/phonebook/groups/:group_id

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.
Required	group_id	12345	group id

Authenticate

Met deze API kan je jouw apikey testen.

Parameters
Response

Base URL:

GET: https://core.smsbox.be/api/v1/auth

Parameters:

	Parameter	Input	Omschrijving
Required (2 mogelijkheden)	apikey POST parameter X-Api-Key request header	apikey (urlencoded) X-Api-Key: apikey	SMSBOX apikey, deze apikey kan je aanmaken door in te loggen in je SMSBOX account.

	Code	Messsage
	10	Success, your apikey is valid
	20	Apikey not provided
	21	Apikey not allowed

Example PHP:


<?php

header("content-type: text/plain");

$apikey = ""; // Your smsbox api token

// Test authenticate
print_r(authenticate($apikey));

function authenticate($apikey) {

    $response = sendToHost($apikey, "https://core.smsbox.be/api/v1/auth");

    return $response;

}

function sendToHost($apikey, $url) {

    $headers = array();
    $headers[] = "X-Api-Key: " . $apikey;
    $headers[] = "Content-Type: application/json";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");

    curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
    curl_setopt($ch, CURLOPT_VERBOSE, 0);
    curl_setopt($ch, CURLOPT_HEADER, 1); // Set to 0 to remove the headers from response

    $response = curl_exec($ch);

    return $response;

}

?>

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"code":10,
"message":
{
"user": "your_username",
"credits": 123.45,
"email": "your_email@domain.tld",
"service": "SMS"
}
}

WordPress SMSBOX plugin

WordPress SMS
Verstuur SMS berichten via jouw WordPress website.

WP-SMS plugin: https://wp-sms-pro.com/gateway/smsbox/

Installeer de WP-SMS plugin via jouw WordPress controle paneel.

Parameters (instelbaar via de plugin instellingen):

	Parameter	Omschrijving
Required	gateway name	selecteer Smsbox.be
Required	apikey	maak je apikey aan via jouw smsbox account
Optional	sender number	Enkel van toepassing voor NIET BE bestemmelingen. BE = geen eigen afzender mogelijk.

Verstuur SMS berichten via Zapier

Zapier Smsbox.be
Verstuur SMS berichten via het Zapier platform.
Met Zapier creëer je een workflow. Een workflow (zap) bestaat uit een trigger en een action.
Maak verbinding met de smsbox.be app door middel van een apikey en verstuur zo een bericht via het smsbox platform.
Contacteer onze sales voor meer informatie.

INVITE URL: https://zapier.com/developer/public-invite/143467/e8e5f12177248b97566f891d50184047/

Parameters:

	Parameter	Omschrijving
Required	apikey	maak je apikey aan via jouw smsbox account
Required	number	nummer in internationaal formaat
Required	message	uw bericht

Voorbeeldcodes

PHP
C#
VBA
PowerShell
Python

SMS gateway API

Bericht versturen

Uitzonderingen

Response Status codes (JSON string)

Status codes afleverrapporten - deze codes worden verzonden naar de noti url

SMS/WhatsApp bericht versturen

Uitzonderingen

Response Status codes (JSON string)

Status codes afleverrapporten - deze codes worden verzonden naar de noti url

Inkomende berichten ophalen

Response Status codes (JSON string)

Uitgaande berichten ophalen

Response Status codes (JSON string)

Saldo opvragen

Response Status codes (JSON string)

One Time Passwords (OTP) versturen

Response Status codes (JSON string)

Mobiele nummer validatie

Response Status codes (JSON string)

Nummer format

Response Status codes (JSON string)

Voice bericht versturen

Response Status codes (JSON string)

Telefoonboek CONTACTEN

Telefoonboek GROEPEN

Authenticate

Response Status codes (JSON string)

WordPress SMSBOX plugin

WP-SMS plugin: https://wp-sms-pro.com/gateway/smsbox/

Verstuur SMS berichten via Zapier

INVITE URL: https://zapier.com/developer/public-invite/143467/e8e5f12177248b97566f891d50184047/

Voorbeeldcodes

Maak een gratis account aan