Desarrolladores

GET/v3/getcountries

Listar países con números disponibles en inventario

Devuelve los países visibles que actualmente tienen al menos un prefijo con números disponibles en inventario. Cada entrada incluye el código de llamada, el código ISO, los indicadores de telefonía móvil y SMS a nivel de país, las coordenadas y un enlace next_function a las áreas de cobertura del país.

En esta página
  1. Solicitud
  2. Respuesta
  3. Errores
  4. Disponibilidad y efectos secundarios

Comience aquí la búsqueda de números locales. La lista contiene únicamente países que actualmente tienen números disponibles en inventario. No se realiza ninguna reserva.

  • Pase isocode a getareas, a getstates (solo US y CA) o a other.
  • next_function siempre apunta a v3/getareas/{isocode}. Para Estados Unidos y Canadá, puede llamar a getstates primero para restringir la búsqueda por estado o provincia.
  • is_mobile y sms_coverage son indicadores a nivel de país y no garantizan estas características para todos los números. Para Estados Unidos, is_mobile es 0 a menos que su cuenta esté habilitada para números móviles de Estados Unidos.
  • No se incluyen los países cuya cobertura está disponible exclusivamente bajo pedido. Aun así, puede llamar a getareas o other directamente para un país que no figure en la lista.
  • Ordene la lista por su cuenta si necesita un orden específico.

Si ningún país cumple los requisitos, response es null y status.code es 200.

Solicitud

Se requiere autenticación HTTP Basic o un token Bearer (consulte Autenticación y respuestas de la API). Si la autenticación falla, se responde con HTTP 401 antes de ejecutar la consulta.

GET sin cuerpo. El único parámetro es pid, que es opcional y se envía en la cadena de consulta.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Parámetros de consulta
NombreTipoObligatorioDescripción
pidstringNoParámetro avanzado y opcional. Restringe la lista a los países marcados para una fuente de inventario. Utilice únicamente un valor proporcionado por MultiTEL, en formato numérico o hexadecimal de 32 caracteres, y omítalo para el uso habitual. pid no restringe la comprobación de existencias descrita en la respuesta. Los valores no reconocidos, el cero y los valores que este endpoint no acepta se ignoran sin generar un error; en ese caso, la lista abarca todas las fuentes admitidas.

Respuesta

Estructura contenedora estándar. Si la solicitud se completa correctamente, status.code es 200, status.msg es 'Results: N', status.results es N y response es una lista de países sin un orden garantizado. Campos: countrycode (código de llamada del país sin '+'); name (nombre del país); description (el mismo valor que name); isocode (código ISO 3166-1 alfa-2); is_mobile (0 o 1, un indicador del catálogo a nivel de país, siempre 0 para US a menos que su cuenta esté habilitada para números móviles de US); sms_coverage (0 o 1, un indicador del catálogo a nivel de país); latitude y longitude (coordenadas del país); next_function ('v3/getareas/{isocode}'). Un país solo se incluye si es visible y al menos uno de sus prefijos tiene actualmente números disponibles en alguna fuente de inventario. No se incluyen los países cuya cobertura está disponible en su totalidad exclusivamente bajo pedido (sin existencias). Esta comprobación de existencias es más amplia que los filtros que aplica getareas, por lo que, en ocasiones, un país incluido en la lista puede devolver 'No areas found' al consultarlo allí. Si ningún país cumple los requisitos, status.code es 200, status.msg es 'Results: 0', no se incluye el campo status.results y response es null.

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: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Errores

  • 401: Falta la autenticación o esta ha fallado. Se envía con el código de estado HTTP 401 (consulte Autenticación y respuestas de la API).

Disponibilidad y efectos secundarios

  • Solo realiza una consulta. No reserva, no realiza pedidos ni modifica nada.
  • Los resultados reflejan las existencias en el momento de la solicitud y pueden cambiar entre llamadas.