Desarrolladores

GET/v3/lnp/project/{uniqueid}/status

Consultar el estado de un proyecto de portabilidad

Consulte el resumen del proyecto y los recuentos por estado sin recuperar credenciales de facturación.

En esta página
  1. Acceso a la cuenta y al proyecto
  2. Solicitud
  3. Respuesta
  4. Un resumen no representa el resultado de todos los números
  5. Interpretar el estado de portabilidad
  6. Errores y límites
  7. Efectos

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 obtenido en el flujo de solicitud de portabilidad, no su identificador numérico de base de datos ni un número de teléfono. Al crear una solicitud, codifique el identificador del proyecto para su uso en una URL.

Solicitud

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

Este punto de acceso no lee ningún cuerpo de solicitud, parámetro de paginación ni filtro de fecha.

Respuesta

Ejemplo de respuesta ficticio.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

El campo externo status.code indica el resultado de la API. El campo independiente response.status es el resumen de portabilidad calculado a partir de los estados del proyecto. No confunda ambos campos.

Un resumen no representa el resultado de todos los números

El resumen selecciona In Progress si algún número tiene ese estado; en caso contrario, selecciona Pending, después Completed y, por último, Rejected, según el primer estado presente en ese orden. Si no coincide ningún estado conocido, utiliza Pending de forma predeterminada. Por lo tanto, un proyecto que contiene tanto números con la portabilidad completada como números rechazados indica Completed aunque siga teniendo números rechazados.

Revise siempre los recuentos y la lista de números individuales antes de decidir que todo el proyecto ha finalizado. counts.total incluye todas las filas de números del proyecto; los demás contadores abarcan únicamente los cuatro valores de estado conocidos y su suma puede no coincidir con el total si existen otros valores. Un proyecto sin números indica cero en todos los contadores y un resumen Pending.

Interpretar el estado de portabilidad

Valores conocidos del estado de los números
ValorEtiqueta
0Pending
1In Progress
2Completed
9Rejected

Conserve el estado numérico y permita valores desconocidos. Para las etiquetas desconocidas se utiliza el valor almacenado, sin garantizar una nueva etiqueta. Un estado de finalización o una fecha programada almacenados no comprueban por sí solos el enrutamiento entrante ni todos los servicios del número.

Errores y límites

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

Efectos

Este punto de acceso lee los recuentos almacenados del proyecto. En el controlador revisado, no envía solicitudes de transferencia, cambia estados, inicia llamadas ni realiza cargos en la cuenta. No ofrece consultas al operador en tiempo real ni suscripciones a notificaciones mediante webhooks.