Introduction

API Endpoint
https://afriksms.com/api/web/web_v1/outbounds

Avec les API Afriksms et quelques lignes de code, vous pouvez facilement envoyer des SMS, recevoir des accusés de réception en temps réel, consulter votre solde , recevoir des SMS sur votre backend et gérer votre compte en tant qu'administrateur.

Pour utiliser cette API, vous avez besoin d'un Identifiant Api et aussi d'une Clé d'authentification Api .

Si vous n'avez pas encore de compte, veuillez nous contacter à l'adresse support@afriksms.com

ClientId : Identifiant Api
ApiKey : Clé d'authentification Api

Vous recevrez les informations dans votre boite mail une fois le compte créé.
OU
Ouvrez votre tableau de bord . Rendez-vous sur l'onglet Paramètres/Paramètres technique. Copiez les valeurs dans chaque variable.

Supposons que vous avez fait votre demande de création de compte et acheté votre forfait, nous pouvons commencer maintenant.

Envoi de SMS (Get & Post)

			

# Voici un exemple Php-cURL
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne%20soir%C3%A9e.%20Un%20autre%20Test%20des%20apis&MobileNumbers=22890909090', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response;
			

# Voici un exemple cURL
curl --location -g --request GET 'https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne%20soir%C3%A9e.%20Un%20autre%20Test%20des%20apis&MobileNumbers=22890909090'
			

# Voici un exemple JavaScript - jQuery
var settings = { "url": "https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne soirée. Un autre Test des apis&MobileNumbers=22890909090", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); });
			

# Voici un exemple Java - OkHttp
OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne soirée. Un autre Test des apis&MobileNumbers=22890909090") .method("GET", null) .build(); Response response = client.newCall(request).execute();
			

# Voici un exemple C#
var client = new RestClient("https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne soirée. Un autre Test des apis&MobileNumbers=22890909090"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);
			

# Voici un exemple Dart
var request = http.Request('GET', Uri.parse('https://afriksms.com/api/web/web_v1/outbounds/send?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Bonne soirée. Un autre Test des apis&MobileNumbers=22890909090')); http.StreamedResponse response = await request.send(); if (response.statusCode == 200) { print(await response.stream.bytesToString()); } else { print(response.reasonPhrase); }

Api d'envoi de sms. Api mis en place en GET mais peut être également exécuter en Post pour des contenus de sms. Elle prend en paramètre 5 champs qui sont tous obligatoires y compris votre Identifiant Api et votre Clé d'authentification API précédemment recu par mail ou obtenu dans votre interface d'administration afin d'envoyer correctement la requête.

Endpoint: https://afriksms.com/api/web/web_v1/outbounds/send




# Exemple de Response :
{ "code": 100, "message": "Success operation", "resourceId": "P7COiDNjFvZ_gkYo7lGKVIDMemINjrgx" }

Les paramètres de la requête

Champs Type Description
ClientId Texte {{ClientId}}
Identifiant Api (A recevoir après création de votre compte)
ApiKey Texte {{ApiKey}}
Clé d'authentification Api (A recevoir après création de votre compte)
SenderId Texte AFRIKSMS
Le nom expediteur doit contenir 11 caractères maximum
Message Texte Bonne soirée. Un autre Test des apis
Contenu de votre message
MobileNumbers Texte 22890909090
Numéro destinataire avec votre code pays mais sans préfixe + ou 00

Envoi de SMS & Email (Get & Post)

			

# Voici un exemple Php-cURL
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre%20code%20de%20validation%20est%200611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code%20de%20V%C3%A9rification', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response;
			

# Voici un exemple cURL
curl --location -g --request GET 'https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre%20code%20de%20validation%20est%200611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code%20de%20V%C3%A9rification'
			

# Voici un exemple JavaScript - jQuery
var settings = { "url": "https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre code de validation est 0611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code de Vérification", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); });
			

# Voici un exemple Java - OkHttp
OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre code de validation est 0611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code de Vérification") .method("GET", null) .build(); Response response = client.newCall(request).execute();
			

# Voici un exemple C#
var client = new RestClient("https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre code de validation est 0611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code de Vérification"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);
			

# Voici un exemple Dart
var request = http.Request('GET', Uri.parse('https://afriksms.com/api/web/web_v1/outbounds/send_emailsms?ClientId={{ClientId}}&ApiKey={{ApiKey}}&SenderId=AFRIKSMS&Message=Votre code de validation est 0611&MobileNumbers=22890909090&Email=contact@afriksms.com&Subject=Code de Vérification')); http.StreamedResponse response = await request.send(); if (response.statusCode == 200) { print(await response.stream.bytesToString()); } else { print(response.reasonPhrase); }

Api d'envoi de Sms et Email. Api mis en place en GET mais peut être également exécuter en Post pour des contenus de sms. Elle prend en paramètre 7 champs dont 5 sont obligatoires y compris votre Identifiant Api et votre Clé d'authentification API précédemment recu par mail ou obtenu dans votre interface d'administration afin d'envoyer correctement la requête.

Avec cet api vous avez la possibilité de coupler vos sms avec l'email de la personne pour qu'un Email lui soit delivrer lors de l'envoi

Pre-requis: Rassurez vous que l'option d'envoie d'Email a été activé sur votre compte.

Endpoint: https://afriksms.com/api/web/web_v1/outbounds/send_emailsms




# Exemple de Response :
{ "code": 100, "message": "Success operation", "resourceId": "y1k9s-7FId27SKC3qwJ4Q6fkANQ_CuZc" }

Les paramètres de la requête

Champs Type Description
ClientId Texte {{ClientId}}
Identifiant Api (A recevoir après création de votre compte)
ApiKey Texte {{ApiKey}}
Clé d'authentification Api (A recevoir après création de votre compte)
SenderId Texte AFRIKSMS
Le nom expediteur doit contenir 11 caractères maximum
Message Texte Votre code de validation est 0611
Contenu de votre message
MobileNumbers Texte 22890909090
Numéro destinataire avec votre code pays mais sans préfixe + ou 00
Email Texte contact@afriksms.com
(Optional)Email de la personne à qui est destiné le message. Ce champ n'est pas obligatoire au cas ou vous ne desirez pas envoyer un mail au destinataire
Subject Texte Code de Vérification
(Optional)L'objet du mail à envoyer. Ce champ n'est pas obligatoire dans la mesure ou vous ne desirez pas envoyer de mail. Mais il devient important dès que le champ Email est renseigné

Configuration callback Url (Get & Post)

			

# Voici un exemple Php-cURL
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response;;
			

# Voici un exemple cURL
curl --location -g --request GET 'https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2'
			

# Voici un exemple JavaScript - jQuery
var settings = { "url": "https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); });
			

# Voici un exemple Java - OkHttp
OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2") .method("GET", null) .build(); Response response = client.newCall(request).execute();
			

# Voici un exemple C#
var client = new RestClient("https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);
			

# Voici un exemple Dart
var request = http.Request('GET', Uri.parse('https://afriksms.com/api/web/web_v1/outbounds/callback_url?ClientId={{ClientId}}&ApiKey={{ApiKey}}¬ifyURL=https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5&TypeNotification=2')); http.StreamedResponse response = await request.send(); if (response.statusCode == 200) { print(await response.stream.bytesToString()); } else { print(response.reasonPhrase); }

Veuillez utiliser cette API une fois que votre serveur principal est prêt à recevoir des demandes de DR SMS du serveur Afriksms. Avant d'envoyer de vrais SMS, pour tester votre point de terminaison SMS DR, nous vous conseillons vivement de faire des tests unitaires en lui envoyant directement des requêtes POST et de voir comment il réagit. Une fois que vous pensez que vous allez bien, vous pouvez commencer à envoyer de vrais SMS et vérifier la bonne dérivabilité de ceux-ci. Assurez-vous que votre numéro de test est sur le réseau, cela vous aidera à accélérer votre phase de test.

Ainsi, pour déclarer votre URL back-end, disons https://{{dev_host}}/sms/smsdr.php, vous devez toujours utiliser votre Identifiant Api et votre Clé d'authentification API précédemment reçus par mail ou obtenus dans votre interface d'administration afin d'envoyer correctement la requête.

Notez que vous ne pouvez déclarer qu'un seul point de terminaison; cette URL sera utilisée pour toutes vos applications, quel que soit le pays dans lequel vous envoyez votre SMS MT.
Pour modifier votre URL back-end, Vous avez juste a exécuter la même Api avec l'URL correspondante.

Endpoint: https://afriksms.com/api/web/web_v1/outbounds/callback_url




# Exemple de Response :
{ "code": 100, "message": "Success operation", "notifyURL": "https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5", "typeNotification": "GET" }



# Les paramètres envoyés à votre Url pour la livraison des accusés de réception
{ "resourceId": "y1k9s-7FId27SKC3qwJ4Q6fkANQ_CuZc", "code": "000", "message": "Successful delivered to Terminal", } Code : 000 => Success Code : 001 => Envoyé à l'opérateur mais pas d'accusé Code : 002 => Numéro injoingnable, Erreur de réception

Les paramètres de la requête

Champs Type Description
ClientId Texte {{ClientId}}
Identifiant Api (A recevoir après création de votre compte)
ApiKey Texte {{ApiKey}}
Clé d'authentification Api (A recevoir après création de votre compte)
notifyURL Url https://adkontact.com/sms/smsdr.php?key=ghdgdeddgd5
votre URL back-end: une fonction api sur votre serveur qui sera executé pour vous faire parvenir les accusés de reception
typeNotification Entier 2
1: POST 2: GET
La methode d'appel de votre url de notification

Consultation du solde (Get & Post)

			

# Voici un exemple Php-cURL
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response;
			

# Voici un exemple cURL
curl --location -g --request GET 'https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}'
			

# Voici un exemple JavaScript - jQuery
var settings = { "url": "https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); });
			

# Voici un exemple Java - OkHttp
OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}") .method("GET", null) .build(); Response response = client.newCall(request).execute();
			

# Voici un exemple C#
var client = new RestClient("https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);
			

# Voici un exemple Dart
var request = http.Request('GET', Uri.parse('https://afriksms.com/api/web/web_v1/outbounds/solde?ClientId={{ClientId}}&ApiKey={{ApiKey}}')); http.StreamedResponse response = await request.send(); if (response.statusCode == 200) { print(await response.stream.bytesToString()); } else { print(response.reasonPhrase); }

Depuis votre application, ou au sein de votre propre zone d'administration, vous pouvez avoir besoin de vérifier et d'afficher le nombre de SMS que vous pouvez encore envoyer à vos clients. Pour cette utilisation, vous devez toujours utiliser votre Identifiant Api et votre Clé d'authentification API précédemment reçus par mail ou obtenus dans votre interface d'administration et accéder à ce end point.

Endpoint: https://afriksms.com/api/web/web_v1/outbounds/solde




# Exemple de Response :
{ "code": 100, "message": "Success operation", "information": [ { "country": "Burkina-Faso", "solde": 0 }, { "country": "Mali", "solde": -2 } ] }

Les paramètres de la requête

Champs Type Description
ClientId Texte {{ClientId}}
Identifiant Api (A recevoir après création de votre compte)
ApiKey Texte {{ApiKey}}
Clé d'authentification Api (A recevoir après création de votre compte)