Annuler l'envoi d'un mail
Cette requête est utilisée pour envoyer des mails en temps réel ou en différé.
URL
GET https://api.mailpartner.fr/v1/message-cancel
Paramètres obligatoires
Nom
Valeur
apiKey
messageId
ID du message. Il se trouve dans la réponse lors de l’envoi d’un mail.
Paramètre optionnel
Nom
Valeur
_format
json ou xml
Attention !! Il n’est pas possible d’annuler l’envoi d’un mail moins de 5 minutes avant son envoi
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.mailpartner.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.mailpartner.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.mailpartner.fr/v1"
class MailPartner():
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 statuscurl -H "Content-Type: application/json" -X GET https://api.mailpartner.fr/v1/message-cancel?apiKey=xxx&messageId=300Réponse
{
"success": true,
"code": 200,
"message": "L'envoi du mail a été annulé."
}<?xml version="1.0" encoding="UTF-8"?>
<result>
<entry>true</entry>
<entry>200</entry>
<entry>
<![CDATA[L'envoi du mail a été annulé.]]>
</entry>
</result>Erreurs
{
"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>Code erreurs
Code de réponse
Réponse
1
La Clé API est requise
3
L’ID du message est requis
4
Message introuvable
5
L’envoi du mail a déjà été annulé
6
Vous ne pouvez pas annuler l’envoi d’un mail moins de 5 minutes avant son envoi
7
Vous ne pouvez pas annuler un mail déjà envoyé
10
Clé API incorrecte
200
Tout s’est bien passé !
Mis à jour