Saltar al contenido

Iniciar Portabilidad

Descripción

Este método permite realizar una portabilidad a un número de teléfono de otra telefonía hacia AXIOS.


URL API

https://apidevstore.axiosmobile.mx

Parámetros de Entrada

Los parámetros que debes incluir en tu solicitud son los siguientes:

ParámetroTipoDescripciónEjemplo
phoneNumberstringNúmero telefónico a portar"6561234567"
PINstringCódigo NIP solicitado para autorizar la portabilidad"1234"
transitoryNumberstringNúmero telefónico temporal o transitorio"6561111111"
isActivationbooleanIndica si el número transitorio requiere activación previo a la portabilidadtrue

Ejemplo de Uso

Método: POST
Endpoint: {{API}}/external/portability/start
Headers: {{x-api-key}}

Body JSON

{
"phoneNumber": "6561234567",
"PIN": "1234",
"transitoryNumber": "6561111111",
"isActivation": true
}

Response Success

{
"error": false,
"message": "La solicitud de portabilidad ha sido enviada correctamente",
"data": {},
"results": 0
}

Parámetros de Salida

La respuesta de la API incluirá los siguientes parámetros:

ParámetroTipoDescripciónEjemplo
errorbooleanIndica si ocurrió un error durante la solicitudfalse
messagestringMensaje descriptivo del resultado de la operación"La solicitud de portabilidad ha sido enviada correctamente"
dataobjectContenedor de información adicional devuelta por la API{}
resultsnumberCantidad de resultados o registros obtenidos en la operación0

Estos son los parámetros que recibirás al realizar la solicitud. Asegúrate de manejar los datos correctamente en tu aplicación.