简介
Advanced Integrated Visibility 追踪号码订阅专为 Advanced Integrated Visibility 订阅用户设计,用于管理其 基于追踪号码的 Webhook 项目,并使用 API 端点执行项目相关操作,例如添加新的追踪号码、编辑或查看工作详细信息。
注意:
- 您必须拥有 Advanced Integrated Visibility 项目的管理员或贡献者访问权限
- 有关 Advanced Integrated Visibility 及其功能的更多信息,请访问 Advanced Integrated Visibility 说明文件页面。
Advanced Integrated Visibility 查询号码订阅的优势
Advanced Integrated Visibility 查询号码订阅的优势如下:
- 您可以使用 API 端点轻松更新和管理 Advanced Integrated Visibility 项目的查询号码。
- 此 API 使您能够在单个 API 交易中将多个查询号码关联到您的项目,而不是逐个关联每个查询号码。
- 您可以连续提交 API 请求,并查看这些请求成功/失败的日志详细信息。
Advanced Integrated Visibility 查询号码订阅的工作原理
使用以下端点管理您的 Advanced Integrated Visibility 项目:
此 API 只能通过您的项目概览访问,如上图所示。
查询号码关联
使用此端点触发异步工作,将一个或多个查询号码关联到特定的 Advanced Integrated Visibility 项目。
此请求的所需输入信息如下:
- 操作 – 指定提交请求时要执行的操作。示例:ADD
- 查询号码详情 – 指定查询号码
您可以在单个请求中最多关联 1000 个查询号码。此请求的成功响应将返回 jobID、当前工作状态以及工作创建和工作完成时间戳。此 jobId 稍后可用于检查异步工作的状态。
查询号码工作状态
使用此端点获取异步工作(队列中的一个或多个连续请求)的状态或已提交的所有工作的状态。
此请求的所需输入信息如下:
- 工作 ID – 指定您要检索状态的工作 ID。
注意:工作 ID 是此端点的可选输入。如果您不指定工作 ID,那么您将获得所有已提交工作的状态。
此请求的成功响应将返回 jobID、当前工作状态以及工作创建和工作完成时间戳。响应将显示工作的当前状态。此外,响应还将包含成功消息、错误或警告,以便用户查看并在适用情况下进行故障排除。
- 如果工作状态显示为 COMPLETED,则表示所有查询号码均已成功验证并处理。
- COMPLETED 状态表示查询号码已成功验证并处理。这并不表示所有查询号码都已成功添加到 Advanced Integrated Visibility 项目中。
- 如果您尝试关联多个查询号码,但只有一些关联成功,其余的关联失败,那么工作状态也将更新为 COMPLETED。要确认关联请求中每个查询号码的状态,必须下载批量报告。
- 如果工作状态显示为 FAILED,则表示由于各种原因/硬故障,无法处理请求,用户必须再次重试。
注意:
以下是状态及其各自的描述:
| 工作状态 | 描述 |
|---|---|
已提交 |
工作在经过所有基本验证后提交给系统,它将被异步处理。 |
已接受 |
工作已被接受并将排入队列等待处理。 |
未接受 |
由于内部故障或系统不可用,工作未被接受,需要用户重试。 |
排入队列 |
工作排入队列等待处理,处理将随时开始。 |
正在处理 |
工作已开始并且处于进行中状态。 |
已完成 |
工作已完成,导入报告或导出文件可供用户下载。 |
已失败 |
工作由于各种原因失败,用户必须重试。 |
查询号码工作详情
使用此端点可下载处于已完成状态的异步工作的 JSON 报告。
与此请求关联的所需输入信息如下:
- 工作 ID – 指定您要检索状态的工作 ID。
注意:
- 使用此端点必须输入工作 ID。
- 一次只能下载一个异步工作的报告。
- 如果工作尚未完成并且您尝试下载报告,则会显示一条错误消息。
此请求的成功响应将以 JSON 格式向您提供工作的报告。
业务规则
- 每个请求中最多可以将 1,000 个托运查询号码与 Advanced Integrated Visibility 项目关联。
- 给定 Advanced Integrated Visibility 项目可关联的查询号码数量没有上限。
- 任何关联的查询号码将在 40 天后与给定的 Advanced Integrated Visibility 项目解除关联。
- 对于给定的 Advanced Integrated Visibility 项目,任何创建的工作 ID 状态和详细信息将在 90 天后不可用。
- 受保护的查询信息(例如收件人地址、收件人签名)将无法通过 Advanced Integrated Visibility 查询号码订阅获得。
Response