Annuler l’envoi d’un SMS différé

Cette requête est utilisée pour annuler l’envoi d’un SMS envoyé en différé.

URL

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

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

apiKey	Clé API de votre compte. Vous l’obtenez dans votre compte SMS Partner
messageId	ID du message. Il se trouve dans la réponse lors de l’envoi d’un SMS
Paramètres optionnels
_format	Format de la réponse. Vous pouvez choisir entre `JSON` ou `XML`. Par défaut, le format de réponse est `JSON`.

Attention !! Il n’est pas possible d’annuler l’envoi d’un SMS moins de 5 minutes avant son envoi

Requête

Exemple de requête :

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

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

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

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

# 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

# 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

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

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

const https = require('https');

// Préparer les données pour la requête GET
let data = 'apiKey=YOUR_API_KEY&messageId=300';
let url = 'https://api.smspartner.fr/v1/message-cancel?' + data;

https.get(url, (res) => {
  let data = '';

  // Un morceau de données a été reçu.
  res.on('data', (chunk) => {
    data += chunk;
  });

  // La totalité de la réponse a été reçue. Imprimer le résultat.
  res.on('end', () => {
    console.log(JSON.parse(data));
  });

}).on("error", (err) => {
  // Un message d'erreur sera imprimé en cas d'erreur.
  console.log("Erreur: " + err.message);
});

const https = require('https');

// Préparer les données pour la requête GET

let data = 'apiKey=YOUR_API_KEY&messageId=300';

let url = 'https://api.smspartner.fr/v1/message-cancel?' + data;

https.get(url, (res) => {

let data = '';

// Un morceau de données a été reçu.

res.on('data', (chunk) => {

data += chunk;

});

// La totalité de la réponse a été reçue. Imprimer le résultat.

res.on('end', () => {

console.log(JSON.parse(data));

});

}).on("error", (err) => {

// Un message d'erreur sera imprimé en cas d'erreur.

console.log("Erreur: " + err.message);

});

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class AnnulerEnvoiSMS {
    public static void main(String[] args) {
        try {
            // Prepare data for GET request
            String apiKey = "YOUR_API_KEY";
            String messageId = "300";

            // Create GET request URL
            String urlString = "https://api.smspartner.fr/v1/message-cancel?" +
                    "apiKey=" + apiKey + "&messageId=" + messageId;

            // Create URL object
            URL url = new URL(urlString);

            // Create HTTP connection
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("GET");
            connection.setConnectTimeout(10000);
            connection.setReadTimeout(10000);

            // Send GET request
            int responseCode = connection.getResponseCode();

            // Get response
            BufferedReader reader;
            if (responseCode >= 200 && responseCode <= 299) {
                reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
            } else {
                reader = new BufferedReader(new InputStreamReader(connection.getErrorStream()));
            }

            StringBuilder response = new StringBuilder();
            String line;
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
            reader.close();

            // Process your response here
            System.out.println(response.toString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

import java.io.BufferedReader;

import java.io.InputStreamReader;

import java.net.HttpURLConnection;

import java.net.URL;

public class AnnulerEnvoiSMS {

public static void main(String[] args) {

try {

// Prepare data for GET request

String apiKey = "YOUR_API_KEY";

String messageId = "300";

// Create GET request URL

String urlString = "https://api.smspartner.fr/v1/message-cancel?" +

"apiKey=" + apiKey + "&messageId=" + messageId;

// Create URL object

URL url = new URL(urlString);

// Create HTTP connection

HttpURLConnection connection = (HttpURLConnection) url.openConnection();

connection.setRequestMethod("GET");

connection.setConnectTimeout(10000);

connection.setReadTimeout(10000);

// Send GET request

int responseCode = connection.getResponseCode();

// Get response

BufferedReader reader;

if (responseCode >= 200 && responseCode <= 299) {

reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));

} else {

reader = new BufferedReader(new InputStreamReader(connection.getErrorStream()));

}

StringBuilder response = new StringBuilder();

String line;

while ((line = reader.readLine()) != null) {

response.append(line);

}

reader.close();

// Process your response here

System.out.println(response.toString());

} catch (Exception e) {

e.printStackTrace();

}

import SwiftUI

struct AnnulerEnvoi: View {
    @State private var result: String = "Loading..."

    var body: some View {
        VStack {
            Text("Annuler Envoi")
                .font(.title)
                .padding()

            Text(result)
                .font(.system(size: 20))
                .padding()
        }
        .onAppear(perform: cancelMessage)
    }

    func cancelMessage() {
        let apiKey = "YOUR_API_KEY"
        let messageId = "300"
        let urlString = "https://api.smspartner.fr/v1/message-cancel?apiKey=\(apiKey)&messageId=\(messageId)"

        guard let url = URL(string: urlString) else {
            print("URL inválida")
            return
        }

        let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
            if let error = error {
                print("Error: \(error)")
            } else if let data = data {
                let result = String(data: data, encoding: .utf8)
                DispatchQueue.main.async {
                    self.result = result ?? "Error"
                }
            }
        }

        task.resume()
    }
}

struct AnnulerEnvoi_Previews: PreviewProvider {
    static var previews: some View {
        AnnulerEnvoi()
    }
}

import SwiftUI

struct AnnulerEnvoi: View {

@State private var result: String = "Loading..."

var body: some View {

VStack {

Text("Annuler Envoi")

.font(.title)

.padding()

Text(result)

.font(.system(size: 20))

.padding()

}

.onAppear(perform: cancelMessage)

}

func cancelMessage() {

let apiKey = "YOUR_API_KEY"

let messageId = "300"

let urlString = "https://api.smspartner.fr/v1/message-cancel?apiKey=\(apiKey)&messageId=\(messageId)"

guard let url = URL(string: urlString) else {

print("URL inválida")

return

}

let task = URLSession.shared.dataTask(with: url) { (data, response, error) in

if let error = error {

print("Error: \(error)")

} else if let data = data {

let result = String(data: data, encoding: .utf8)

DispatchQueue.main.async {

self.result = result ?? "Error"

}

task.resume()

}

struct AnnulerEnvoi_Previews: PreviewProvider {

static var previews: some View {

AnnulerEnvoi()

}

package main

import (
	"io/ioutil"
	"log"
	"net/http"
	"time"
)

func main() {
	// Prepare data for GET request
	apiKey := "YOUR_API_KEY"
	messageId := "300"

	// Create GET request URL
	url := "https://api.smspartner.fr/v1/message-cancel?" +
		"apiKey=" + apiKey + "&messageId=" + messageId

	// Create HTTP client
	client := &http.Client{Timeout: 10 * time.Second}

	// Send GET request
	resp, err := client.Get(url)
	if err != nil {
		log.Fatalf("Error sending request: %v", err)
	}
	defer resp.Body.Close()

	// Get response
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatalf("Error reading response body: %v", err)
	}

	// Process your response here
	log.Printf("Response: %s", body)
}

package main

import (

"io/ioutil"

"log"

"net/http"

"time"

)

func main() {

// Prepare data for GET request

apiKey := "YOUR_API_KEY"

messageId := "300"

// Create GET request URL

url := "https://api.smspartner.fr/v1/message-cancel?" +

"apiKey=" + apiKey + "&messageId=" + messageId

// Create HTTP client

client := &http.Client{Timeout: 10 * time.Second}

// Send GET request

resp, err := client.Get(url)

if err != nil {

log.Fatalf("Error sending request: %v", err)

}

defer resp.Body.Close()

// Get response

body, err := ioutil.ReadAll(resp.Body)

if err != nil {

log.Fatalf("Error reading response body: %v", err)

}

// Process your response here

log.Printf("Response: %s", body)

}

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    private static readonly HttpClient client = new HttpClient();

    static async Task Main(string[] args)
    {
        var apiKey = "YOUR_API_KEY";
        var messageId = "300";
        var uri = new Uri($"https://api.smspartner.fr/v1/message-cancel?apiKey={apiKey}&messageId={messageId}");

        HttpResponseMessage response = await client.GetAsync(uri);

        if (response.IsSuccessStatusCode)
        {
            var result = await response.Content.ReadAsStringAsync();
            Console.WriteLine(result);
        }
        else
        {
            Console.WriteLine("GET request failed with status code: " + response.StatusCode);
        }
    }
}

using System;

using System.Net.Http;

using System.Threading.Tasks;

class Program

{

private static readonly HttpClient client = new HttpClient();

static async Task Main(string[] args)

{

var apiKey = "YOUR_API_KEY";

var messageId = "300";

var uri = new Uri($"https://api.smspartner.fr/v1/message-cancel?apiKey={apiKey}&messageId={messageId}");

HttpResponseMessage response = await client.GetAsync(uri);

if (response.IsSuccessStatusCode)

{

var result = await response.Content.ReadAsStringAsync();

Console.WriteLine(result);

}

else

{

Console.WriteLine("GET request failed with status code: " + response.StatusCode);

}

{
  "success": true,
  "code": 200,
  "message": "L'envoi du SMS a été annulé."
}

{

"success": true,

"code": 200,

"message": "L'envoi du SMS a été annulé."

}

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

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

<entry>

<![CDATA[L'envoi du SMS a été annulé.]]>

</entry>

</result>

Erreurs

Exemple de message d’erreur :

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>

Code de contrôle

	Réponse
1	La Clé API est requise
3	L’ID du message est requis
4	Message introuvable
5	L’envoi du SMS a déjà été annulé
6	Vous ne pouvez pas annuler l’envoi d’un SMS moins de 5 minutes avant son envoi
7	Vous ne pouvez pas annuler un SMS déjà envoyé
10	Clé API incorrecte
200	Tout s’est bien passé !