列出已接收的传真
请使用已启用的 MultiTEL API 账户,通过 HTTPS 访问,并遵循该账户配置的凭据要求和 IP 限制。此端点列出属于已通过身份验证账户的已接收传真。它不会发送传真,也不会下载传真文档。
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| 参数 | 是否必填 | 含义 |
|---|---|---|
page | 否 | 页码,从 1 开始。默认值:1。 |
limit | 否 | 每页记录数。默认值:25;最大值:100。请使用正整数。 |
search | 否 | 搜索发送号码、接收传真号码和远端站点标识。开头和结尾的空格会被移除。是否区分大小写取决于数据库的排序规则。 |
date_from | 否 | 包含从服务器本地日期这一天开始时起收到的传真。请使用 YYYY-MM-DD 格式。 |
date_to | 否 | 包含截至服务器本地日期这一天结束时收到的传真。请使用 YYYY-MM-DD 格式。 |
日期范围包含起止边界,并按 API 服务器的日期解释方式处理,而非按请求指定的用户时区处理。无效的日期字符串可能被忽略,而不是被拒绝;请在发送前验证其有效性。未设置日期筛选条件时,处理程序不会施加默认日期范围。结果按接收时间排序,最新的在前。此端点不提供跨页的稳定快照:新收到的传真可能导致记录在页面之间移动。
读取收件箱分页结果
请读取 HTTP 结果以及 JSON 中的 status.code。API 其他部分发生故障时,即使 HTTP 状态为 200,也可能使用 JSON 错误封装返回结果。成功响应包含 response.faxes 和 response.pagination。此示例使用虚构值。
{
"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 是收件箱记录的数字标识。 hash 是该标识的 MD5 表示形式,用于旧版入站文档工作流程;它不是 send_fax 任务标识,也不是授权凭据。请勿将它用于出站 fax_status 端点。
received_timestamp 是已存储的 Unix 时间戳。 received_at 是由服务器格式化且不含时区偏移量的时间戳;如果未记录接收时间,则为 null。按您自己的时区显示时间时,请使用 Unix 值。 cost 是一个 JSON 数值,并非报价,也不能证明某笔单独的扣费已完成。
status 仅在存储的状态码为零时为 success;其他值均转换为 failed。 status_text 包含已存储的处理消息;没有该消息时,使用 OK 或 Failed 作为备用值。 emailed 保留已存储的值,而非转换为布尔值。 viewed 是布尔值。请勿仅凭传真状态推断邮件已成功送达。
处理空列表和不断变化的列表
空收件箱返回空的 faxes 数组,total 为 0,total_pages 为 0。请求超出最后一页的页码时,也可能返回空数组。请根据分页字段决定何时停止,不要假定至少有一页。接口不提供游标,也不提供按记录标识进行的次级排序。核对包含重复记录的分页结果时,请保留记录标识。
文档访问与隐私
收件箱条目包含私密的电话和文档元数据。请在应用程序中限制访问,并避免记录完整响应。列出条目不会将文档标记为已查看。请使用 fax_file 进行兼容模式的入站文档下载。请注意,即使文件不可用,它也会将现有入站记录标记为已查看。您也可以通过门户收件箱访问文档。目前尚未确立任何文件保留保证。