Listar tarefas de fax de saída

Listar tarefas de fax de saída

Use uma conta habilitada da API da MultiTEL por HTTPS, com as credenciais e restrições de IP configuradas para ela. Este ponto de acesso lista os registros de fax de saída pertencentes à conta autenticada. A consulta da lista não transmite nem reenvia um fax.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode search=0123456789abcdef0123456789abcdef \
  https://api.multitel.net/v3/fax_outbox

Este componente de processamento não aceita os filtros date_from ou date_to. A caixa de saída do portal tem filtros adicionais que não devem ser copiados para esta solicitação à API. Os resultados são ordenados pela data e hora de criação, dos mais recentes para os mais antigos, sem ordenação secundária por identificador nem cursor de instantâneo.

Consultar os registros das tarefas

Verifique tanto o resultado HTTP quanto, no documento JSON, o campo status.code. Uma resposta bem-sucedida contém response.faxes e response.pagination; o exemplo usa dados fictícios. Uma caixa vazia retorna uma matriz faxes vazia com total igual a 0 e total_pages igual a 0.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 13,
      "uuid": "0123456789abcdef0123456789abcdef",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "status": "queued",
      "pages_requested": 3,
      "pages_sent": 0,
      "cost": "0.07500",
      "result_text": "",
      "created_at": "2026-10-01 12:00:00",
      "sent_at": null,
      "updated_at": "2026-10-01 12:00:00"
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id é o identificador numérico do registro. uuid é o identificador visível da tarefa; use o identificador da tarefa retornado por send_fax para novos envios e guarde-o para realizar consultas periódicas de estado. A lista pode incluir registros antigos, portanto não presuma que todas as linhas foram criadas pelo mesmo ponto de acesso de envio.

status e result_text contêm o estado e a mensagem de processamento registrados. Esta listagem não os normaliza em uma enumeração completa de estados de entrega. Na fila significa na fila, não entregue. Para documentos críticos, confirme o recebimento com o destinatário antes de considerar o fax entregue ou enviar uma duplicata.

pages_requested e pages_sent são contagens numéricas. cost preserva o valor armazenado, usando como alternativa a cadeia de texto 0.00; não presuma que ele tenha o mesmo tipo JSON que o custo da caixa de entrada. Um registro na fila já pode conter uma estimativa. Nem esse valor nem uma entrada na lista determinam o faturamento final.

created_at, sent_at e updated_at são valores armazenados no formato do servidor, sem indicação de deslocamento de fuso horário; sent_at pode ser nulo. A lista omite o campo de estado do webhook retornado pelo ponto de acesso separado de consulta de estado.

Conciliar as páginas de resultados com segurança

Oriente-se por pagination.page, limit, total e total_pages. As páginas posteriores à última podem estar vazias. Novas tarefas podem deslocar entradas entre páginas enquanto você as consulta. Guarde os identificadores das tarefas ao combinar páginas; este ponto de acesso não garante um instantâneo estável.

Privacidade e novas tentativas

Os registros da caixa de saída contêm metadados telefônicos privados. Limite quem pode consultá-los e evite gravar respostas completas nos registros de atividade. A ausência de uma entrada na lista não prova que uma solicitação de envio falhou: verifique o identificador da tarefa que você guardou e a caixa de saída do portal antes de enviar a solicitação novamente. Um novo envio pode criar outro fax que poderá gerar cobrança. As garantias definitivas sobre o processamento em segundo plano, o faturamento, as notificações de retorno e a retenção de dados continuam em revisão.