Invio di messaggi SMS

Questa richiesta viene utilizzata per inviare messaggi SMS in tempo reale o in ritardo.

URL

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

Impostazioni

Ogni richiesta API supporta i seguenti parametri :

La piattaforma non invia SMS commerciali tra le 22.00 e le 8.00 nei giorni feriali e nelle domeniche e nei giorni festivi (restrizione legale). In caso di invio, i messaggi SMS vengono messi in pausa fino al giorno lavorativo successivo alle 8 del mattino. Se non inviate messaggi SMS commerciali, vi preghiamo di contattarci: help@smspartner.fr

apiKey	API key per il tuo account. Lo ottieni nel tuo account Partner SMS.
phoneNumbers	Numeri di telefono dei destinatari. Quando si inviano più messaggi SMS, i numeri devono essere separati da virgole. Possono essere : in formato nazionale (06xxxxxxxxxxxx) o internazionale (+336xxxxxxxxxxxx), per i numeri francesi. in formato internazionale (+496xxxxxxxxxxxxxxxxxxxx), per i numeri fuori dalla Francia.
message	Contenuto dell’SMS. 160 caratteri al massimo per SMS (oltre a questo, vi verrà addebitato un ulteriore SMS per 153 caratteri). Si prega di notare che alcuni caratteri speciali e caratteri accentati saranno sostituiti al momento dell’invio : Vedi l’elenco `\r\n` ti permette di fare un’interruzione di linea. `La menzione STOP SMS è obbligatoria per gli SMS con caratteri commerciali (vedi il parametro isStopSms qui sotto).`
Parametri opzionali
gamme	Gamma dell’SMS, il suo valore deve essere: 1 per SMS Premium 2 per SMS a basso costo Se questa impostazione viene omessa, l’SMS verrà inviato nell’intervallo Premium.
sender	Nome del mittente del messaggio. Se il mittente viene lasciato vuoto, i vostri messaggi SMS verranno inoltrati con un shortcode operatore come mittente (esempio: 36xxx). Il numero di caratteri per il nome del mittente deve essere compreso tra 3 e 11 e non deve contenere caratteri speciali. Alcuni modelli di cellulari non interpretano gli spazi.
scheduledDeliveryDate	La data di invio dell’SMS, nel formato `gg/mm/AAAA`. Da definire solo se si desidera che l’SMS venga inviato in ritardo.
time	Time in cui viene inviato l’SMS (formato 0-24), obbligatorio se è definito `scheduledDeliveryDate`
minute	Minuto di invio dell’SMS (formato 0-55, a intervalli di cinque minuti). Obbligatorio se è definita la `scheduledDeliveryDate`
urlResponse	Url di restituzione delle Risposte (es: http://www.ilmiourldirisposta)
urlDlr	Url di restituzione delle Ricevute di ritorno (ex: http://www.ilmiourldidlr)
isStopSms	Gamma Premium: 1 per aggiungere STOP alla fine dell’SMS (obbligatorio per gli SMS commerciali). Lowcost range: Questo parametro non è applicabile per questo range, è necessario aggiungere manualmente la menzione NoPub=STOP per gli SMS commerciali.
sandbox	Per testare l’invio di SMS, è possibile utilizzare il parametro `sandbox`: 1 per attivare la modalità sandbox Non verrà inviato alcun SMS e non ci sarà alcun addebito sul vostro conto. Questi messaggi SMS saranno cancellati automaticamente ogni giorno dalle vostre mailing list.
_format	Formato della risposta. È possibile scegliere tra `JSON` o`XML`. Il formato di risposta predefinito è `JSON`.

Richiesta

Interrogazione campione :

<?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>

Errori

Esempio di messaggio di errore:

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>

Codice di controllo

	Codice di errore
1	La chiave API è richiesta
2	Il numero di telefono è obbligatorio
9	Almeno un vincolo non è stato rispettato durante l’invio : Il mittente non può essere più lungo di 11 caratteri. Numero di telefono non valido. Se è definita la `scheduledDeliveryDate` est défini: La data (gg/mm/aaaa) è anteriore a quella attuale. Il minuto è necessario. L’ora è obbligatoria.
10	Chiave API errata
11	Mancanza di credito

Spedizione singola

Invio di messaggi SMS

URL

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

Impostazioni

Richiesta

Risposte

Errori

Codice di controllo