Agregar un número
- Home
- Agregar un número
Agregar un número a la lista de Stop
Esta solicitud agregará un número a la lista de Stop.
Nota: los informes se reciben en promedio unos segundos después de enviar el SMS; sin embargo, este período puede extenderse hasta 48 horas como máximo en función del operador y la carga en nuestra plataforma.
URL
POST https://api.smspartner.fr/v1/stop-sms/add
Configuraciones
Cada solicitud de API es compatible con los siguientes parámetros :/p>
apiKey | Clave de API de su cuenta. Usted lo consigue en su Cuenta de SMS Partner |
---|---|
phoneNumber | Números móviles a agregar. Pueden ser:
|
Ajustes opcionales | |
_format | Formato de la respuesta. Se puede elegir entre JSON o XML . Por defecto, el formato de respuesta es JSON . |
Solicitud
Ejemplo de solicitud :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
<?php // Prepare data for POST request $fields = array( 'apiKey'=> 'YOUR API KEY', 'phoneNumber'=> '+336xxxxxxxx' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/stop-sms/add'); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields)); $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 57 58 |
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" #send sms url = base_url & "stop-sms/add" #note : utiliser une librairie JSON en production, par exemple : #https//www.nuget.org/packages/Newtonsoft.Json/ Dim parameters As String = String.Format( "{{""apiKey"":""{0}"",""phoneNumbers"":""{1}""}}", apiKey, "+33XXXXXXXXX") Console.Write(parameters) apiRequest("POST", url, parameters) 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 24 25 26 27 28 29 30 |
# 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 add_stop(self,phone_numbers): data = OrderedDict([ ("apiKey", API_KEY), ("phoneNumbers", phone_numbers) ]) url = URL + "/stop-sms/add" r = requests.post(url, data=json.dumps(data), verify=False) 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 POST -d '{"apiKey":"xxxxx","phoneNumber":"xxxx"}' https://api.smspartner.fr/v1/stop-sms/add |
Respuestas
1 2 3 4 5 |
{ "success": true, "code":200 "stopId": 300 } |
1 2 3 4 5 6 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>1</entry> <entry>24</entry> </result> |
Errores
Ejemplo mensaje de error :
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>false</entry> <entry>10</entry> <entry> <![CDATA[Clé API incorrecte]]> </entry> </result |
Código de control
Respuesta | ||
---|---|---|
1 | Se requiere la clave de la API | |
2 | Se requiere número de teléfono | |
3 | El número ya está en la lista | |
9 | El número de teléfono no es válido | |
10 | Clave de API no válida | |
200 | ¡Todo paso bien! |