Listar tipos de números especiais e preços de um país

Os números locais são encontrados com getcountries e getareas. Para números nacionais, gratuitos, de custo compartilhado, globais e móveis, chame other com o código ISO do país.

• Os grupos aparecem em uma ordem fixa, e os grupos sem entradas são omitidos.
• Cada entrada lista os planos de preços da sua conta em prices. Escolha um plano com base em seus valores de channels, monthly_price, setup_price, per_minute e free_minutes, e guarde seu price_id para fazer pedidos quando o endpoint de pedido o exigir.
• Se needs_registration tiver um valor avaliado como verdadeiro, leia restrictions antes de fazer um pedido. Trate esse texto como conteúdo de exibição não confiável.
• Siga next_function: v3/getnumbers/{uuid} permite escolher um número específico, e v3/order/{uuid} faz o pedido diretamente a partir da entrada.
• Uma lista vazia de response com o código 200 significa que nenhum tipo de número especial foi encontrado no momento da requisição. Se o catálogo estava temporariamente inacessível, a resposta pode estar incompleta ou não ser um JSON válido; nesse caso, tente novamente mais tarde.
• Países que não fazem parte do catálogo retornam o código 404 sem um status HTTP correspondente. Sempre verifique status.code.

Requisição

Obrigatório: autenticação HTTP Basic ou token Bearer (consulte Autenticação e respostas da API). Uma falha de autenticação recebe uma resposta HTTP 401 antes de a consulta ser executada.

GET com isocode no caminho. Se o segmento do caminho for omitido, será lido, em seu lugar, um campo isocode codificado como formulário.

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

Resposta

Estrutura padrão de resposta. Em caso de sucesso, status.code é 200, status.msg está vazio e status.results é o número de grupos. response é uma lista de grupos. Campos do grupo: group_key (chave normalizada do tipo: national, tollfree, sharedcost, global, mobile ou outra chave alfanumérica em minúsculas); group_name (nome de exibição); group_type_uuid (identificador opaco do tipo); items. Os grupos seguem a ordem national, tollfree, sharedcost, global, mobile e, em seguida, as demais chaves ordenadas por group_name. Os grupos sem items são omitidos, assim como o tipo local. Para US, o grupo de números móveis é omitido, a menos que sua conta esteja habilitada para números móveis de US. Os itens são ordenados por name (sem diferenciar maiúsculas de minúsculas) e, em seguida, por prefix. Campos do item: uuid (identificador opaco da entrada usado em next_function); area_uuid (identificador opaco do grupo do catálogo); country_uuid (identificador opaco do país); prefix (prefixo completo que começa com '+' e o código de chamada do país); name (nome no catálogo; os caracteres de aspas podem aparecer escapados com barra invertida); metered, overflow e needs_registration (indicadores que podem ser do tipo boolean ou number; trate qualquer valor avaliado como verdadeiro como sim); restrictions (vazio quando não é necessário registro; caso contrário, contém o texto dos requisitos, que pode incluir quebras de linha HTML e um link, aspas delimitadoras e caracteres escapados; trate-o como texto de exibição não confiável); state (para US, CA e PR, um código de estado ou uma lista vazia quando nenhum código é conhecido; para os demais países, o código ISO do país); country_iso; is_mobile (1 no grupo de números móveis; caso contrário, 0); number_type (igual a group_key); available (contagem do tipo integer informada pelo catálogo para a entrada, 0 quando não informada); sms_coverage (1 se alguma funcionalidade mencionar SMS ou MMS); returns_numbers (1 quando for possível listar números específicos); next_function ('v3/getnumbers/{uuid}' quando returns_numbers for 1; caso contrário, 'v3/order/{uuid}'); prices; features (lista de cadeias de caracteres que descrevem as funcionalidades); group_key; group_type_uuid. Cada entrada de prices tem price_id (identificador opaco do plano), is_customer_custom (true quando se aplicam preços personalizados à sua conta; apenas para planos sem canais incluídos), per_minute e free_minutes (cadeias de caracteres que representam valores decimais), setup_price e monthly_price (cadeias de caracteres com duas casas decimais) e channels (quantidade de canais incluídos, do tipo integer). As entradas sem nenhum plano de preços são omitidas. São consideradas, no máximo, 1000 entradas do catálogo por tipo de número em cada requisição. Se nenhum tipo tiver entradas, response será uma lista vazia com status.results igual a 0. Se a consulta em tempo real ao catálogo falhar, a resposta poderá não usar esta estrutura, ou alguns grupos poderão estar ausentes.

Estrutura de resposta ilustrativa; não representa dados da conta em tempo real nem uma cotação atual.

{
  "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"
        }
      ]
    }
  ]
}

Erros

• 500: msg 'ISO Code parameter is required': isocode está ausente ou em branco. Este é um erro de requisição que pode ser corrigido. Nenhum status HTTP correspondente é definido.
• 404: msg 'Error: no such country': o país é desconhecido ou não está vinculado ao catálogo de números especiais. Nenhum status HTTP correspondente é definido.
• 401: autenticação ausente ou com falha. Enviado com status HTTP 401.

Disponibilidade e efeitos colaterais

• Não faz um pedido. Nenhuma etapa de cobrança aparece no código deste endpoint.
• Atualiza os detalhes do catálogo e as cotações de preços da sua conta, substituindo as cotações anteriores dos mesmos planos. A forma como os endpoints de pedido usam essas cotações é documentada separadamente.
• Os preços são específicos da sua conta e podem incluir preços personalizados. A resposta não informa uma moeda.
• Executa consultas em tempo real ao catálogo, por isso pode ser mais lento do que outras chamadas de descoberta. Os resultados podem mudar entre chamadas.