Programadores

GET/v3/countries

Listar os países do catálogo (formato legado)

Recurso legado que devolve os países visíveis associados ao catálogo de números especiais utilizado por GET /v3/other/{isocode}, num corpo com a estrutura {code, data}. Não verifica as existências. Utilize GET /v3/getcountries para encontrar países com números disponíveis.

Nesta página
  1. Pedido
  2. Resposta
  3. Erros
  4. Disponibilidade e efeitos secundários

Este recurso legado devolve um corpo com a estrutura {"code", "data"} em vez da estrutura envolvente padrão status/response. Lista os países visíveis associados ao catálogo de números especiais e não verifica as existências.

Para novas integrações:

  • Utilize GET /v3/getcountries para encontrar países com números disponíveis.
  • Utilize GET /v3/other/{isocode} para consultar os tipos de números especiais efetivamente oferecidos num país. Mesmo que um país esteja listado aqui, a consulta do seu catálogo através desse recurso pode devolver um catálogo vazio.

Pedido

É necessária autenticação HTTP Basic ou um token Bearer (consulte Autenticação e respostas da API). Se a autenticação falhar, é devolvido HTTP 401 na estrutura envolvente padrão antes de a consulta ser executada.

GET sem parâmetros nem corpo.

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

Resposta

Corpo legado sem a estrutura envolvente padrão: {code: 200, data: [...]}. Não existe nenhum objeto status nem campos msg ou results. data lista os países sem garantir qualquer ordem. Campos: countrycode (indicativo telefónico sem '+'), name, description (com o mesmo valor de name), isocode, latitude e longitude. Não existem campos is_mobile, sms_coverage ou next_function. Um país é listado quando está visível e associado ao catálogo de números especiais. As existências não são verificadas, pelo que um país listado pode não ter números disponíveis no momento. Se nenhum país cumprir as condições, data é null.

Estrutura de resposta ilustrativa; não contém dados de uma conta em tempo real nem uma cotação atual.

{
  "code": 200,
  "data": [
    {
      "countrycode": "33",
      "name": "France",
      "description": "France",
      "isocode": "FR",
      "latitude": "46.0000",
      "longitude": "2.0000"
    }
  ]
}

Erros

  • 401: Autenticação em falta ou falhada. Enviado com HTTP status 401 na estrutura envolvente padrão status/response, não no corpo legado.

Disponibilidade e efeitos secundários

  • Apenas consulta. Não reserva números, não faz encomendas nem altera nada.