POST
https://api.octopush.com/v1/public/contact/mnp-requestCodificación : UTF-8
Autentificación
Los identificadores “api-key” y “api-login” deben añadirse en las cabeceras.
Definición
Permite comprobar si una línea telefónica se ha portado a otro operador.
Parametros
Nombre | Tipo | Descripción |
---|---|---|
phone_numbers | string[] | Números de teléfono en formato internacional +XXZZZZZ :[ "+33611223344", "+33611223345", ... ] |
Ejemplo Curl
curl -X POST \ 'https://api.octopush.com/v1/public/contact/mnp-request' \ -H 'Content-Type: application/json' \ -H 'api-login: ******@email.org' \ -H 'api-key: ************' \ -H 'cache-control: no-cache' \ -d ' { "phone_numbers": [ "+33611223344", "+33611223345" ] }'
Copiar y pegar el código
curl -X POST 'https://api.octopush.com/v1/public/contact/mnp-request' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"phone_numbers": ["+33611223344", "+33611223345"]}'
Respuesta Servidor en JSON
Éxito : 200 CREATED
[ { "network_name":"sfr", "mcc":"208", "mnc":"10", "country_name":"France", "country_code_iso3":"FRA", "country_code":"FR", "country_prefix":"33", "area":"France", "phone_number":"+33611223344", "is_ported":false, "ported_date":null, "line_status":"live", "original_network_details": { "network_name":"sfr", "mcc":"208", "mnc":"08", "country_name":"France", "country_code_iso3":"FRA", "country_code":"FR", "country_prefix":"33" } }, { "network_name":"sfr", "mcc":"208", "mnc":"10", "country_name":"France", "country_code_iso3":"FRA", "country_code":"FR", "country_prefix":"33", "area":"France", "phone_number":"+33611223345", "is_ported":true, "ported_date":'2020-12-03T00:00:00Z', "line_status":"live", "original_network_details": { "network_name":"sfr", "mcc":"208", "mnc":"08", "country_name":"France", "country_code_iso3":"FRA", "country_code":"FR", "country_prefix":"33" } }, ]
Error : 400 BAD REQUEST
{ "code": 400, "message": "Payload validation error.", "errors": { "phone_numbers": { "code": 410, "message": "This value should not be blank." } } }
Limitaciones
De 1 a 200 números por solicitud.
Returned parameters
Campo | Tipo | Descripción |
---|---|---|
network_name | string | Nombre de la red |
mnc | interger | Código de red |
mcc | integer | Código de país de la red |
status | string | ¿El número es válido o no? |
country_name | string | Nombre del país del número de teléfono. |
country_code_iso3 | string | Código de país del número de teléfono (3 letras) |
country_code | string | Código de país del número de teléfono (2 letras). |
area | string | Zona geográfica de la línea móvil. |
country_prefix | string | Prefijo del número. |
phone_number | string | Número de teléfono formateado. |
phone_number_type | string | Tipo de teléfono. Los posibles valores y definiciones se describen en el diccionario.Type of the phone. Possible values and definitions are described in the dictionary. |
line_status | string | Estado de la línea, dependiendo de la última fecha de sincronización con la red, si la línea existe y tiene un propietario. |
is_ported | boolean | Indica si el número ha sido portado o no de la red original a la red actual. |
ported_date | string | Fecha en la que se ha portado el número. Formato AAAA-MM-DD HH:II:SS |
original_network_details | string | Información sobre la red original. Contendrá network_name, mcc, mnc, country_name, country_code_iso3, country_code, area, country_prefix |
Return dictionary
Valor | Definiciones |
---|---|
status | |
valid | La línea tiene un dueño. |
invalid | La línea no tiene dueño. |
operator_is_not_available | Imposible de conseguir la información. |
unknown | Estado desconocido. |
line_status | |
live | Este número de teléfono está vivo y se asigna a un abonado que ha utilizado su teléfono recientemente. |
dead | La red telefónica ha confirmado que este número de teléfono es un número muerto y no recibirá llamadas ni mensajes de texto porque el número de teléfono no está asignado a una tarjeta SIM o a un usuario existente. |
absent_subscriber | Este número de teléfono se asigna a una tarjeta SIM móvil, pero: Ha habido un período prolongado de inactividad del teléfono móvil; El teléfono móvil se ha apagado, o ha salido de la cobertura de radio, y alguien ha intentado llamar o enviar un SMS al número de teléfono; El número está asignado a una nueva tarjeta SIM y ésta aún no ha sido registrada a un usuario. |
no_teleservice_provisioned | El número de teléfono se asigna a una tarjeta SIM que no puede hacer ni recibir llamadas. Suele ser una “SIM de solo datos”. |
not_available_network_only | La red telefónica propietaria del número de teléfono no proporciona el estado de tipo Vivo/Muerto, pero proporcionará información de portabilidad si el número de teléfono ha sido portado a otra red. |
no_coverage | Actualmente no tenemos cobertura para detectar el estado de vida de esta red telefónica. |
not_applicable | Se utiliza si no hay un número de teléfono detectado. |
inconclusive | Actualmente no hemos podido averiguar la situación de este número. |
phone_type | |
bad_format | el número que presentó para ser comprobado no pudo ser identificado como un número de teléfono internacional válido. |
mobile | un número de teléfono asignado a un operador de telefonía móvil / celular. |
landline | un teléfono fijo con cable en un lugar fijo como la casa o la oficina. |
mobile_or_landline | donde el número de teléfono puede pertenecer a un teléfono de tipo móvil o fijo. |
toll_free | también llamado teléfono gratuito. se puede llamar a este número desde el país de origen sin coste alguno. puede haber un cargo por llamar a este número desde fuera del país de origen. |
premium | se añade un recargo para llamar a este número, a menudo hay un servicio prestado en el número y al llamar al número el usuario paga por el servicio utilizando su factura telefónica. el que llama suele recibir ingresos por la llamada. |
shared_cost | este número de teléfono cobrará al mismo tiempo a la persona que llama y a la que recibe la llamada. se cobrará un cargo adicional por llamar a este tipo de número. |
voip | asignado a un proveedor de voip que entrega las llamadas y los mensajes de texto a través de Internet al usuario final o al servicio. |
stage_and_screen | reservado por un organismo regulador específicamente para su uso en el escenario y la pantalla, por ejemplo, utilizado en las películas cuando se habla de un número de teléfono. no se asignará ningún usuario final real a este número y a menudo se utilizan como números ficticios. |
pager | asignado a un dispositivo que recibe y muestra mensajes numéricos o alfanuméricos. |
universal_access_number | un único número de teléfono que puede utilizarse para dirigir las llamadas a múltiples destinos en función de parámetros como la hora del día, el lugar de residencia de la persona que llama, la capacidad o más. no está vinculado a ninguna localidad específica dentro del país. normalmente lo utilizan las empresas para proporcionar un único número de teléfono en lugar de varios. |
personal_number | un número de teléfono destinado a ser utilizado por particulares que puede dirigirse a varios lugares (casa, oficina y teléfono móvil. algunos números personales se cobran a una tarifa de número premium. |
voicemail_only | número de acceso sólo para el buzón de voz. |
unknown | Cualquier número que no entre en ninguna de las categorías anteriores. |