Annullare l’invio di un messaggio di testo
- Home
- Annullare l’invio di un messaggio di testo
Annullare l’invio di un sms differito
Questa richiesta viene utilizzata per annullare l’invio di un SMS in ritardo.
URL
GET https://api.smspartner.fr/v1/message-cancel
Impostazioni
Ogni richiesta API 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. |
Parametri 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:
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'; $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/message-cancel?'.$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 |
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 messageId As Integer = XXX #check credits Dim url As String url = base_url & "message-cancel" & "?apiKey=" & apiKey & "&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-cancel?apiKey=" + API_KEY + "&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-cancel?apiKey=xxx&messageId=300 |
Risposte
1 2 3 4 5 |
{ "success": true, "code": 200, "message": "L'envoi du SMS a été annulé." } |
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>200</entry> <entry> <![CDATA[L'envoi du SMS a été annulé.]]> </entry> </result> |
Errori
Esempio di messaggio di errore :
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> |
Codice di controllo
Rispondi a | ||
---|---|---|
1 | La chiave API è richiesta | |
3 | L’ID del messaggio è richiesto | |
4 | Messaggio non trovato | |
5 | L’invio dell’SMS è già stato cancellato. | |
6 | Non è possibile annullare l’invio di un SMS meno di 5 minuti prima dell’invio. | |
7 | Non è possibile cancellare un SMS già inviato | |
10 | Chiave API errata | |
200 | È andato tutto bene! |