Listar faxes recebidos

Listar faxes recebidos

Use uma conta habilitada da API da MultiTEL por HTTPS, com suas credenciais e restrições de IP configuradas. Este ponto de acesso lista os faxes recebidos que pertencem à conta autenticada. Ele não envia faxes nem baixa seus documentos.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Os limites de data são inclusivos e usam a interpretação de datas do servidor da API, não um fuso horário solicitado pelo usuário. Strings de data inválidas podem ser ignoradas em vez de rejeitadas; valide-as antes do envio. Sem filtros de data, o processador não impõe nenhum intervalo de datas padrão. Os resultados são ordenados pelo horário de recebimento, com os mais recentes primeiro. O ponto de acesso não fornece um retrato estável entre as páginas: novas chegadas podem deslocar registros entre elas.

Consultar a página da caixa de entrada

Consulte o resultado HTTP e o campo status.code do conteúdo JSON. Falhas em outras partes da API podem usar uma estrutura de erro JSON mesmo quando o status HTTP é 200. Uma resposta bem-sucedida contém response.faxes e response.pagination. Este exemplo usa valores fictícios.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id é o identificador numérico do registro da caixa de entrada. hash é sua representação MD5 para o fluxo legado de documentos recebidos; não é um identificador de tarefa de send_fax nem uma credencial de autorização. Não o use com fax_status para consultar faxes enviados.

received_timestamp é a marca de tempo Unix armazenada. received_at é uma marca de tempo formatada pelo servidor, sem indicação de deslocamento de fuso horário, ou null se não houver horário de recebimento registrado; use o valor Unix ao exibir horários no seu próprio fuso horário. cost é um número JSON, não uma cotação de preço nem uma prova de que uma cobrança separada foi efetivada.

status é success somente quando o código de status armazenado é zero; outros valores se tornam failed. status_text contém a mensagem de processamento armazenada, com OK ou Failed como valor alternativo. emailed preserva o valor armazenado em vez de um valor booleano. viewed é um valor booleano. Não deduza que o e-mail foi entregue com sucesso apenas com base no status do fax.

Lidar com listas vazias e em constante mudança

Uma caixa de entrada vazia retorna um array faxes vazio, total com valor 0 e total_pages com valor 0. Uma página posterior à última também pode retornar um array vazio. Encerre a consulta de acordo com os campos de paginação, em vez de presumir que existe pelo menos uma página. Não é disponibilizado um cursor nem uma ordenação secundária pelo identificador do registro. Preserve os identificadores dos registros ao conciliar páginas com registros em comum.

Acesso aos documentos e privacidade

As entradas da caixa contêm metadados privados de telefonia e documentos. Restrinja o acesso no seu aplicativo e evite registrar respostas completas nos logs. A listagem não marca um documento como visualizado. Use fax_file para baixar documentos recebidos pelo mecanismo de compatibilidade; observe que ele marca um registro de entrada existente como visualizado mesmo que seu arquivo esteja indisponível. A caixa de entrada do portal também está disponível para acessar documentos. Nenhuma garantia de retenção de arquivos foi estabelecida.