Listar los prefijos de un área

Antes de empezar

Elija un área mediante getareas. Copie el ID del área de la respuesta o del valor devuelto en next_function. Para un área de Estados Unidos o Canadá, utilice getstates si desea limitar los resultados a un estado o provincia.

Interpretar el resultado

Compruebe status.code en el cuerpo JSON, además del estado HTTP. Los resultados correctos se encuentran en el array response. La respuesta predeterminada está ordenada por nombre. available es una estimación, y los indicadores del catálogo no sustituyen la comprobación de las capacidades reales y los requisitos de registro del número seleccionado.

Seleccionar el siguiente paso

Utilice un resultado sin agrupar. Cuando returns_numbers es 1, el valor devuelto en next_function apunta a una búsqueda de números. Cuando es 0, los números se asignan al realizar el pedido y la ruta apunta a una operación de pedido. Examine la operación y sus requisitos antes de enviar la solicitud: una solicitud de pedido puede generar cargos en su cuenta. No envíe automáticamente solicitudes a todas las rutas devueltas.

Aquí no se incluye ningún precio. Revise la cotización correspondiente, los documentos necesarios y las instrucciones de pedido antes de comprar. Conserve los ID devueltos del prefijo individual y de la cotización, en lugar de construirlos a partir de un prefijo telefónico mostrado.

Opciones avanzadas de visualización

compact=1 devuelve una muestra en orden aleatorio de un máximo de 100 filas, no una página de un conjunto de resultados más amplio. La agrupación crea filas de resumen e ID sintéticos; utilice una respuesta normal sin agrupar para seleccionar un prefijo individual. No utilice resultados de muestras o agrupados para afirmar que el inventario es exhaustivo o que las capacidades son exactas.

Solicitud

Utilice las credenciales de su cuenta de API habilitada a través de HTTPS. Se admiten la autenticación Basic y los tokens bearer de cuentas de API habilitadas; se aplican las restricciones de la cuenta.

Utilice GET y envíe los parámetros opcionales en la cadena de consulta. No dependa del uso del cuerpo de formulario como alternativa.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Respuesta

La estructura JSON estándar de status/response. status.results cuenta las filas devueltas, incluidas las obtenidas mediante muestreo o agrupación. response contiene objetos de prefijo. No se devuelven campos de precios. En la respuesta normal sin agrupar, uuid es el ID del prefijo; area_uuid y country_uuid son identificadores devueltos; prefix y name son información para mostrar; available es una estimación de disponibilidad, no una reserva; needs_registration y restrictions describen la información de registro; sms_coverage, is_mobile y number_type son indicaciones del catálogo, no una garantía de que un número concreto tenga una determinada capacidad. number_type puede estar vacío o contener otra cadena del catálogo, por lo que no debe exigir una enumeración fija. state es una cadena y puede estar vacía o contener formato del catálogo. latitude y longitude pueden estar vacíos. metered y overflow son indicadores del catálogo, no importes monetarios. returns_numbers selecciona una ruta para listar números (1) o una ruta de asignación al realizar el pedido (0). next_function identifica esa siguiente ruta. Las respuestas agrupadas también contienen características combinadas, incluidos valores alternativos de características; no los interprete como capacidades verificadas de todos los números.

Estructura de respuesta a modo de ejemplo; no son datos de la cuenta en tiempo real ni una cotización vigente.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Errores

• 404: Invalid area ID: obtenga un ID de área vigente mediante las consultas de catálogo.
• 404: State filter is only available for US and CA: omita state para otros países.
• 404: Invalid state: utilice un estado o provincia devuelto por getstates para este país.
• 404: No prefixes found: no se devolvieron filas del catálogo que coincidieran. Esto no demuestra que un número concreto no pueda pedirse nunca.
• 500: Error: 'Failed loading prefixes': la consulta del catálogo ha fallado. Vuelva a intentarlo más tarde y póngase en contacto con el servicio de asistencia si el error persiste.

Disponibilidad y efectos secundarios

• Este es un paso de consulta del catálogo, no una confirmación de pedido. La disponibilidad puede actualizarse mediante consultas adicionales al catálogo, por lo que el tiempo de respuesta puede variar.
• No se devuelven precios. Obtenga la cotización aplicable al número o al pedido y revise los requisitos de registro antes de realizar un pedido.
• No interprete available como un recuento exacto de existencias, ni el valor cero como una prohibición universal de realizar pedidos, ni una consulta correcta como una reserva. La disponibilidad puede cambiar antes de realizar el pedido.