Développeurs

API du développeur

Envoyer des SMS via SMPP, HTTP ou HTTPS API SMS, en XML ou JSON

SMS.ci met à votre disposition des exemples de codes afin que vous puissiez intégrer et utiliser notre plateforme sms de pointe plus rapidement et plus facilement. Coupez et collez le code de l’API SMS et commencez le SMS en quelques minutes. L’inscription est facile et vous serez opérationnel en un rien de temps. Cliquez ici pour obtenir la documentation complète. https://smsing.docs.apiary.io

Endpoint: https://smsing.cloud//api/v2/SendSMS

PHP

$url = 'https://smsing.cloud//api/v2/SendSMS';
$fields = array('apikey' => $api_key,
'from' => $from,
'to' => $to,
'message' => $message,
'rotate' => $rotate,
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
$result = curl_exec($ch);
return $result;

GET

BASH

curl -X POST https://smsing.cloud//api/v2/SendSMS \
    --data-urlencode from='12345670987' \
    --data-urlencode to='331234567890' \
    --data-urlencode message='Hello world' \
     -d apikey=yourkey

https://smsing.cloud//api/v2/SendSMS?apikey={api_key}
&from={from}
&to={to}
&message={message}
&rotate={rotate}

PYTHON

import requests

resp = requests.post('https://smsing.cloud//api/v2/SendSMS', {
apikey: 'yourkey',
from: '1234567890',
to: '331234567889',
message: 'OTP 3456',
})
print(resp.json())

JAVASCRIPT

RUBY

fetch('https://smsing.cloud/apis/smsgroup/, {
  method: 'post',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    apikey: 'yourkey',
    from: '1234567890',
    to: '331234567889',
    message: 'OTP 3456',
  }),
}).then(response => {
  return response.json();
}).then(data => {
  console.log(data);
});

require 'net/http'
require 'uri'

uri = URI.parse("https://smsing.cloud//api/v2/SendSMS")
Net::HTTP.post_form(uri, {
    apikey => 'yourkey',
    from => '1234567890',
    to => '331234567889',
    message => 'OTP 3456',
})

NODE

C#

using System;
using System.Collections.Specialized;
using System.Net;

using (WebClient client = new WebClient())
{
  byte[] response = client.UploadValues("https://smsing.cloud//api/v2/SendSMS", new NameValueCollection() {
    { "apikey", "yourkey" },
    { "from", "123456789" },
    { "to", "33123456789" },
    { "message", "Hello world" },
  });

  string result = System.Text.Encoding.UTF8.GetString(response);
}

// Using request
const request = require('request');
request.post('https://smsing.cloud//api/v2/SendSMS', {
  form: {
    apikey: 'yourkey',
    from: '1234567890',
    to: '331234567889',
    message: 'OTP 3456',
  },
}, (err, httpResponse, body) => {
  console.log(JSON.parse(body));
});

// Using axios
const axios = require('axios');
axios.post('https://smsing.cloud/apis/smsgroup/', {
    apikey: 'yourkey',
    from: '1234567890',
    to: '331234567889',
    message: 'OTP 3456',
}).then(response => {
  console.log(response.data);
})

Reponses

Example API Response (data is returned in universal and lightweight JSON format)

{
"status":"-4",
"msg":"There was no message passed in to be sent."
}

Paramètres
apikey	(Obligatoire) La clé API de votre compte.
from	(Obligatoire) Le numéro que vous envoyez. Il peut s’agir de n’importe quel numéro SMS dans votre compte.
to	(Obligatoire) Nom du groupe auquel vous envoyez le message. Il doit s’agir d’un nom de groupe valide qui existe dans votre liste de groupes.
message	(Obligatoire) Texte du message que vous envoyez. 1 crédit est facturé pour chaque segment de 160 caractères. Si vous avez un message de 300 caractères et que vous envoyez à 10 personnes, 20 crédits seront déduits (2 crédits pour chaque personne). REMARQUE : Les messages contenant des caractères non-GSM(unicode) seront facturés 1 crédit pour chaque segment de 70 caractères.
alphasender	(Facultatif) Il s’agit de l’ID d’expéditeur alphanumérique à partir duquel vous souhaitez envoyer le message. Seuls certains pays peuvent envoyer à partir d’un ID expéditeur alphanumérique. Exigences relatives à l’identifiant alphanumérique de l’expéditeur : toute combinaison de 1 à 11 lettres (A-Z/a-z) et de chiffres (0-9). 1 lettre et pas plus de 11 caractères alphanumériques peuvent être utilisés.
rotate	(Facultatif) Indicateur si vous souhaitez faire pivoter tous les numéros de votre compte lors de l’envoi du message. Réglez la valeur sur 1 si vous voulez effectuer une rotation. Si rien n’est transmis, il ne tournera PAS à travers vos numéros.
throttle	(Facultatif) Accélération de l’envoi pour contrôler la vitesse d’envoi du message envoyé. La valeur par défaut est 1, ce qui envoie le message à un taux de 1 SMS toutes les 1 seconde par code long. Si rien n’est passé, il enverra à ce rythme. Si vous voulez envoyer un débit plus lent, vous pouvez passer dans un 2, 3, 4, 5 ou 6 qui enverra à un débit de 1 SMS toutes les 2 secondes par code long, toutes les 3 secondes, etc… Le réglage le plus lent qui peut être utilisé est 6.
sendondate	(Facultatif) Si vous planifiez des SMS en bloc, il s’agit du message de date/heure qui sera envoyé. S’il s’agit d’un événement récurrent, il s’agit de la 1ère date/heure de la série. Format: DD-MM-YYYY HH:MM Example: 20-03-2017 19:30
recurring	(Facultatif) Créez des événements périodiques. Attribuez la valeur 1 si vous souhaitez créer un événement récurrent.
repeat	(Facultatif) Type d’événement périodique que vous souhaitez planifier. Les valeurs valides sont « Quotidien », « Hebdomadaire », « Mensuel », « Annuel ».
frequency	(Facultatif) Fréquence à laquelle vous souhaitez que les événements récurrents se produisent en fonction du paramètre Répéter ci-dessus. Par exemple, si vous passez « Quotidiennement » pour « Répéter » et « 3 » pour « Fréquence », il planifiera les événements tous les 3 jours. Les valeurs valides sont 1-30.
enddate	(Facultatif) Date de fin à laquelle vous souhaitez que les événements périodiques se terminent. Par exemple, si vous transmettez une sendondate(date de début) du 10 octobre à 6 h 30 et que vous souhaitez que le dernier événement s’exécute le 10 novembre, vous devez transmettre une date de fin du 10 novembre à 6 h 30 afin que le 10 novembre soit inclus comme dernière date. Format: DD-MM-YYYY HH:MM Example: 20-03-2017 19:30

Return Values
0 or group SMS ID	0 est retransmis lors d’un appel d’API réussi lors de la planification de SMS en bloc. L’ID SMS de groupe sera transmis lors d’un appel API réussi lors de l’envoi immédiat de SMS en bloc.
-1	Clé API non valide transmise.
-2	Aucun numéro « FROM » n’a été transmis.
-3	Le numéro « From » transmis n’existe pas dans votre compte ou n’est pas compatible SMS.
-4	Aucun message à envoyer n’a été transmis.
-5	Aucun groupe n’est passé.
-6	Le groupe transmis n’est pas valide ou n’existe pas.
-7	L’ID d’expéditeur alphanumérique transmis n’est pas valide (ne correspond pas aux exigences ci-dessous) OU le compte d’utilisateur n’est pas autorisé à envoyer à partir d’un ID d’expéditeur alphanumérique. Exigences : Vous pouvez utiliser n’importe quelle combinaison de 1 à 11 lettres (A-Z/a-z) et de chiffres (0-9). 1 lettre et pas plus de 11 caractères alphanumériques peuvent être utilisés.
-8	L’indicateur de rotation transmis n’est pas valide. Les valeurs appropriées sont 1 ou 0.
-9	L’indicateur de limitation d’envoi passé n’est pas valide. Les valeurs appropriées sont 1, 2, 3, 4, 5 ou 6.
-10	L’indicateur périodique transmis n’est pas valide. Les valeurs appropriées sont 1 ou 0.
-11	Le paramètre de répétition transmis n’est pas valide. Les valeurs appropriées sont « Quotidien », « Hebdomadaire », « Mensuel », « Annuel ». De plus, si l’indicateur récurrent est 1 et que rien n’est passé pour ce champ déclenche cette erreur.
-12	Le paramètre de fréquence transmis n’est pas valide. Les valeurs appropriées sont comprises entre 1 et 30. De plus, si l’indicateur récurrent est 1 et que rien n’est passé pour ce champ déclenche cette erreur.
-13	Vous devez disposer d’une date de fin périodique pour planifier un événement périodique. L’indicateur périodique est 1 et rien n’est transmis pour la date de fin.
-14	Pas assez de crédits pour envoyer le message.
-15	Aucun abonné trouvé dans le groupe.
-16	Autre erreur.
-20	Le niveau 1 n’a pas accès à l’API. L’API peut uniquement être utilisée avec les niveaux 2, 3 et 4.