Listar tipos de números para registo

Escolha um tipo pelo nome devolvido

Utilize um país de get_document_countries. Passe o nome do tipo devolvido a get_requirements. Um ID de tipo no catálogo não é um ID de prefixo, de número ou de categoria de comprovativo.

As contagens de grupos não representam o inventário de números

available_groups conta os registos de grupos devolvidos por esta consulta ao catálogo. Não conta números de telefone disponíveis para compra, não reserva números nem garante que o catálogo tenha percorrido todas as páginas da fonte a montante. Pesquise o inventário de números relevante e analise um orçamento separadamente.

Pedido

Utilize as credenciais da sua conta de API habilitada através de HTTPS. São suportados a autenticação Basic e os tokens bearer habilitados da conta de API; aplicam-se as restrições da conta.

GET com qualquer parâmetro documentado no caminho do URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"

Resposta

Verifique status.code no corpo JSON, bem como o estado HTTP. response é um array que contém id, name e available_groups. Utilize name como number_type ao chamar get_requirements; não envie id em seu lugar. available_groups é o número de registos de grupos devolvidos para esse tipo, não uma contagem de números de telefone em stock nem um total completo de todas as páginas. Os tipos sem grupos devolvidos são omitidos. A ordem preferencial é Local, Mobile, National, Toll Free, Shared Cost, Global, seguida dos outros nomes do catálogo.

Estrutura de resposta ilustrativa; não representa dados da conta em tempo real nem um orçamento atual.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Erros

• 400: country is required: forneça o código ISO do país para registo.
• 400: Invalid country ISO or no available DID registration country found: selecione um país do catálogo de registo atual; isto não significa que não sejam necessários documentos.

Disponibilidade e efeitos secundários

• Esta consulta ao catálogo ou aos requisitos não cria uma identidade, não carrega um comprovativo, não regista um número nem efetua uma encomenda.
• Uma resposta bem-sucedida do catálogo não constitui aprovação dos seus documentos nem confirmação de que um número selecionado pode ser ativado.