Delete a number from the stop list

This request allows you to delete a number from the stop list.

URL

POST https://api.smspartner.fr/v1/stop-sms/add

Parameters

Each API request supports the following parameters:

apiKey	API key of your account. You get it in your SMS Partner account.
id	ID of the number to be deleted. It is in the answer when retrieving the stop list.
Optional parameters
_format	Response format. You can choose between`JSON`or`XML`. By default, the response format is`JSON`.

Request

Example of a request:

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY&id=666';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/stop-sms/delete?'.$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&id=666';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/stop-sms/delete?'.$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 id As Integer = XXX
 
    #check credits
    Dim url As String
    url = base_url & "stop-sms/delete" & "?apiKey=" & apiKey & "&id=" & id
 
    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 id As Integer = XXX

#check credits

Dim url As String

url = base_url & "stop-sms/delete" & "?apiKey=" & apiKey & "&id=" & id

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 del_stop(self,id):
		url = URL + "/stop-sms/delete?apiKey=" + API_KEY + "&id=" + 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 del_stop(self,id):

url = URL + "/stop-sms/delete?apiKey=" + API_KEY + "&id=" + 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/stop-sms/delete?apiKey=xxx&id=300

1	curl -H "Content-Type: application/json" -X GET https://api.smspartner.fr/v1/stop-sms/delete?apiKey=xxx&id=300

{
    "success": true,
    "code":200
}

{

"success": true,

"code":200

}

<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>true</entry>
    <entry>200</entry>
</result>

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

</result>

Errors

Example of an error message:

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>

Control code

	Answers
1	The API Key is required
2	The phone number is required
3	The phone number ID is required
4	The phone number ID cannot be found
10	Invalid API key
200	Everything went well!