Envoyer des SMS

Cette requête est utilisée pour envoyer des SMS en temps réel ou en différé.

URL

POST https://api.smspartner.fr/v1/send

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

La plateforme n’envoie pas de SMS commerciaux entre 20h et 8h en semaine et les dimanches et jours fériés (restriction légale). Si un message SMS est envoyé, le message est en pause jusqu’au prochain jour ouvrable à 8h.
Vous n’envoyez pas de SMS commerciaux? contactez-nous pour désactiver cette restriction : help@smspartner.fr

apiKey	Clé API de votre compte. Vous l’obtenez dans votre compte SMS Partner.
phoneNumbers	Numéros de téléphone des destinataires. Pour l’envoi de plusieurs SMS les numéros doivent être séparés par des virgules. Ils peuvent être : au format national (06xxxxxxxx) ou international (+336xxxxxxxx), pour des numéros français. au format international (+496xxxxxxxx), pour des numéros hors France.
message	Contenu du SMS. 160 caractères maximum par SMS (au delà, il vous sera décompté un SMS supplémentaire par tranche de 153 caractères). Attention, certains caractères spéciaux et accentués seront remplacés lors de l’envoi : Voir la liste Le caractère ” doit obligatoirement être échappé (\”) pour que le texte du SMS soit valide. Dans le cas contraire une erreur 400 sera retournée. Le tag `:br:` Permet de faire un saut de ligne. Attention le saut de ligne comptes pour deux caractères. `La mention STOP SMS est obligatoire pour les SMS à caractères commerciaux (voir le paramètre isStopSms ci-dessous)`
Paramètres optionnels
gamme	Gamme du SMS, sa valeur doit être: 1 pour les SMS Premium 2 pour les SMS Low Cost Si ce paramètre est omis , les SMS seront envoyés dans la gamme Premium
sender	Nom d’émetteur du message. Si l’émetteur est laissé vide, vos SMS seront acheminés avec un shortcode opérateur en guise d’expéditeur (exemple : 36xxx). Le nombre de caractères pour le nom d’émetteur doit être compris entre 3 et 11 inclus et ne doit pas comporter de caractères spéciaux. Certains modèles de téléphone portable n’interprètent pas les espaces.
tag	Chaine de caractères de 20 caractères maximum sans espace(s) et en minuscule(s)
scheduledDeliveryDate	Date d’envoi du SMS, au format `dd/mm/YYYY`. A définir uniquement si vous souhaitez que les SMS soient envoyés en différé.
time	Heure d’envoi du SMS (format 0-24), obligatoire si `scheduledDeliveryDate` est défini.
minute	Minute d’envoi du SMS (format 0-55, par intervalle de cinq minutes). , obligatoire si `scheduledDeliveryDate` est défini.
urlResponse	Url de retour des Réponses (ex: http://www.monurldereponse)
urlDlr	Url de retour des Accusé de réceptions (ex: http://www.monurldedlr)
isStopSms	Gamme premium: 1 pour ajouter la mention STOP à la fin du SMS ( obligatoire pour des SMS commerciaux ). Gamme ÉCO: Ce paramètre n’est pas applicable pour cette gamme, il est nécessaire d’ajouter manuellement la mention NoPub=STOP pour les SMS commerciaux.
sandbox	Pour tester l’envoi de SMS, vous pouvez utiliser le paramètre `sandbox`: 1 pour activer le mode bac à sable Aucun SMS ne sera envoyé, et il n’y aura aucun débit sur votre compte. Ces SMS seront supprimés de vos listes d’envois automatiquement tous les jours.
_format	Format de la réponse. Vous pouvez choisir entre `JSON` ou `XML`. Par défaut, le format de réponse est `JSON`.

Requête

Exemple de requête :

<?php
        // Prepare data for POST request
        $fields = array(
            'apiKey'=> 'YOUR API KEY',
            'phoneNumbers'=> '+336xxxxxxxx',
            'message'=> 'This is your message',
            'sender' => 'mycompany',
            'scheduledDeliveryDate'=> '21/10/2014',
            'time'=> 9,
            'minute'=> 0
        );
 
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/send');
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields));
 
        $result = curl_exec($curl);
        curl_close($curl);
 
        // Process your response here
        echo $result;
?>

<?php

// Prepare data for POST request

$fields = array(

'apiKey'=> 'YOUR API KEY',

'phoneNumbers'=> '+336xxxxxxxx',

'message'=> 'This is your message',

'sender' => 'mycompany',

'scheduledDeliveryDate'=> '21/10/2014',

'time'=> 9,

'minute'=> 0

);

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/send');

curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt($curl, CURLOPT_TIMEOUT, 10);

curl_setopt($curl, CURLOPT_POST, 1);

curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields));

$result = curl_exec($curl);

curl_close($curl);

// Process your response here

echo $result;

Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.smspartner.fr/v1/"
    Dim apiKey As String = "VOTRE_APIKEY"
 
    #send sms
    url = base_url & "send"
    #note : utiliser une librairie JSON en production, par exemple :
    #https//www.nuget.org/packages/Newtonsoft.Json/
    Dim parameters As String = String.Format(
        "{{""apiKey"":""{0}"",""phoneNumbers"":""{1}"",""message"":""{2}""}}",
        apiKey,
        "+33XXXXXXXXX",
        "message de test")
    Console.Write(parameters)
    apiRequest("POST", url, parameters)
 
  End Sub
 
  Function apiRequest(method As String, url As String, parameters As String) As String
 
    Dim request As HttpWebRequest
    request = WebRequest.Create(url)
    request.Method = method
    request.Timeout = 10000   # timeout in ms
    request.ContentType = "application/json; charset=utf-8"
    request.ContentLength = 0
 
    #set POST data
    If Not String.IsNullOrEmpty(parameters) Then
      request.ContentLength = parameters.Length
      Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())
        reqStream.Write(parameters)
      End Using
    End If
 
    #get response
    Dim returnValue As String = Nothing
    Using response As HttpWebResponse = request.GetResponse()
      If response.StatusCode = HttpStatusCode.OK Then
        Using resStream = response.GetResponseStream()
          If resStream IsNot Nothing Then
            Using reader As New StreamReader(resStream)
              returnValue = reader.ReadToEnd()
            End Using
          End If
        End Using
      End If
    End Using
    apiRequest = returnValue
 
  End Function
 
End Module

Imports System.IO

Imports System.Net

Module Module1

Sub Main()

Dim base_url As String = "http://api.smspartner.fr/v1/"

Dim apiKey As String = "VOTRE_APIKEY"

#send sms

url = base_url & "send"

#note : utiliser une librairie JSON en production, par exemple :

#https//www.nuget.org/packages/Newtonsoft.Json/

Dim parameters As String = String.Format(

"{{""apiKey"":""{0}"",""phoneNumbers"":""{1}"",""message"":""{2}""}}",

apiKey,

"+33XXXXXXXXX",

"message de test")

Console.Write(parameters)

apiRequest("POST", url, parameters)

End Sub

Function apiRequest(method As String, url As String, parameters As String) As String

Dim request As HttpWebRequest

request = WebRequest.Create(url)

request.Method = method

request.Timeout = 10000 # timeout in ms

request.ContentType = "application/json; charset=utf-8"

request.ContentLength = 0

#set POST data

If Not String.IsNullOrEmpty(parameters) Then

request.ContentLength = parameters.Length

Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())

reqStream.Write(parameters)

End Using

End If

#get response

Dim returnValue As String = Nothing

Using response As HttpWebResponse = request.GetResponse()

If response.StatusCode = HttpStatusCode.OK Then

Using resStream = response.GetResponseStream()

If resStream IsNot Nothing Then

Using reader As New StreamReader(resStream)

returnValue = reader.ReadToEnd()

End Using

End If

End Using

End If

End Using

apiRequest = returnValue

End Function

End Module

# std
import logging
import json
from collections import OrderedDict
 
# 3p
import requests
 
API_KEY = "MY API KEY"
URL = "https://api.smspartner.fr/v1"
 
class SMSPartner():
    def send_sms(self,phone_numbers, msg, sender = "SMSPartner"):
		#sender = "DEMOSMS"
		print(phone_numbers)
 
		data = OrderedDict([
			("apiKey", API_KEY),
			("phoneNumbers", phone_numbers),
			("message", msg),
			("sender", sender)
		])
 
		url = URL + "/send"
		r = requests.post(url, data=json.dumps(data), verify=False)
 
		r_json = r.json()
		if r_json.get("success") == True:
			print(r_json)
			status = True
		else:
			print("SMS msg {} not delivered to {}".format(msg, phone_numbers))
			status = False
		return status

# std

import logging

import json

from collections import OrderedDict

# 3p

import requests

API_KEY = "MY API KEY"

URL = "https://api.smspartner.fr/v1"

class SMSPartner():

def send_sms(self,phone_numbers, msg, sender = "SMSPartner"):

#sender = "DEMOSMS"

print(phone_numbers)

data = OrderedDict([

("apiKey", API_KEY),

("phoneNumbers", phone_numbers),

("message", msg),

("sender", sender)

])

url = URL + "/send"

r = requests.post(url, data=json.dumps(data), verify=False)

r_json = r.json()

if r_json.get("success") == True:

print(r_json)

status = True

else:

print("SMS msg {} not delivered to {}".format(msg, phone_numbers))

status = False

return status

curl -H  "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","message":"test","sender":"mycompany"}' https://api.smspartner.fr/v1/send

1	curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","message":"test","sender":"mycompany"}' https://api.smspartner.fr/v1/send

{
   "success":true,
   "code":200,
   "message_id":307,
   "nb_sms": 1,
   "cost": 0.038,
   "currency": "EUR"
}

{

"success":true,

"code":200,

"message_id":307,

"nb_sms": 1,

"cost": 0.038,

"currency": "EUR"

}

<?xml version='1.0' encoding='UTF-8'?>
<result>
  <entry>true</entry>
  <entry>200</entry>
  <entry>306</entry>
  <entry>1</entry>
  <entry>0.038</entry>
  <entry>
        <![CDATA[EUR]]>
  </entry>
</result>

<?xml version='1.0' encoding='UTF-8'?>

<entry>

<![CDATA[EUR]]>

</entry>

</result>

Erreurs

Exemple de message d’erreur:

JSON
XML

{
    "success": false,
    "code":9,
    "error": [{
        "elementId": "children[message].data",
        "message": "Le message est requis"
    }, {
        "elementId": "children[phoneNumbers].data",
        "message": "Ce numero de telephone n'est pas valide (922264)"
    }, {
        "elementId": "children[sender].data",
        "message": "L'emetteur ne peut pas etre plus long que 11 caracteres"
    }, {
        "elementId": "children[scheduledDeliveryDate].data",
        "message": "La date (21/11/2014 \u00e0 :) est anterieure a la date actuelle."
    }, {
        "elementId": "children[minute].data",
        "message": "La minute est requise"
    }, {
        "elementId": "children[time].data",
        "message": "L'heure est requise"
    }]
}

{

"success": false,

"code":9,

"error": [{

"elementId": "children[message].data",

"message": "Le message est requis"

}, {

"elementId": "children[phoneNumbers].data",

"message": "Ce numero de telephone n'est pas valide (922264)"

}, {

"elementId": "children[sender].data",

"message": "L'emetteur ne peut pas etre plus long que 11 caracteres"

}, {

"elementId": "children[scheduledDeliveryDate].data",

"message": "La date (21/11/2014 \u00e0 :) est anterieure a la date actuelle."

}, {

"elementId": "children[minute].data",

"message": "La minute est requise"

}, {

"elementId": "children[time].data",

"message": "L'heure est requise"

}]

}

<?xml version='1.0' encoding='UTF-8'?>
 <result>
          <entry>false</entry>
          <entry>9</entry>
          <entry>
                <entry>
                  <entry>children[message].data</entry>
                  <entry>Le message est requis</entry>
                </entry>
                <entry>
                   <entry>children[phoneNumbers].data</entry>
                   <entry>Ce numéro de téléphone n'est pas valide (922264)</entry>
                </entry>
                <entry>
                    <entry>children[sender].data</entry>
                    <entry>L'émetteur ne peut pas être plus long que 11 caractères</entry>
                </entry>
                <entry>
                    <entry>children[scheduledDeliveryDate].data</entry>
                    <entry>La date (21/11/2014 à :) est anterieure à la date actuelle. Si vous souhaitez l'envoyer maintenant vous devez sélectionner [Envoi immédiat]</entry>
                </entry>
                <entry>
                    <entry>children[minute].data</entry>
                    <entry>La minute est requise</entry>
                </entry>
                <entry>
                    <entry>children[time].data</entry>
                    <entry>L'heure est requise</entry>
                </entry>
      </entry>
</result>

<?xml version='1.0' encoding='UTF-8'?>

<entry>false</entry>

<entry>

<entry>children[message].data</entry>

<entry>Le message est requis</entry>

</entry>

<entry>

<entry>children[phoneNumbers].data</entry>

<entry>Ce numéro de téléphone n'est pas valide (922264)</entry>

</entry>

<entry>

<entry>children[sender].data</entry>

<entry>L'émetteur ne peut pas être plus long que 11 caractères</entry>

</entry>

<entry>

<entry>children[scheduledDeliveryDate].data</entry>

<entry>La date (21/11/2014 à :) est anterieure à la date actuelle. Si vous souhaitez l'envoyer maintenant vous devez sélectionner [Envoi immédiat]</entry>

</entry>

<entry>

<entry>children[minute].data</entry>

<entry>La minute est requise</entry>

</entry>

<entry>

<entry>children[time].data</entry>

<entry>L'heure est requise</entry>

</entry>

</result>

Code de contrôle

	Code erreurs
1	La Clé API est requise
2	Le numéro de téléphone est requis
9	Au moins une contrainte n’a pas été respectée lors de l’envoi : L’émetteur ne peut pas être plus long que 11 caractères. Numéro de téléphone non valide. Si `scheduledDeliveryDate` est défini: La date (dd/mm/yyyy) est antérieure à la date actuelle. La minute est requise. L’heure est requise.
10	Clé API incorrecte
11	Manque de crédits

Liste des caractères remplacés

Caractères	Remplacé par:
ą	à
’	‘
ÿ	y
ç	Ç
û	u
ü	u
ï	i
ô	o
ö	o
ó	o
î	i
ë	e
ê	e
[	(
]	)
{	(
}	)
`	‘
µ	u
Ä	A
À	A
Á	A

Caractères	Remplacé par:
Â	A
Ã	A
È	E
Ê	E
Ë	E
Î	I
Ü	U
Ù	U
Ú	U
Û	U
Ý	Y
ä	a
á	a
â	a
ã	a
Ö	O
Ô	O
œ	oe
^	Supprimé
~	Supprimé
\|	Supprimé
\	Supprimé
¨	Supprimé
°	.
‘	‘
“	‘
ñ	n
Ñ	N
§	Supprimé
«	“
»	“

Caractères	Remplacé par:
ą	à
’	‘
ÿ	y
ç	Ç
û	u
ü	u
ï	i
ô	o
ö	o
ó	o
î	i
ë	e
ê	e
[	(
]	)
{	(
}	)
`	‘
µ	u
Ä	A
À	A
Á	A

Caractères	Remplacé par:
ą	à
’	‘
ÿ	y
ç	Ç
û	u
ü	u
ï	i
ô	o
ö	o
ó	o
î	i
ë	e
ê	e
[	(
]	)
{	(
}	)
`	‘
µ	u
Ä	A
À	A
Á	A

Envoi unitaire

Envoyer des SMS

URL

POST https://api.smspartner.fr/v1/send

Paramètres

Requête

Réponses

Erreurs

Code de contrôle

Liste des caractères remplacés

ą

à

’

‘

ÿ

y

ç

Ç

û

u

ü

u

ï

i

ô

o

ö

o

ó

o

î

i

ë

e

ê

e

[

(

]

)

{

(

}

)

`

‘

µ

u

Ä

A

À

A

Á

A

Â

A

Ã

A

È

E

Ê

E

Ë

E

Î

I

Ü

U

Ù

U

Ú

U

Û

U

Ý

Y

ä

a

á

a

Caractères	Remplacé par:
ą	à
’	‘
ÿ	y
ç	Ç
û	u
ü	u
ï	i
ô	o
ö	o
ó	o
î	i
ë	e
ê	e
[	(
]	)
{	(
}	)
`	‘
µ	u
Ä	A
À	A
Á	A