开发者

GET/v3/fax_outbox

列出外发传真任务

读取您的外发传真记录并核对各页列表,无需再次提交发送请求。

本页
  1. 列出外发传真任务
  2. 读取任务记录
  3. 稳妥核对各页列表
  4. 隐私与重试

列出外发传真任务

请通过 HTTPS 使用已启用的 MultiTEL API 账户,并使用为该账户配置的凭据、遵守其 IP 限制。此端点列出属于已通过身份验证的账户的外发传真记录。获取列表不会发送或重新发送传真。

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
发件箱查询参数
参数是否必填含义
page否页码,从 1 开始。默认值:1。
limit否每页记录数。默认值:25;最大值:100。请使用正整数。
search否搜索发送号码、目标号码和任务 UUID。开头和结尾的空格会被移除。不会搜索状态或结果文本。

此处理程序不支持 date_from 或 date_to 筛选条件。门户发件箱另有一些筛选条件,不应将它们照搬到此 API 请求中。结果按创建时间从新到旧排列,不提供按标识符进行的次级排序,也不提供快照游标。

读取任务记录

请同时读取 HTTP 结果和 JSON 中的 status.code。成功响应包含 response.faxes 和 response.pagination;示例使用虚构数据。空邮箱会返回空的 faxes 数组,且 total 为 0,total_pages 为 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 是记录的数字标识符。uuid 是可见的任务标识符;对于新提交的任务,请使用以下端点返回的任务标识符:send_fax,并保留该标识符以便进行状态轮询。列表可能包含较早的记录,因此不要假定每一行都是通过同一个提交端点创建的。

status 和 result_text 包含已记录的处理状态和消息。此列表不会将它们规范化为完整的送达状态枚举。已排队仅表示正在排队,并不表示已送达。对于重要文档,在将传真视为已送达或提交重复传真之前,请向收件人确认是否收到。

pages_requested 和 pages_sent 均为数值型计数。cost 保留已存储的值,并以字符串 0.00 作为后备值;不要假定它与收件箱费用的 JSON 类型相同。已排队的记录中可能已经包含估算费用。该值和列表条目均不能作为最终计费的依据。

created_at、sent_at 和 updated_at 均为已存储的、采用服务器格式的值,不含时区偏移量;sent_at 可以为 null。单独的状态端点会返回网络钩子状态字段,而此列表不包含该字段。

稳妥核对各页列表

请依据 pagination.page、limit、total 和 total_pages 读取各页。超出最后一页的页面可能为空。浏览期间新增的任务可能导致条目在不同页面之间移动。合并各页数据时,请保留任务标识符;此端点不保证提供稳定快照。

隐私与重试

发件箱记录包含私密的电话元数据。请限制可读取这些记录的人员,并避免将完整响应写入日志。列表中缺少某条记录并不能证明发送请求已失败:重新提交前,请检查已保留的任务标识符和门户发件箱。再次发送可能创建另一份需要收费的传真。有关后台任务处理、计费、回调及数据保留的最终保证仍在审查中。