Envie uma confirmação
- Home
- Envie uma confirmação
Verifique a validade de um número
Esse recurso permite que você verifique se um número de celular realmente existe.
URL
POST https://api.smspartner.fr/v1/hlr/notify
Configurações
Cada solicitação da API suporta os seguintes parâmetros:
apiKey | Cle API da sua conta. Você recebe na sua conta do SMS Partner |
---|---|
números de telefone | Números móveis para verificar. Devem estar no formato internacional (+ 351xxxxxxxxx). Para enviar várias verificações, os números devem ser separados por vírgulas. 500 números podem ser verificados por consulta. |
Parâmetros opcionais | |
notifyUrl | Permite recuperar o resultado da solicitação de HLR para uma URL de sua escolha.O resultado é enviado em POST .
|
_formato |
Formato da resposta. Você pode escolher entre
JSON ou XML . Por padrão, o formato de resposta é JSON . |
Aplicação
Exemplo de consulta:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?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; ?> |
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 59 |
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 |
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 |
# 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 |
1 |
curl -H "Content-Type: application/json" -X POST -d '{"apiKey":"xxxxx","phoneNumbers":"xxxx","notifyUrl":"http://..."}' https://api.smspartner.fr/v1/hlr/send |
Respostas
1 2 3 4 5 6 7 8 |
{ "success": true, "code": 200, "campaign_id": "HLR000000", "number": 1, "cost": 0.005, "currency": "EUR" } |
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<?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> |
Erros
Exemplo de uma mensagem de erro:
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 controle
Resposta | ||
---|---|---|
1 | A chave da API é obrigatória | |
2 | O número de telefone é obrigatório | |
3 | Os números devem ser separados por uma vírgula | |
10 | Chave de API incorreta | |
200 | Tudo correu bem!Exemple de notification d’une requête HLR |
1 2 3 4 5 6 7 8 9 10 |
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ódigos de erro HLR
número | tipo | |
---|---|---|
0 | NO_ERROR Nenhum erro. |
|
1 | EC_UNKNOWN_SUBSCRIBER O número não existe ou não foi atribuído a nenhum assinante ativo no banco de dados do usuário do operador. |
|
5 | EC_UNIDENTIFIED_SUBSCRIBER Assinante não identificado. |
|
6 | EC_ABSENT_SUBSCRIBER_SM Como não houve resposta, o assinante foi detectado como indisponível. Isso geralmente ocorre porque o aparelho está desligado ou em uma área com pouco sinal |
|
7 | EC_UNKNOWN_EQUIPMENT O dispositivo móvel não foi reconhecido pelo EIR (Equipment Identity Register) ao verificar o dispositivo no nível do protocolo MAP na infraestrutura da operadora |
|
8 | EC_ROAMING_NOT_ALLOWED O assinante está atualmente em roaming em outro país ou usando a infraestrutura de outra operadora – a entrega de roaming não é garantida devido à ausência de acordos de roaming entre muitos operadores diferentes |
|
9 | EC_ILLEGAL_SUBSCRIBER Assinante ilegal |
|
12 | EC_ILLEGAL_EQUIPMENT Assinante ilegal |
|
13 | EC_CALL_BARRED O assinante é configurado no serviço Não perturbe e não recebe tráfego de serviço para o seu número |
|
27 | EC_ABSENT_SUBSCRIBER O assinante está offline. Isto é geralmente devido ao fato de que o aparelho está desligado |
|
255 | EC_UNKNOWN_ERROR Erro desconhecido |