Desarrolladores

GET/v3/lnp/project/{uniqueid}

Consultar un proyecto de portabilidad

Consulte el proyecto, los números, el historial y los metadatos de los documentos en una sola respuesta privada de la cuenta.

En esta página
  1. Acceso a la cuenta y al proyecto
  2. Solicitud
  3. Trate esta respuesta como confidencial
  4. Estructura de la respuesta
  5. Interprete el resumen y los metadatos
  6. Errores y límites
  7. Efectos y flujo de trabajo

Acceso a la cuenta y al proyecto

Utilice una cuenta de API habilitada mediante HTTPS desde una dirección IP permitida. El proyecto debe pertenecer a esa cuenta y no debe estar eliminado. Utilice el identificador único del proyecto que figura en el flujo de solicitud de portabilidad, no su identificador numérico de la base de datos ni un número de teléfono. Aplique la codificación URL al identificador del proyecto al construir una solicitud.

Solicitud

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID"

Trate esta respuesta como confidencial

La respuesta completa incluye información de facturación del operador donante, incluido el valor almacenado de billing_pin, así como los datos de la cuenta de facturación, el teléfono, la dirección, la empresa y el contacto autorizado. La API no enmascara estos campos. Solicite únicamente el estado o la lista de números cuando eso sea todo lo que necesite su flujo de trabajo. No guarde la respuesta de detalle completa en el almacenamiento del navegador, los sistemas de análisis, los registros públicos ni las capturas de pantalla para soporte, y muestre únicamente los campos que necesite un cliente autorizado.

Estructura de la respuesta

Ejemplo ficticio con una selección de campos; la respuesta puede incluir campos adicionales.

{
  "status": {
    "code": 200,
    "msg": "Project Detail"
  },
  "response": {
    "project": {
      "id": 11,
      "uniqueid": "PROJECT_EXAMPLE",
      "project_name": "Example transfer",
      "location": "US",
      "status": 0,
      "status_str": "Pending"
    },
    "counts": {
      "total": 0,
      "pending": 0,
      "in_progress": 0,
      "completed": 0,
      "rejected": 0
    },
    "numbers": [],
    "events": [],
    "uploads": []
  }
}

Este ejemplo, deliberadamente parcial, omite todas las credenciales de facturación y los valores de los datos personales de contacto. Su omisión en el ejemplo no significa que la respuesta real los oculte.

Secciones del detalle del proyecto
SecciónContenido
projectIdentificador numérico de la fila, identificador único del proyecto, nombre del proyecto, ubicación, datos almacenados de facturación, contacto y dirección, hora de creación y estado derivado. El campo heredado del operador donante se escribe loosing_carrier.
countsTotal de filas de números y contadores de Pending, In Progress, Completed y Rejected.
numbersLa misma proyección de datos de los números que utiliza el punto de acceso de la lista de números del proyecto, incluidos los comentarios del cliente y los valores de programación almacenados.
eventsFilas de eventos almacenadas y campos de la carga útil sin procesar y analizada, sujetos a los límites de visibilidad y formato del punto de acceso de eventos.
uploadsMetadatos de los documentos: identificador numérico, upload_type, file_name, file_extension, date_created y un valor relativo de download_url. La URL sigue requiriendo autenticación de la cuenta.

Interprete el resumen y los metadatos

El estado derivado da prioridad a In Progress, después a Pending, luego a Completed y finalmente a Rejected, con Pending como valor predeterminado si no corresponde ninguno de los anteriores. Un resumen con el estado Completed puede coexistir con números rechazados. Revise los contadores y los estados de los números en lugar de suponer que se ha completado la portabilidad de todos ellos.

La respuesta contiene metadatos de los documentos, no los bytes de los archivos. No tiene paginación ni cursor incremental. Las consultas de detalle y de lista son lecturas independientes; no constituyen una única instantánea con coherencia transaccional garantizada. Las fechas conservan los valores almacenados, sin una conversión de zona horaria documentada. Utilice uniqueid para las rutas del proyecto; el identificador numérico del proyecto no es intercambiable con este valor.

Errores y límites

Compruebe tanto la respuesta HTTP como status.code/status.msg. Si el proyecto no existe, está eliminado o no pertenece a la cuenta, se devuelve el código 404 de la API con un mensaje que indica que no se ha encontrado el proyecto. También se aplican la autenticación y las restricciones de IP de origen. Los ejemplos no realizan ninguna solicitud real, y una respuesta satisfactoria no demuestra que un operador haya aceptado o completado una portabilidad.

Efectos y flujo de trabajo

Esta es la ruta canónica de detalle que utiliza la vista de solicitudes de portabilidad del portal actual. El portal asigna los campos a su interfaz de usuario y aplica su propia proyección de datos para el cliente; no suponga que la respuesta sin procesar de la API es idéntica al JSON del portal o a su presentación. El manejador de detalle revisado no modifica el proyecto ni inicia directamente una solicitud al operador o un cobro.