Desarrolladores

GET/v3/get_document_number_types/{country}

Listar los tipos de número para el registro

Consulte los nombres de los tipos de número que figuran actualmente en el catálogo de registro de un país.

En esta página
  1. Elija un tipo por el nombre devuelto
  2. Los recuentos de grupos no representan el inventario de números
  3. Solicitud
  4. Respuesta
  5. Errores
  6. Disponibilidad y efectos secundarios

Elija un tipo por el nombre devuelto

Utilice un país de get_document_countries. Pase el nombre del tipo devuelto a get_requirements. El ID de un tipo en el catálogo no es un ID de prefijo, de número ni de categoría de justificante.

Los recuentos de grupos no representan el inventario de números

available_groups cuenta los registros de grupos devueltos por esta consulta del catálogo. No cuenta los números de teléfono que se pueden comprar, no reserva existencias ni garantiza que el catálogo haya recorrido todas las páginas del sistema de origen. Busque en el inventario de números correspondiente y revise una cotización por separado.

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.

GET con cualquier parámetro documentado en la ruta de la URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Parámetros de ruta
NombreTipoObligatorioDescripción
countrystringSíCódigo ISO de país de dos letras del catálogo de países para el registro. Se eliminan los espacios en blanco iniciales y finales y se convierte a mayúsculas.

Respuesta

Compruebe status.code en el cuerpo JSON, además del estado HTTP. response es un arreglo que contiene id, name y available_groups. Utilice name como number_type al llamar a get_requirements; no envíe id en su lugar. available_groups es el número de registros de grupos devueltos para ese tipo, no un recuento de existencias de números de teléfono ni un total completo de todas las páginas. Se omiten los tipos para los que no se devuelven grupos. El orden preferido es Local, Mobile, National, Toll Free, Shared Cost, Global, seguido de otros nombres del catálogo.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Errores

  • 400: country is required: proporcione el código ISO del país para el registro.
  • 400: Invalid country ISO or no available DID registration country found: seleccione un país del catálogo de registro actual; esto no demuestra que no se requieran documentos.

Disponibilidad y efectos secundarios

  • Esta consulta del catálogo o de los requisitos no crea una identidad, no carga un justificante, no registra un número ni realiza un pedido.
  • Una respuesta satisfactoria del catálogo no supone la aprobación de sus documentos ni confirma que se pueda activar un número seleccionado.