Envoyer une vérification
- Home
- Envoyer une vérification
Check the validity of a number
This feature verifies that a mobile number actually exists.
URLs
POST https://api.smspartner.fr/v1/hlr/notify
Settings
Each API request supports the following parameters :
| apiKey | API key from your account. You get it in your SMS Partner account |
|---|---|
| phoneNumbers | mobile numbers to check. They must be in international format (+ 336xxxxxxxx). To send multiple checks the numbers must be separated by commas. 500 numbers can be checked by request. |
| Optional settings | |
| notifyUrl | NotifyURL Retrieves the result of the HLR query to a URL of your choice. The result is sent by POST.
|
| _format | Response format. You can choose between JSON or XML. By default, the response format is JSON. |
Request
Sample query :
|
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 |
Replies
|
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> |
Errors
Error message Example :
|
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> |
Control code
| Reply | ||
|---|---|---|
| 1 | The API Key is required | |
| 2 | The phone number is required | |
| 3 | The numbers must be separated by commas | |
| 10 | Invalid API key | |
| 200 | Everything went well ! | |
Example of notification of a HLR query
|
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' ) |
Error codes HLR
| errorGrpId | errorName | |
|---|---|---|
| 0 | NO_ERROR No mistake. |
|
| 1 | EC_UNKNOWN_SUBSCRIBER The number does not exist or has not been assigned to any active subscriber in the operator’s user database. |
|
| 5 | EC_UNIDENTIFIED_SUBSCRIBER Unidentified subscriber. |
|
| 6 | EC_ABSENT_SUBSCRIBER_SM Since there was no response, the subscriber was detected as unavailable. This is often due to the handset being turned off or in a low signal area. |
|
| 7 | EC_UNKNOWN_EQUIPMENT The mobile device was not recognized by Equipment Identity Register (EIR) when verifying the device at the MAP protocol level on the carrier infrastructure. |
|
| 8 | EC_ROAMING_NOT_ALLOWED The subscriber is currently roaming in another country or using another carrier’s infrastructure – roaming delivery is not guaranteed due to the absence of roaming agreements between many different operators. |
|
| 9 | EC_ILLEGAL_SUBSCRIBER Illegal subscriber. |
|
| 12 | EC_ILLEGAL_EQUIPMENT Illegal equipment. |
|
| 13 | EC_CALL_BARRED The subscriber is configured on the Do Not Disturb service and receives no service traffic to his number. |
|
| 27 | EC_ABSENT_SUBSCRIBER The subscriber is offline. This is often due to the fact that the handset is turned off. |
|
| 255 | EC_UNKNOWN_ERROR Unknown error. |
|