Programadores

GET/v3/getcountries

Listar países com números em estoque

Retorna os países visíveis que atualmente têm pelo menos um prefixo de números em estoque. Cada entrada inclui o código de chamada, o código ISO, indicadores de telefonia móvel e SMS no nível do país, coordenadas e um link next_function para as áreas de cobertura do país.

Nesta página
  1. Requisição
  2. Resposta
  3. Erros
  4. Disponibilidade e efeitos colaterais

Comece aqui a busca por números locais. A lista contém apenas países que atualmente têm números em estoque. Esta consulta não faz nenhuma reserva.

  • Passe isocode para getareas, para getstates (apenas US e CA) ou para other.
  • next_function sempre aponta para v3/getareas/{isocode}. Para os Estados Unidos e o Canadá, você pode chamar getstates primeiro para restringir a busca por estado ou província.
  • is_mobile e sms_coverage são indicadores no nível do país, não garantias para cada número. Para os Estados Unidos, is_mobile é 0 a menos que sua conta esteja habilitada para números móveis dos Estados Unidos.
  • Países cuja cobertura está disponível apenas sob encomenda não são listados. Ainda assim, você pode chamar getareas ou other diretamente para um país que não esteja listado.
  • Ordene a lista por conta própria se precisar de uma ordem específica.

Se nenhum país atender aos critérios, response é null e status.code é 200.

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 da execução da consulta.

GET sem corpo. O único parâmetro é pid, opcional, enviado na cadeia de consulta da URL.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Parâmetros de consulta
NomeTipoObrigatórioDescrição
pidstringNãoAvançado e opcional. Restringe a lista aos países marcados para uma determinada fonte de estoque. Use apenas um valor fornecido pela MultiTEL, em formato numérico ou hexadecimal de 32 caracteres, e omita-o no uso normal. pid não restringe a verificação de estoque descrita na resposta. Valores não reconhecidos, zero e valores que este endpoint não aceita são ignorados sem gerar erro; nesse caso, a lista abrange todas as fontes compatíveis.

Resposta

Estrutura padrão da resposta. Em caso de sucesso, status.code é 200, status.msg é 'Results: N', status.results é N e response é uma lista de países sem ordem garantida. Campos: countrycode (código de chamada do país sem '+'); name (nome do país); description (mesmo valor de name); isocode (código ISO 3166-1 alfa-2); is_mobile (0 ou 1, um indicador do catálogo no nível do país, sempre 0 para US, a menos que sua conta esteja habilitada para números móveis de US); sms_coverage (0 ou 1, um indicador do catálogo no nível do país); latitude e longitude (coordenadas do país); next_function ('v3/getareas/{isocode}'). Um país só é listado se estiver visível e pelo menos um de seus prefixos tiver estoque atualmente em alguma fonte de estoque. Países cuja cobertura está inteiramente disponível apenas sob encomenda (sem estoque) não são listados. Esta verificação de estoque é mais abrangente do que os filtros aplicados por getareas, portanto um país listado pode ocasionalmente retornar 'No areas found' nessa consulta. Se nenhum país atender aos critérios, status.code é 200, status.msg é 'Results: 0', o campo status.results não está presente e response é null.

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

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

Erros

  • 401: Autenticação ausente ou malsucedida. Enviado com status HTTP 401 (consulte Autenticação e respostas da API).

Disponibilidade e efeitos colaterais

  • Apenas consulta. Não faz reservas, não faz pedidos nem altera nada.
  • Os resultados refletem o estoque no momento da requisição e podem mudar entre chamadas.