Desarrolladores

GET/v3/inventory/{number}

Consultar el inventario de números adquiridos

Consulte la configuración y el estado almacenados de los números adquiridos, con la opción de filtrar por número de teléfono.

En esta página
  1. Solicitud
  2. Respuesta
  3. Filtrado y paginación
  4. No hay números coincidentes
  5. Próximos pasos

Obtenga la lista de registros de números adquiridos cuyo propietario almacenado coincide con la cuenta representada por sus credenciales de API. La presencia de un registro no equivale a una prueba satisfactoria de llamada real.

Solicitud

Utilice credenciales de API del lado del servidor a través de HTTPS. Los ejemplos leen las credenciales de variables de entorno; no contienen credenciales válidas. Compruebe status.code en el cuerpo JSON, además del estado HTTP. Estos manejadores heredados no siempre establecen un estado de error HTTP cuando se produce un error de la aplicación.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

Para filtrar por un único número de teléfono almacenado, utilice la variante opcional de la ruta:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

Utilice el número de teléfono internacional almacenado expresado en dígitos, incluido el código de país. No proporcione en su lugar una extensión de PBX, un UUID de número, un ID de área ni un ID de prefijo. El número proporcionado selecciona un registro existente; no compra ni configura un número.

Respuesta

El miembro response siempre es una matriz cuando la solicitud se completa correctamente, incluso con la variante de la ruta para un solo número. status.results es la longitud de la matriz.

Esta estructura de respuesta es ilustrativa; no contiene datos de una cuenta ni constituye una cotización de precios vigente.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}
Campos de los números devueltos
CampoSignificado
number, uuid, description, isocodeEl número de teléfono almacenado, el identificador opaco del número, la descripción y el código de país.
configCampos almacenados de destinos de voz, desvío externo, destino de SMS y reenvío de SMS. Este punto de acceso no los modifica.
featuresIndicadores almacenados de las capacidades de voz, SMS y MMS. No se garantiza que los indicadores heredados almacenados sean valores booleanos de JSON.
status.capacityValores de canales asignados y utilizados, configuración de desbordamiento y cargo almacenado por exceso de uso. Se trata de metadatos almacenados, no de una cotización actualizada de capacidad ni de una prueba de llamada real.
status.originationMetadatos almacenados de originación. Trate los identificadores como opacos; no derive la lógica de la aplicación de los nombres internos.
status.service_active, force_codec, force_dtmfCampos almacenados de activación y configuración de medios. Un indicador por sí solo no demuestra que las llamadas entrantes se entreguen correctamente.
billingValores almacenados de CNAM, desbordamiento, renovación, persistencia y creación. Su lectura no cambia la renovación ni otros ajustes de facturación.
pricePrecios almacenados de alta, mensuales y por minuto, y asignaciones de minutos. El manejador no proporciona ningún campo de moneda ni una cotización actualizada. No deduzca la moneda a partir de los valores del ejemplo ni los utilice como una cotización de compra vigente.

Filtrado y paginación

Este manejador no tiene paginación, límite de tamaño de página ni orden de clasificación explícito. Devuelve todos los registros no anulados seleccionados por su consulta. No implementa un filtro que incluya únicamente números con el servicio activo ni una vista separada de números archivados. No dé por hecho que el orden de los registros devueltos sea estable.

No hay números coincidentes

Si la cuenta no tiene registros no anulados que coincidan, el cuerpo JSON contiene status.code 404 y un mensaje que contiene no numbers found. No devuelve una matriz vacía como respuesta satisfactoria. El mensaje incluye un sufijo de referencia al código fuente que los clientes no deben interpretar como un identificador estable.

Próximos pasos

Utilice numberinfo cuando necesite los campos heredados adicionales de registro y de referencia del número para un solo número. Revise los destinos de voz y mensajería antes de cambiar cualquier ruta mediante una operación de configuración independiente.