POST
https://api.octopush.com/v1/public/contact/hlr-requestCodificación : UTF-8
Autentificación
Su “api-key” y “api-login” deben ser añadidos en las cabeceras.
Definición
Este servicio permite comprobar la validez de un número telefónico.
Parámetros especiales
| Campo | Tipo | Descripción |
|---|---|---|
phone_numbers | string[] | Números de teléfono en formato internacional +XXZZZZZ :[ "+123123", "+132323", ... ] |
simulation_mode | boolean | (opcional) Si este campo está configurado como “true”, su consulta será simulada y recibirá un resultado falso. Sólo se realizarán algunas validaciones. |
Ejemplo Curl
curl -X POST \
'https://api.octopush.com/v1/public/contact/hlr-request' \
-H 'Content-Type: application/json' \
-H 'api-key: ************' \
-H 'api-login: ******@email.org' \
-H 'cache-control: no-cache' \
-d '
{
"phone_numbers": [
"+33611223344",
"+33611223345",
"+33611223346"
}'Respuesta Servidor en JSON
Éxito : 200 Creado
[{
"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"
}]Error : 400 BAD REQUEST
{
"code": 400,
"message": "Payload validation error.",
"errors": {
"phone_number": {
"code": 410,
"message": "This value should not be blank."
}
}
}Limitaciones específicas
1 a 200 números por request.