Programadores

GET/v3/lnp/project/{uniqueid}/numbers

Listar os números de um projeto de portabilidade

Consulte o estado armazenado de cada número, os comentários e as informações de transferência agendada.

Nesta página
  1. Acesso à conta e ao projeto
  2. Pedido
  3. Resposta
  4. Campos dos números
  5. Ordenação e acompanhamento
  6. Interpretar o estado da portabilidade
  7. Erros e limites
  8. Efeitos

Acesso à conta e ao projeto

Utilize uma conta API ativa através de HTTPS a partir de um endereço IP permitido. O projeto deve pertencer a essa conta e não pode estar eliminado. Utilize o identificador único do projeto proveniente do fluxo de pedidos de portabilidade, não o seu identificador numérico na base de dados nem um número de telefone. Aplique a codificação URL ao identificador do projeto ao criar um pedido.

Pedido

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/numbers"

Resposta

Exemplo fictício de resposta.

{
  "status": {
    "code": 200,
    "msg": "Project Numbers",
    "results": 1
  },
  "response": [
    {
      "id": 21,
      "number": "12025550123",
      "status": 0,
      "status_str": "Pending",
      "isocode": "US",
      "updated": "2026-10-23 12:00:00",
      "foc": "",
      "comment": "Example customer-visible note",
      "date_created": "2026-10-23 12:00:00",
      "date_completed": ""
    }
  ]
}

response é uma lista. Um projeto existente sem números devolve uma lista vazia com o código API 200 e um valor de status.results igual a 0. Por sua vez, os projetos inexistentes devolvem o código API 404.

Campos dos números

Campos dos números a portar
CampoSignificado
id, number, isocodeIdentificador numérico da linha, texto armazenado do número de telefone e código do país. O identificador da linha não é o identificador do projeto.
status, status_strEstado numérico e respetiva designação conhecida.
focValor de agendamento armazenado do compromisso firme do pedido. Pode estar vazio; o controlador não o converte para um fuso horário nem para um formato de carimbo de data/hora documentados.
updated, date_created, date_completedValores armazenados de atualização, criação e conclusão. Trate explicitamente os valores vazios; não pressuponha o formato ISO8601 nem deduza um fuso horário a partir do exemplo fictício.
commentComentário armazenado destinado ao cliente. Apresente-o como texto, não como HTML executável.

Esta representação omite o campo internal_comment reservado aos funcionários. Isto não significa que a consulta legada e separada de um único número utilize a mesma representação.

Ordenação e acompanhamento

A consulta ordena os resultados pela hora de criação, por ordem crescente. Não é garantida qualquer ordenação adicional para linhas com a mesma hora de criação. Não existe paginação, cursor incremental nem filtro de data. Leia a lista completa para reconciliar os dados de um projeto e não considere a sua contagem atual de linhas como um catálogo permanente.

Interpretar o estado da portabilidade

Valores conhecidos do estado dos números
ValorDesignação
0Pending
1In Progress
2Completed
9Rejected

Conserve o estado numérico e aceite valores desconhecidos. Quando a designação é desconhecida, utiliza-se o valor armazenado em vez de garantir uma nova designação. Um estado de conclusão armazenado ou uma data agendada não constituem, por si só, um teste ao encaminhamento de chamadas recebidas nem a todos os serviços do número.

Erros e limites

Verifique tanto a resposta HTTP como status.code/status.msg. Um projeto inexistente, eliminado ou que não pertence à conta devolve o código API 404 com uma mensagem de projeto não encontrado. Também se aplicam as restrições de autenticação e de IP de origem. Os exemplos não efetuam nenhum pedido real, e uma resposta bem-sucedida não prova que um operador tenha aceite ou concluído uma transferência.

Efeitos

O controlador revisto apenas lê o projeto e as linhas de números nele armazenadas. A resposta é um instantâneo, não uma confirmação do operador nem um teste real do serviço. Não inicia uma portabilidade, não altera o encaminhamento nem debita a conta.