Verificar la validez de un numéro

Esta funcionalidad permite verificar que un número móvil existe realmente.

URL

POST https://api.smspartner.fr/v1/hlr/notify

Paramètres

Cada solicitud de API es compatible con los siguientes parámetros:

apiKey	Clave de API de su cuenta. Usted lo consigue en su compte SMS Partner
phoneNumbers	Números móviles a verificar. Tienen que estar en formato internacional (+336xxxxxxxx). Para el envío de varios números a verificar, los números tienen que estar separados por una coma. 500 números pueden ser verificados por cada solicitud.
Ajustes opcionales
notifyUrl	Permite recuperar el resultado de la solicitud HLR a través de un URL de su elección. El resultado es enviado en `POST`. Ejemplo de notificacion de una solicitud HLR
_format	Formato de la respuesta. Puede elegir entre `JSON` o `XML`. Por defecto, el formato de respuesta es `JSON`.

Solicitud

Ejemplo de solicitud:

<?php
        // Prepare data for POST request
        $fields = array(
            'apiKey'=> 'YOUR API KEY',
            'phoneNumbers'=> '+336xxxxxxxx',
            'notifyUrl'=>'http://...'
        );
 
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/hlr/notify');
        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;
?>

<?php

// Prepare data for POST request

$fields = array(

'apiKey'=> 'YOUR API KEY',

'phoneNumbers'=> '+336xxxxxxxx',

'notifyUrl'=>'http://...'

);

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/hlr/notify');

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;

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 & "hlr/notify"
    #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}"",""notifyUrl"":""{2}""}}",
        apiKey,
        "+33XXXXXXXXX",
        "http://...")
    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

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 & "hlr/notify"

#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}"",""notifyUrl"":""{2}""}}",

apiKey,

"+33XXXXXXXXX",

"http://...")

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

# 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,
			"notifyUrl", notify_url)
		])
 
		url = URL + "/hlr/notify"
		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

# 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,

"notifyUrl", notify_url)

])

url = URL + "/hlr/notify"

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

curl -H  "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","notifyUrl":"http://..."}' https://api.smspartner.fr/v1/hlr/send

1	curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","notifyUrl":"http://..."}' https://api.smspartner.fr/v1/hlr/send

{
    "success": true,
    "code": 200,
    "campaign_id": "HLR000000",
    "number": 1,
    "cost": 0.005,
    "currency": "EUR"
}

{

"success": true,

"code": 200,

"campaign_id": "HLR000000",

"number": 1,

"cost": 0.005,

"currency": "EUR"

}

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry>true</entry>
    <entry>200</entry>
    <entry>
        <![CDATA[HLR0000000]]>
    </entry>
    <entry>1</entry>
    <entry>0.005</entry>
    <entry>
        <![CDATA[EUR]]>
    </entry>
</result>

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

<entry>

<![CDATA[HLR0000000]]>

</entry>

<entry>

<![CDATA[EUR]]>

</entry>

</result>

Errores

Ejemplo de mensaje de error:

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>
        <![CDATA[Clé API incorrecte]]>
    </entry>
</result>

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

<entry>false</entry>

<entry>

<![CDATA[Clé API incorrecte]]>

</entry>

</result>

Código de control

	Respuesta
1	Se requiere la clave API
2	Se requiere el número de teléfono
3	Los números deben de estar separados por una com
10	Clave API incorrecta
200	¡Todo pasó bien!

Ejemplo de notificación de una solicitud HLR

Array(
    'phone' => '+3300000000',
    'messageId'=>'1234-12344-1234-1234',
    'mccMnc' => '20815',
    'ported'=> 1,
    'errorGrpId'=> 0,
    'errorName'=> 'NO_ERROR ',
    'errorDesc'=>'No Error' ,
    'date'=>'2018-03-05T10:34:52.355+0000'
)

Array(

'phone' => '+3300000000',

'messageId'=>'1234-12344-1234-1234',

'mccMnc' => '20815',

'ported'=> 1,

'errorGrpId'=> 0,

'errorName'=> 'NO_ERROR ',

'errorDesc'=>'No Error' ,

'date'=>'2018-03-05T10:34:52.355+0000'

)

Código de error HLR

errorGrpId	errorName
0	`NO_ERROR` No hay error
1	`EC_UNKNOWN_SUBSCRIBER`El número no existe o no está atribuido a ningún suscriptor activo en la base de datos del operador.
5	`EC_UNIDENTIFIED_SUBSCRIBER` Suscriptor no identificado.
6	`EC_ABSENT_SUBSCRIBER_SM`Como no hubo respuesta, el suscriptor se detectó como indisponible. Esto se debe a que el móvil está apagado o en una zona con mala señal.
7	`EC_UNKNOWN_EQUIPMENT`El dispositivo móvil no fue reconocido por EIR (Equipment Identity Register) durante la verificación del dispositivo en el nivel del protocolo MAP en la infraestructura del operador.
8	`EC_ROAMING_NOT_ALLOWED`El suscriptor se encuentra actualmente en otro país o utiliza la infraestructura de otro operador; la entrega no está garantizada debido a la falta de acuerdos entre muchos operadores diferentes.
9	`EC_ILLEGAL_SUBSCRIBER`Suscriptor ilegal
12	`EC_ILLEGAL_EQUIPMENT`Equipo ilegal
13	`EC_CALL_BARRED`El suscriptor está configurado en el servicio DND (No molestar) y no recibe ningún tráfico de servicio a su número.
27	`EC_ABSENT_SUBSCRIBER`El suscriptor está fuera de linea. Se debe normalmente a que el móvil está apagado.
255	`EC_UNKNOWN_ERROR`Error desconocido.

Enviar una verificación

Verificar la validez de un numéro

URL

POST https://api.smspartner.fr/v1/hlr/notify

Paramètres

Solicitud

Respuestas

Errores

Código de control

Ejemplo de notificación de una solicitud HLR

Código de error HLR