Aggiungere un numero all’elenco degli stop

Questa interrogazione consente di aggiungere un numero alla lista di stop.

Attenzione: le segnalazioni vengono ricevute in media pochi secondi dopo l’invio dell’SMS, ma questo ritardo può arrivare fino ad un massimo di 48 ore a seconda degli operatori e del carico della nostra piattaforma.

URL

POST https://api.smspartner.fr/v1/stop-sms/add

Impostazioni

Ogni richiesta API supporta i seguenti parametri :

apiKey	API key per il tuo account. Lo ottieni nel tuo account Partner SMS.
phoneNumber	Numeri di cellulare da aggiungere. Possono essere : in formato nazionale (06xxxxxxxxxxxx) o internazionale (+396xxxxxxxxxxxx), per i numeri italiani. in formato internazionale (+496xxxxxxxxxxxxxxxxxxxx), per i numeri fuori dalla Italia.
Parametri opzionali
_format	Formato della risposta. È possibile scegliere tra `JSON` o`XML`. Per impostazione predefinita, il formato di risposta è `JSON`.

Richiesta

Richiesta di campione:

<?php
        // Prepare data for POST request
        $fields = array(
            'apiKey'=> 'YOUR API KEY',
            'phoneNumber'=> '+336xxxxxxxx'
        );
 
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/stop-sms/add');
        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',

'phoneNumber'=> '+336xxxxxxxx'

);

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/stop-sms/add');

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 & "stop-sms/add"
    #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}""}}",
        apiKey,
        "+33XXXXXXXXX")
    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 & "stop-sms/add"

#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}""}}",

apiKey,

"+33XXXXXXXXX")

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 add_stop(self,phone_numbers):
 
		data = OrderedDict([
			("apiKey", API_KEY),
			("phoneNumbers", phone_numbers)
		])
 
		url = URL + "/stop-sms/add"
		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(r_json)
			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 add_stop(self,phone_numbers):

data = OrderedDict([

("apiKey", API_KEY),

("phoneNumbers", phone_numbers)

])

url = URL + "/stop-sms/add"

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(r_json)

status = False

return status

curl -H  "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumber":"xxxx"}' https://api.smspartner.fr/v1/stop-sms/add

1	curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumber":"xxxx"}' https://api.smspartner.fr/v1/stop-sms/add

{
    "success": true,
    "code":200
    "stopId": 300
}

{

"success": true,

"code":200

"stopId": 300

}

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry>true</entry>
    <entry>1</entry>
    <entry>24</entry>
</result>

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

</result>

Errori

Esempio di messaggio di errore :

JSON
XML

{
    "success": false,
    "code": 10,
    "message": "Clé API incorrecte"
}

{

"success": false,

"code": 10,

"message": "Clé API incorrecte"

}

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry>false</entry>
    <entry>10</entry>
    <entry>
        <![CDATA[Clé API incorrecte]]>
    </entry>
</result

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

<entry>false</entry>

<entry>

<![CDATA[Clé API incorrecte]]>

</entry>

</result

Codice di controllo

	Rispondi a
1	La chiave API è richiesta
2	Il numero di telefono è obbligatorio
3	Il numero è già nell’elenco
9	Il numero di telefono non è valido
10	Chiave API errata
200	È andato tutto bene!

Aggiungi un numero

Aggiungere un numero all’elenco degli stop

URL

POST https://api.smspartner.fr/v1/stop-sms/add

Impostazioni

Richiesta

Risposte

Errori

Codice di controllo