F.
(+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
Documentation API
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
Intégrez l’envoi de vos SMS en quelques clics
grâce
à l’API XSEL
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
Table des Matières
INFORMATIONS GENERALES ........................................................................................................................... 5
1. LA METHODE XML HTTP POST ..................................................................................................................... 5
1.1 Envoi de SMS ............................................................................................................................................... 5
1.1.1 Chaine de données :............................................................................................................................. 6
1.1.2 Liste des paramètres d’envoi:.............................................................................................................. 6
1.2 Réponse ....................................................................................................................................................... 7
1.2.1 Chaine de données : .............................................................................................................................. 7
1.2.2 Liste des paramètres retour : .................................................................................................................. 8
1.3 Exemple d’envoi au format XML en utilisant PHP ............................................................................... 9
1.3.1 Envoi .......................................................................................................................................................... 9
1.3.2 Réponse..................................................................................................................................................10
2. LA METHODE JSON HTTP POST .................................................................................................................11
2.1 Envoi de SMS .............................................................................................................................................11
2.1.1 Chaine de données : ............................................................................................................................11
2.1.2 Liste des paramètres d’envoi :...........................................................................................................12
2.2 Réponse .....................................................................................................................................................13
2.2.1 Chaine de données : ............................................................................................................................13
2.2.2 Liste des paramètres retour: .................................................................................................................14
2.3 Exemple d’envoi au format JSON en utilisant PHP ...........................................................................15
2.3.1 Envoi ........................................................................................................................................................15
2.3.3 Réponse..................................................................................................................................................16
3. LA METHODE HTTP GET ..............................................................................................................................17
3.1 Envoi de SMS .............................................................................................................................................17
3.2 Réponse .....................................................................................................................................................18
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
3.2.1 Chaine de données : ............................................................................................................................18
3.2.2 Liste des paramètres retour: .................................................................................................................19
3.3 Exemple d’envoi au format HTTP en utilisant PHP.............................................................................20
3.3.1 Envoi ........................................................................................................................................................20
3.3.2 Réponse..................................................................................................................................................21
4. INTERROGER SON COMPTE ......................................................................................................................22
4.1 Envoi de la requête .................................................................................................................................22
4.2 Réponse .....................................................................................................................................................22
4.2.1 Chaine de données : ............................................................................................................................22
4.2.2 Liste des paramètres retour: .................................................................................................................22
5. GESTION DES ERREURS ...............................................................................................................................23
NOUS CONTACTER .........................................................................................................................................24
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
INFORMATIONS GENERALES
L’utilisateur est prié de contacter XSEL pour obtenir les paramètres de son compte API.
Chaque compte API donne droit à trois (3) sender ids.
Toutes les requêtes de notre API doivent être appelées sur l’URL [Link]
Dans cette documentation nous avons choisi d’utiliser les chaines de données pour
l’identification et pour passer les paramètres.
Méthodes d’envoi et format des données : Vous pouvez utiliser les méthodes JSON HTTP POST,
XML HTTP POST ou HTTP GET pour envoyer les SMS et recevoir les accusés de réception.
LA METHODE XML HTTP POST
Toutes les données doivent être transmises à l’URL [Link]
1.1 Envoi de SMS
La chaine de données XML doit commencer avec le mot-clé : « XML»
Pour chaque fonction de l'API vous devez communiquer vos identifiants API XSEL.
Il existe deux manières de s'authentifier, via les headers HTTP ou dans la chaîne de
données transmise. Notre plateforme supporte les deux méthodes. Mais nous
recommandons la méthode de transmission via la chaine de données. Dans le reste
de la documentation nous utiliserons cette méthode.
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
1.1.1 Chaine de données :
<smsRequest>
<authentification>
<apiKey>cleApi</apiKey>
</authentification>
<message>
<text>Texte à envoyer</text>
<from>xselsms</from>
</message>
<recipients>
<to>+22507123456</to>
<to>+22508123456</to>
</recipients>
</smsRequest>
1.1.2 Liste des paramètres d’envoi:
L’api Key du client (Il vous aura été
APIKEY communiqué par XSEL après la création de
votre compte)
Le contenu du SMS à envoyer (maximum 160
TEXT
caractères par SMS)
Maximum 11 caractères alphanumériques
FROM (caractères spéciaux non autorisées)
RECIPIENTS Liste des destinataires au format international
(ex : +22504050607)
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
1.2 Réponse
1.2.1 Chaine de données :
<smsResponse>
<messages>
<message>
<to>+22507123456</to>
<status>
<name>DELIVERED_TO_OPERATOR</name>
<value>401</value>
</status>
<smsCount>1</smsCount>
<messageId>Y1509712267-59fc618bf3c41</messageId>
<smsCost>28</smsCost>
</message>
<message>
<to>+22508123456</to>
<status>
<name>DELIVERED_TO_OPERATOR</name>
<value>401</value>
</status>
<smsCount>1</smsCount>
<messageId>H1509712268-59fc618c48405</messageId>
<smsCost>28</smsCost>
</message>
</messages>
</smsResponse>
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
1.2.2 Liste des paramètres retour :
Pour chaque sms récipients présent dans le flux envoyé un rapport est fourni, il
contient les paramètres ci-dessous :
To Numéro du destinataire
Statut Valeur entière indiquant l'état de la demande (VOIR annexes
pour la liste complète)
smsCount Nombre de SMS facturé pour cet envoi (bloc de 160
messageId Id du message pour les accusés de réception
smsCost Le montant total débité.
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
1.3 Exemple d’envoi au format XML en utilisant PHP
1.3.1 Envoi
<?php
// XselSMS API POST URL
$postUrl = "[Link]
// XML structure of Data
$xmlString = "<smsRequest>
<authentification>
<apiKey>cleApi</apiKey>
</authentification>
<message>
<text>Texte à envoyer</text>
<from>xselsms</from>
</message>
<recipients>
<to>+22507123456</to>
<to>+22508123456</to>
</recipients>
</smsRequest>";
// Insertion of the POST “XML” variable name before the data in XML
format
$fields = "XML=".urlencode($xmlString);
// In this example, the POST request is completed thanks to the Curl library
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $postUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $xmlString);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:
application/xml));
// Response of the POST request
$response = curl_exec($ch);
curl_close($ch);
// Writing of the response
echo $response;
?>
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
1.3.2 Réponse
<smsResponse>
<messages>
<message>
<to>+22507123456</to>
<status>
<name>DELIVERED_TO_OPERATOR</name>
<value>401</value>
</status>
<smsCount>1</smsCount>
<messageId>Y1509712267-59fc618bf3c41</messageId>
<smsCost>28</smsCost>
</message>
<message>
<to>+22508123456</to>
<status>
<name>DELIVERED_TO_OPERATOR</name>
<value>401</value>
</status>
<smsCount>1</smsCount>
<messageId>H1509712268-59fc618c48405</messageId>
<smsCost>28</smsCost>
</message>
</messages>
</smsResponse>
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
LA METHODE JSON HTTP POST
Toutes les données doivent être transmises à l’URL [Link]
2.1 Envoi de SMS
La chaine de données JSON doit commencer avec le mot-clé : « JSON »
Pour chaque fonction de l'API vous devez communiquer l’API KEY fourni par XSEL.
2.1.1 Chaine de données :
{
"authentification": {
"apiKey": "cleApi"
},
"message": [
{
"text": "Texte à envoyer",
"from": "xselsms",
"to": [
"+22607123456",
"+22508123456"
]
}
]
}
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
2.1.2 Liste des paramètres d’envoi :
L’api Key du client (Il vous aura été
APIKEY communiqué par XSEL après la création de
votre compte)
Le contenu du SMS à envoyer (maximum 160
TEXT caractères par SMS)
Maximum 11 caractères alphanumériques
FROM (caractères spéciaux non autorisées)
Liste des destinataires au format international
RECIPIENTS (ex : +22504050607)
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
2.2 Réponse
2.2.1 Chaine de données :
{
"messages": [
{
"to": "+22607123456",
"status": {
"name": "REJECTED_DESTINATION",
"value": "203"
},
"smsCount": 1,
"messageId": "",
"smsCost": 0
},
{
"to": "+22508123456",
"status": {
"name": "DELIVERED_TO_OPERATOR",
"value": "401"
},
"smsCount": 1,
"messageId": "P1509721406-59fc853e7087a",
"smsCost": 28
}
]
}
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
2.2.2 Liste des paramètres retour:
To Le numéro du destinataire
status Valeur entière indiquant l'état de la demande (VOIR annexes
pour la liste complète)
message Texte du message à envoyer
smscount Nombre de SMS facturé pour cet envoi (bloc de 160
caractères contenus dans le message)
smsCost Le montant total débité.
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
2.3 Exemple d’envoi au format JSON en utilisant PHP
2.3.1 Envoi
<?php
// XselApi POST URL
$postUrl = "[Link]
//JSON structure of Data
$jsonString = {
"authentification": {
"apiKey": "cleApi"
},
"message": [
{
"text": "Texte à envoyer",
"from": "xselsms",
"to": [
"+22607123456",
"+22508123456"
]
}
]
}’;
// Insertion of the POST “JSON” variable name before the data in JSON
format
$fields = urlencode($jsonString);
// In this example, the POST request is completed thanks to the Curl library
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $postUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonString);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:
application/json'));
// Response of the POST request
$response = curl_exec($ch);
curl_close($ch);
// Writing of the response
echo $response;
?>
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
2.3.2 Réponse
{
"messages": [
{
"to": "+22607503925",
"status": {
"name": "REJECTED_DESTINATION",
"value": "203"
},
"smsCount": 1,
"messageId": "",
"smsCost": 0
},
{
"to": "+22508123456",
"status": {
"name": "DELIVERED_TO_OPERATOR",
"value": "401"
},
"smsCount": 1,
"messageId": "P1509721406-59fc853e7087a",
"smsCost": 28
}
]
}
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
3. LA METHODE HTTP GET
Toutes les données doivent être transmises à l’URL [Link]
3.1 Envoi de SMS
[Link]
pients=+22501010101;+22501010102
Liste des paramètres d’envoi:
L’api Key du client (Il vous aura été
APIKEY communiqué par XSEL après la création de
votre compte)
Le contenu du SMS à envoyer (maximum 160
TEXT caractères par SMS)
Maximum 11 caractères alphanumériques
FROM (caractères spéciaux non autorisées)
RECIPIENTS Liste des destinataires au format international
(ex : +22504050607)
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
3.2 Réponse
3.2.1 Chaine de données :
{
"messages": [
{
"to": "+22607503925",
"status": {
"name": "REJECTED_DESTINATION",
"value": "203"
},
"smsCount": 1,
"messageId": "",
"smsCost": 0
},
{
"to": "+22508123456",
"status": {
"name": "DELIVERED_TO_OPERATOR",
"value": "401"
},
"smsCount": 1,
"messageId": "P1509721406-59fc853e7087a",
"smsCost": 28
}
]
}
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
3.2.2 Liste des paramètres retour:
To Le numéro du destinataire
status Valeur entière indiquant l'état de la demande (VOIR
message Texte du message à envoyer
smscount Nombre de SMS facturé pour cet envoi (bloc de 160
smsCost Le montant total débité.
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
3.3 Exemple d’envoi au format HTTP en utilisant PHP
3.3.1 Envoi
<?php
// XselApi GET URL
$gettUrl = "[Link]
plain?apiKey=cleApi&text=text&recipients=+22507123456;+22508123456";
// In this example, the GET request is completed thanks to the Curl library
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $gettUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_GET, true);
// Response of the POST request
$response = curl_exec($ch);
curl_close($ch);
// Writing of the response
echo $response;
?>
3.3.2 Réponse
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
"messages": [
{
"to": "+22607503925",
"status": {
"name": "REJECTED_DESTINATION",
"value": "203"
},
"smsCount": 1,
"messageId": "",
"smsCost": 0
},
{
"to": "+22508123456",
"status": {
"name": "DELIVERED_TO_OPERATOR",
"value": "401"
},
"smsCount": 1,
"messageId": "P1509721406-59fc853e7087a",
"smsCost": 28
}
]
}
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
4. INTERROGER SON COMPTE
Le client à la possibilité de consulter son solde et le volume total de sms total envoyé depuis
sa création.
Toutes les données doivent être transmises à l’URL
[Link]
4.1 Envoi de la requête
[Link]
Liste des paramètres d’envoi :
L’api Key du client (Il vous aura été
APIKEY communiqué par XSEL après la création de
votre compte)
4.2 Réponse
4.2.1 Chaine de données :
{
"apiKey": "vlf2bYlweo0t5wmBztI8OGOF",
"Credit": "664",
"sms": "12"
}
4.2.2 Liste des paramètres retour:
Credit Montant disponible sur le compte (FCFA)
sms Volume de sms envoyé depuis la création du compte
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
5. GESTION DES ERREURS
NOM STATUT DESCRIPTION
ACCOUNT_ERROR 100 Erreur login ou mot de passe
Compte inactif (contacter le
ACCOUNT_DISABLED 101
service client)
NOT_ENOUGH_CREDITS 102 Crédit insuffisant
EMPTY_RECIPIENTS 200 Champ destinataire vide
NUMBER_REJECTED 201 Numéro incorrect
Destination non prise en
INVALID_DESTINATION_ADDRESS 202
charge
Erreur générale (contacté le
REJECTED_DESTINATION 203
support)
SenderId incorrect (ne répond
SENDER_NOT_ALLOWED 300 pas à la contrainte : maximum
caractères, alphanumérique)
SenderId non autorisé
SENDERID_REJECTED 301 (senderid non associé au
compte api)
DELIVERED_TO_OPERATOR 401
GENERAL_ERROR 910
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01
F. (+225) 22 47 06 21
Info@[Link]
Imm. Phcie Du Bonheur 3ème Étage,
Cocody Riviera-Palmeraie Abidjan-Côte d’Ivoire
NOUS CONTACTER
XSEL SMS
Email: console@[Link]
Phone: +22501000364
+22508387757
+22522470621
[Link]
Statut juridique : SARL - Capital : 5.000.000 Fcfa - RCCM : CI-ABJ-2016-B-21899 - N°CC : 1642106H - BP : 01 BP 8367 Abidjan 01