Consultar los tipos de números especiales y sus precios para un país

Los números locales se consultan con getcountries y getareas. Para los números nacionales, gratuitos, de coste compartido, globales y móviles, invoque other con el código ISO del país.

• Los grupos aparecen en un orden fijo y se omiten los que no tienen entradas.
• Cada entrada incluye los planes de precios de su cuenta en prices. Elija un plan según sus valores de channels, monthly_price, setup_price, per_minute y free_minutes, y conserve su price_id para realizar pedidos cuando el endpoint correspondiente lo solicite.
• Si needs_registration tiene un valor que se evalúa como verdadero, lea restrictions antes de realizar un pedido. Trate ese texto como contenido no confiable destinado a su visualización.
• Siga next_function: v3/getnumbers/{uuid} permite elegir un número concreto, y v3/order/{uuid} realiza un pedido directamente a partir de la entrada.
• Una lista vacía en response con el código 200 significa que no se encontraron tipos de números especiales en el momento de la solicitud. Si el catálogo no estaba accesible temporalmente, la respuesta puede estar incompleta o no ser JSON válido, por lo que debe volver a intentarlo más tarde.
• Los países que no figuran en el catálogo devuelven el código 404 sin un estado HTTP correspondiente. Compruebe siempre status.code.

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 con isocode en la ruta. Si se omite el segmento de la ruta, se lee en su lugar un campo isocode codificado como formulario.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Respuesta

Estructura contenedora estándar. Si la operación se realiza correctamente, status.code es 200, status.msg está vacío y status.results es el número de grupos. response es una lista de grupos. Campos de cada grupo: group_key (clave de tipo normalizada: national, tollfree, sharedcost, global, mobile u otra clave alfanumérica en minúsculas); group_name (nombre para mostrar); group_type_uuid (identificador opaco del tipo); items. Los grupos se ordenan así: national, tollfree, sharedcost, global, mobile y, a continuación, las demás claves ordenadas por group_name. Se omiten los grupos sin items, así como el tipo local. Para US, se omite el grupo de móviles a menos que su cuenta esté habilitada para números móviles de US. Los elementos se ordenan por name (sin distinguir entre mayúsculas y minúsculas) y, después, por prefix. Campos de cada elemento: uuid (identificador opaco de la entrada utilizado en next_function); area_uuid (identificador opaco del grupo del catálogo); country_uuid (identificador opaco del país); prefix (prefijo completo que comienza con '+' y el código telefónico del país); name (nombre en el catálogo; las comillas pueden aparecer escapadas con una barra inversa); metered, overflow y needs_registration (indicadores que pueden ser de tipo boolean o number; interprete como sí cualquier valor que se evalúe como verdadero); restrictions (vacío cuando no se requiere registro; en caso contrario, texto de los requisitos que puede incluir saltos de línea HTML y un enlace, comillas al principio y al final y caracteres escapados; trátelo como texto no confiable destinado a su visualización); state (para US, CA y PR, un código de estado o una lista vacía cuando no se conoce ninguno; para los demás países, el código ISO del país); country_iso; is_mobile (1 en el grupo de móviles y 0 en los demás casos); number_type (igual que group_key); available (recuento de tipo integer indicado por el catálogo para la entrada; 0 cuando no se indica); sms_coverage (1 si alguna característica menciona SMS o MMS); returns_numbers (1 cuando se pueden listar números concretos); next_function ('v3/getnumbers/{uuid}' cuando returns_numbers es 1 y 'v3/order/{uuid}' en los demás casos); prices; features (lista de cadenas que describen las capacidades); group_key; group_type_uuid. Cada entrada de prices contiene price_id (identificador opaco del plan), is_customer_custom (true cuando se aplican precios personalizados para su cuenta; solo para planes sin canales incluidos), per_minute y free_minutes (cadenas con valores decimales), setup_price y monthly_price (cadenas con dos decimales), y channels (cantidad de canales incluidos, de tipo integer). Se omiten las entradas que no tienen ningún plan de precios. Se consideran como máximo 1000 entradas del catálogo por tipo de número en cada solicitud. Si ningún tipo tiene entradas, response es una lista vacía con status.results igual a 0. Si falla la consulta en tiempo real al catálogo, es posible que la respuesta no utilice esta estructura contenedora o que falten grupos.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Errores

• 500: msg 'ISO Code parameter is required': falta isocode o está en blanco. Se trata de un error de la solicitud que puede corregirse. No se establece un estado HTTP correspondiente.
• 404: msg 'Error: no such country': el país es desconocido o no está vinculado al catálogo de números especiales. No se establece un estado HTTP correspondiente.
• 401: falta la autenticación o ha fallado. Se envía con el estado HTTP 401.

Disponibilidad y efectos secundarios

• No realiza ningún pedido. En el código de este endpoint no aparece ningún paso de cobro.
• Actualiza los detalles del catálogo y las cotizaciones de precios de su cuenta, y sustituye las cotizaciones anteriores de los mismos planes. El uso de estas cotizaciones por parte de los endpoints de pedidos se documenta por separado.
• Los precios son específicos de su cuenta y pueden incluir tarifas personalizadas. La respuesta no indica ninguna moneda.
• Realiza consultas al catálogo en tiempo real, por lo que puede ser más lento que otras llamadas de consulta de números disponibles. Los resultados pueden cambiar entre llamadas.