Listar o inventário de números adquiridos

Liste os registos de números adquiridos cujo proprietário armazenado corresponde à conta representada pelas suas credenciais de API. A presença de um registo é distinta de um teste bem-sucedido de chamada real.

Pedido

Utilize credenciais de API do lado do servidor através de HTTPS. Os exemplos leem as credenciais a partir de variáveis de ambiente; não contêm credenciais funcionais. Verifique status.code no corpo JSON, bem como o estado HTTP. Estes processadores legados nem sempre definem um estado de erro HTTP quando ocorre um erro da aplicação.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

Para filtrar por um único número de telefone armazenado, utilize a forma opcional do caminho:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

Utilize o número de telefone internacional armazenado em formato numérico, incluindo o indicativo do país. Não forneça uma extensão de PBX, um UUID de número, um ID de área ou um ID de prefixo em seu lugar. O número fornecido seleciona um registo existente; não adquire nem configura um número.

Resposta

O membro response é sempre um array em caso de sucesso, incluindo na forma do caminho para um único número. status.results é o comprimento do array.

Esta estrutura de resposta é ilustrativa; não contém dados de uma conta nem constitui uma cotação de preços atual.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}

Campos dos números devolvidos
Campo	Significado
`number, uuid, description, isocode`	O número de telefone armazenado, o identificador opaco do número, a descrição e o código do país.
`config`	Campos armazenados de destinos de voz, reencaminhamento externo, destino de SMS e reencaminhamento de SMS. Este endpoint não os altera.
`features`	Indicadores armazenados de capacidades de voz, SMS e MMS. Não há garantia de que os indicadores legados armazenados sejam valores booleanos JSON.
`status.capacity`	Valores dos canais atribuídos e utilizados, configuração de transbordo e tarifa por excedente armazenada. Estes são metadados armazenados, não uma nova cotação de capacidade nem um teste de chamada real.
`status.origination`	Metadados de originação armazenados. Trate os identificadores como opacos; não derive lógica da aplicação a partir de nomes internos.
`status.service_active, force_codec, force_dtmf`	Campos armazenados de ativação e configuração de média. Um indicador, por si só, não comprova a entrega bem-sucedida de chamadas recebidas.
`billing`	Valores armazenados de CNAM, transbordo, renovação, persistência e criação. A sua consulta não altera a renovação nem outras configurações de faturação.
`price`	Preços armazenados de instalação, mensais e por minuto, e franquias de minutos. O processador não fornece um campo de moeda nem uma nova cotação. Não deduza a moeda a partir dos valores de exemplo nem os utilize como cotação atual de compra.

Filtragem e paginação

Este processador não tem paginação, limite de tamanho de página nem ordem de classificação explícita. Devolve todos os registos não anulados selecionados pela sua consulta. Não implementa um filtro que inclua apenas serviços ativos nem uma vista separada de números arquivados. Não pressuponha que a ordem dos registos devolvidos é estável.

Nenhum número correspondente

Se a conta não tiver registos não anulados correspondentes, o corpo JSON apresenta status.code 404 e uma mensagem que contém no numbers found. Não devolve um array vazio com indicação de sucesso. A mensagem inclui um sufixo de referência ao código-fonte que os clientes não devem interpretar como um identificador estável.

Próximos passos

Utilize numberinfo quando precisar dos campos legados adicionais de registo e de referência de um número. Verifique os destinos de voz e de mensagens antes de alterar qualquer rota através de uma operação de configuração separada.