SMS
Consulter le solde
Récupère le solde SMS disponible sur le compte
GET
/
balance
Consulter le solde
curl --request GET \
--url https://api.example.com/balanceimport requests
url = "https://api.example.com/balance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/balance"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/balance")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"statusCode": 401,
"message": "Unauthorized",
"error": "Unauthorized"
}
{
"statusCode": 404,
"message": "User not found",
"error": "Not Found"
}
Description
Cet endpoint permet de consulter le nombre d’unités SMS disponibles sur votre compte.Exemple de requête
curl -X GET https://api-v2.dexchange-sms.com/api/v1/balance \
-H "Authorization: Bearer VOTRE_CLE_API"
const response = await fetch('https://api-v2.dexchange-sms.com/api/v1/balance', {
method: 'GET',
headers: {
'Authorization': 'Bearer VOTRE_CLE_API'
}
});
const data = await response.json();
console.log(`Solde: ${data.solde_sms} SMS`);
import requests
response = requests.get(
'https://api-v2.dexchange-sms.com/api/v1/balance',
headers={
'Authorization': 'Bearer VOTRE_CLE_API'
}
)
data = response.json()
print(f"Solde: {data['solde_sms']} SMS")
<?php
$ch = curl_init('https://api-v2.dexchange-sms.com/api/v1/balance');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer VOTRE_CLE_API'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
echo "Solde: " . $data['solde_sms'] . " SMS";
Réponse
string
L’adresse email associée au compte
integer
Le nombre d’unités SMS disponibles
Exemple de réponse réussie
{
"email": "[email protected]",
"solde_sms": 1500
}
Erreurs possibles
{
"statusCode": 401,
"message": "Unauthorized",
"error": "Unauthorized"
}
{
"statusCode": 404,
"message": "User not found",
"error": "Not Found"
}
Bonnes pratiques
Vérifiez votre solde avant les envois en masse : Avant d’envoyer une campagne SMS, assurez-vous d’avoir suffisamment de crédits en vérifiant votre solde.
Rechargement : Pour recharger votre solde, connectez-vous à votre tableau de bord et effectuez un paiement.
⌘I
Consulter le solde
curl --request GET \
--url https://api.example.com/balanceimport requests
url = "https://api.example.com/balance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/balance"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/balance")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"statusCode": 401,
"message": "Unauthorized",
"error": "Unauthorized"
}
{
"statusCode": 404,
"message": "User not found",
"error": "Not Found"
}