Single status
- Home
- Single status
Delivery status
This request allows you to retrieve the status of an SMS.
Please note: reports are received on average a few seconds after the SMS is sent, however, this delay can extend to a maximum of 48 hours depending on the operators and the load on our platform.
URL
GET https://api.smspartner.fr/v1/message-status
Parameters
Each API request supports the following parameters:
| apiKey | API key of your account. You get it in your SMS Partner account. |
|---|---|
| messageId | Message ID. It is in the answer when sending an SMS |
| phoneNumber | Mobile phone number of the recipient. |
| Optional parameters | |
| _format | Response format. You can choose between JSON or XML. By default, the response format is JSON. |
Watch out!! It is not possible to cancel the sending of an SMS less than 5 minutes before it is sent.
Request
Request example:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
<?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; ?> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
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 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
# 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 |
|
1 |
curl -H "Content-Type: application/json" -X GET https://api.smspartner.fr/v1/message-status?apiKey=xxx&messageId=300&phoneNumber=06xxxxxxxx |
Answers
|
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "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" } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
<?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> |
Errors
Example of an error message:
|
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
|
1 2 3 4 5 6 |
<?xml version='1.0' encoding='UTF-8'?> <result> <entry>false</entry> <entry>10</entry> <entry>Clé API incorrecte</entry> </result> |
Control code
| Answer | ||
|---|---|---|
| 1 | The API Key is required | |
| 2 | The phone number is required | |
| 3 | The message ID is required | |
| 4 | Message not found | |
| 10 | Invalid API key | |
| 200 | Everything went well! | |