Accueil » API SMS Octopush » HRL Lookup – Vérification de numéro

HRL Lookup – Vérification de numéro

POST
https://api.octopush.com/v1/public/contact/hlr-request

Encodage : UTF-8

Authentification

La api-key et le api-login doivent être ajoutés dans un header.

Définition

Permet de vérifier la validité d’une ligne téléphonique.

Paramètres

NomTypeDescription
phone_numbersstring[]Numéros de téléphone au format international +XXZZZZZ :
[
  "+123123", 
  "+132323",
  ...
]
simulation_modeboolean(optionnel) Si ce champ est à “true”, votre requête sera simulée, et vous recevrez un faux résultat. Seulement quelques validations seront effectuées.

Exemples Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/contact/hlr-request' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '
{
  "phone_numbers": [
    "+33611223344",
    "+33611223345",
    "+33611223346"
  ]
}'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/contact/hlr-request' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"phone_numbers": ["+33611223344", "+33611223345", "+33611223346"]}'

Retour Server en json

Succes : 200 OK

[{
  "phone_number": "+33611223344",
  "is_valid": true,
  "country_code": "FR",
  "mnc": 1,
  "mcc": "FR"
},
{
  "phone_number": "+33611223345",
  "is_valid": false,
  "country_code": null,
  "mnc": null,
  "mcc": null
},
{
  "phone_number": "+33611223346",
  "is_valid": true,
  "country_code": "FR",
  "mnc": 1,
  "mcc": "FR"
}]

Echec : 400 BAD REQUEST

{
  "code": 400,
  "message": "Payload validation error.",
  "errors": {
    "phone_number": {
      "code": 410,
      "message": "This value should not be blank."
    }
  }
}

Limitations particulières

1 à 200 numéros par requêtes.