开发者

GET/v3/fax_file/{type}/{id}

下载收件箱或发件箱中的传真

通过收件箱哈希值获取已接收的传真,或通过 UUID 获取较早的外发文档,并处理返回的文件格式。

本页
  1. 选择接收或外发文档
  2. 下载已接收的传真
  3. 下载外发传真
  4. 分别处理字节数据和错误
  5. 隐私与可用性

选择接收或外发文档

此兼容端点用于获取属于您账户的传真文档。请通过 HTTPS 使用已启用的 MultiTEL API 账户,并遵循该账户配置的凭据要求和 IP 限制。此端点不会发送或重新发送传真。

下载路径参数
参数必填含义
type是请使用 inbound 或 outbound,写法必须与此处完全一致。
id是对于 inbound,请使用 fax_inbox 返回的 hash。对于 outbound,请使用 fax_outbox 返回的 uuid。

这些值应放在路径中。路由为 /v3/fax_file/{type}/{id},而不是在 fax_download 后添加额外路径段。接收传真的哈希值既不是数字形式的记录标识符,也不是外发任务标识符。请从相应的邮箱列表中复制该标识符;它不能替代身份验证。

下载已接收的传真

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

示例哈希值代表虚构的收件箱记录 12。请从以下接口获取您自己的值:fax_inbox。下载现有接收记录时,该记录会被标记为已查看。这一步发生在检查文件是否可用之前,因此即使出现文件不可用错误,viewed 仍可能已设为 true。如果希望保持其查看状态不变,请勿仅为探测某份已接收的传真是否存在而使用此端点。

处理程序优先使用已存储的 PDF。否则,它会使用已存储的 TIFF,并在转换器可用时尝试转换为 PDF。如果无法进行转换,或转换引发了已被捕获处理的异常,则改为返回 TIFF。请始终检查返回的 Content-Type,不要直接假定返回的是 PDF。

下载外发传真

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

请使用以下接口返回的 uuid:fax_outbox。此兼容下载功能优先使用已存储的 PDF 二进制大对象,其次是 TIFF 二进制大对象,然后是可用的 PDF 文件、TIFF 文件或原始源文件。其优先顺序不同于当前用于外发传真的 fax_download 处理程序。对于使用以下接口的新集成:send_fax,请采用上述当前下载流程,并使用其 job_id 参数。

原始源文件可能以 application/octet-stream 返回,而不是 PDF 或 TIFF。附件文件名可能保留源文件的扩展名。此兼容外发下载功能不会将收件箱记录标记为已查看,不会更改任务状态,也不会创建传输。

分别处理字节数据和错误

成功时会返回文档的原始字节,并附带 Content-Type、指示附件的 Content-Disposition 和 Content-Length 响应头。返回内容不是封装在 JSON 中的 Base64 数据。请按示例分别保存响应头和字节数据,检查响应类型,然后再为文件指定合适的名称或进行处理。源文件扩展名在允许范围内,并不保证文档有效或已完成转换。

API 代码 400 表示缺少必填的路径值,或 type 无效。API 代码 404 表示该账户范围内的记录或其文件不可用。错误采用常规的 JSON status/response 封装,并且可能使用 HTTP 200。请检查响应的 Content-Type 以及 JSON 中的 status.code,以免将错误响应正文作为文档打开。

隐私与可用性

传真内容可能包含敏感信息。请仅将下载的文件保存在您的预期收件人能够访问的位置,并避免在日志中记录文档的完整字节数据。邮箱中存在记录,并不保证其文件会一直可用。目前尚未确定文件保留期限,也未确立对所有历史存储文档的兼容性保证。