Stato della rimessa

Questa richiesta consente di recuperare lo stato di un SMS.

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

URL

GET https://api.smspartner.fr/v1/message-status

Impostazioni

Ogni richiesta PLC supporta i seguenti parametri :

apiKey	API key per il tuo account. Si ottiene nel vostro account Partner SMS
messageId	ID del messaggio. Si trova nella risposta quando si invia un messaggio SMS.
phoneNumber	Il numero di cellulare del destinatario.
Impostazioni opzionali
_format	Formato della risposta. È possibile scegliere tra `JSON` o `XML`. Per impostazione predefinita, il formato di risposta è `JSON`.

Attenzione! Non è possibile annullare l’invio di un SMS meno di 5 minuti prima dell’invio.

Richiesta

Richiesta di campione:

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY&messageId=300&phoneNumber=06xxxxxxxx';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/message-status?'.$data);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
 
 
        $result = curl_exec($curl);
        curl_close($curl);
 
        // Process your response here
        echo $result;
?>

<?php

// Prepare data for GET request

$data = 'apiKey=YOUR_API_KEY&messageId=300&phoneNumber=06xxxxxxxx';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/message-status?'.$data);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt($curl, CURLOPT_TIMEOUT, 10);

$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"
    Dim phoneNumber As String = "06XXXXXXXX"
    Dim messageId As Integer = XXX
 
    #check credits
    Dim url As String
    url = base_url & "message-status" & "?apiKey=" & apiKey & "&phoneNumber=" & phoneNumber & "&messageId=" & messageId
 
    Dim credits As String
    credits = apiRequest("GET", url, Nothing)
 
  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"

Dim phoneNumber As String = "06XXXXXXXX"

Dim messageId As Integer = XXX

#check credits

Dim url As String

url = base_url & "message-status" & "?apiKey=" & apiKey & "&phoneNumber=" & phoneNumber & "&messageId=" & messageId

Dim credits As String

credits = apiRequest("GET", url, Nothing)

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 get_delivery(self,phone_numbers,message_id):
		url = URL + "/message-status?apiKey=" + API_KEY + "&phoneNumber=" + phone_numbers + "&messageId=" + message_id
		r = requests.get(url)
		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 get_delivery(self,phone_numbers,message_id):

url = URL + "/message-status?apiKey=" + API_KEY + "&phoneNumber=" + phone_numbers + "&messageId=" + message_id

r = requests.get(url)

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 GET  https://api.smspartner.fr/v1/message-status?apiKey=xxx&messageId=300&phoneNumber=06xxxxxxxx

1	curl -H "Content-Type: application/json" -X GET https://api.smspartner.fr/v1/message-status?apiKey=xxx&messageId=300&phoneNumber=06xxxxxxxx

{
    "success": true,
    "code": 200,
    "number": "0600000000",
    "messageId": "1111",
    "stopSms": false,
    "date": "2015-02-07 22:39:46",
    "statut": "Delivered",
    "cost": 0.045,
    "countryCode": "FR",
    "currency": "EUR"
}

{

"success": true,

"code": 200,

"number": "0600000000",

"messageId": "1111",

"stopSms": false,

"date": "2015-02-07 22:39:46",

"statut": "Delivered",

"cost": 0.045,

"countryCode": "FR",

"currency": "EUR"

}

<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>true</entry>
    <entry>200</entry>
    <entry>
        <![CDATA[0600000000]]>
    </entry>
    <entry>
        <![CDATA[1111]]>
    </entry>
    <entry>false</entry>
    <entry>
        <![CDATA[2015-02-07 22:39:46]]>
    </entry>
    <entry>
        <![CDATA[Delivered]]>
    </entry>
    <entry>0.045</entry>
    <entry>
        <![CDATA[FR]]>
    </entry>
    <entry>
        <![CDATA[EUR]]>
    </entry>
</result>

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

<entry>

<![CDATA[0600000000]]>

</entry>

<entry>

<![CDATA[1111]]>

</entry>

<entry>false</entry>

<entry>

<![CDATA[2015-02-07 22:39:46]]>

</entry>

<entry>

<![CDATA[Delivered]]>

</entry>

<entry>

<![CDATA[FR]]>

</entry>

<entry>

<![CDATA[EUR]]>

</entry>

</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>Clé API incorrecte</entry>
</result>

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

<entry>false</entry>

<entry>Clé API incorrecte</entry>

</result>

Codice di controllo

	Rispondi a
1	La chiave API è richiesta
2	Il numero di telefono è obbligatorio
3	L’ID del messaggio è richiesto
4	Messaggio non trovato
10	Chiave API errata
200	È andato tutto bene!

Stato unitario

Stato della rimessa

URL

GET https://api.smspartner.fr/v1/message-status

Impostazioni

Richiesta

Risposte

Errori

Codice di controllo