Send a Verification

This request is used to send an HLR verification.

URL

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

Limit of 360 requests per minute. If you exceed this limit, you will receive an HTTP 429 response.

Required Parameters

Name	Value
apiKey	Your API key
phoneNumbers	Mobile numbers to verify. Must be in international format (+336xxxxxxxx). For multiple numbers, separate them with commas. Max: 500 numbers per request.

Optional Parameters

Name	Value
tag	String of up to 20 characters.
notifyUrl	Allows you to receive the HLR result via a POST request to a custom URL. Example of HLR request notification below.
_format	json or xml

Requests

PHP

<?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;
?>

VB.net

Python

cURL

Response

json

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

xml

Errors

json

{
    "success": false,
    "code": 10,
    "message": "Clé API incorrecte"
}

xml

Error Codes

Code	Message
1	API key is required
2	Phone number is required
3	Numbers must be separated by commas
10	Invalid API key
200	Everything went fine!

HLR Notification Example

Array(
    'phone' => '[phone]',
    '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'
)

HLR Error Codes

Error	Error Name	Description
0	NO_ERROR	No error.
1	EC_UNKNOWN_SUBSCRIBER	The number doesn't exist or is not assigned to any active user in the operator's database.
5	EC_UNIDENTIFIED_SUBSCRIBER	Subscriber not identified.
6	EC_ABSENT_SUBSCRIBER_SM	Subscriber unreachable — likely due to phone being turned off or in a poor signal area.
7	EC_UNKNOWN_EQUIPMENT	The device was not recognized by the Equipment Identity Register (EIR).
8	EC_ROAMING_NOT_ALLOWED	The subscriber is roaming and roaming delivery is not guaranteed due to lack of inter-operator agreements.
9	EC_ILLEGAL_SUBSCRIBER	Illegal subscriber.
12	EC_ILLEGAL_EQUIPMENT	Illegal equipment.
13	EC_CALL_BARRED	Subscriber is on DND (Do Not Disturb) and does not receive service traffic.
27	EC_ABSENT_SUBSCRIBER	Subscriber is offline — often due to the phone being off.
255	EC_UNKNOWN_ERROR	Unknown error.