Подписка номера отслеживания Advanced Integrated Visibility предназначена для того, чтобы подписчики Advanced Integrated Visibility могли управлять своими проектами webhook на основе номера отслеживания и выполнять связанные с проектами операции, такие как добавление новых номеров отслеживания, редактирование или просмотр сведений о заданиях с помощью конечных точек API.

Примечание:

• У вас должен быть доступ администратора или участника к проекту Advanced Integrated Visibility.
• Дополнительную информацию об Advanced Integrated Visibility и связанных функциях см. на странице документации по Advanced Integrated Visibility.

Подписка номера отслеживания Advanced Integrated Visibility имеет следующие преимущества.

• Вы можете легко обновлять и управлять номерами отслеживания вашего проекта Advanced Integrated Visibility через конечные точки API.
• Этот API позволяет вам связать несколько номеров отслеживания с вашим проектом в одной транзакции API, вместо того чтобы связывать каждый номер отслеживания по отдельности.
• Вы можете отправлять запросы API последовательно и просматривать сведения о результатах этих запросов.

Указанные ниже конечные точки используются для управления проектом Advanced Integrated Visibility.

Доступ к этому API можно получить только через обзор проекта, как показано на снимке экрана выше.

Эта конечная точка используется, чтобы начать асинхронную задачу по привязке одного или нескольких номеров отслеживания к определенному проекту Advanced Integrated Visibility.

Для выполнения этого запроса требуются следующие исходные данные:

• Действие — укажите действие, которое будет выполнено при отправке запроса. Пример: ADD.
• Сведения о номере отслеживания — укажите номер отслеживания.

В одном запросе можно привязать не более 1000 номеров отслеживания. Успешный ответ на этот запрос вернет jobID, текущий статус задачи, а также временную метку ее создания и завершения. Идентификатор jobID можно использовать позже для проверки статуса асинхронной задачи.

Эта конечная точка используется для получения статуса асинхронной задачи (один или несколько последовательных запросов в очереди) или статуса всех отправленных задач.

Для выполнения этого запроса требуются следующие исходные данные:

• JobID — укажите jobID, для которого запрашиваете статус.

Примечание. Указывать jobID для этой конечной точки необязательно. Если jobID не указан, вы получите статусы всех отправленных задач.

Успешный ответ на этот запрос вернет jobID, текущий статус задачи, а также временную метку ее создания и завершения. В ответе будет указан текущий статус задач. Кроме того, он будет включать сообщения об успехе, ошибки и предупреждения для целей устранения неполадок.

• Если статус задачи отображается как COMPLETED (Выполнено), это означает, что все номера отслеживания были успешно проверены и обработаны.
  • Статус задачи COMPLETED означает, что номера отслеживания успешно проверены и обработаны. Это не означает, что все номера отслеживания были успешно добавлены в проект Advanced Integrated Visibility.
  • Если вы пытаетесь привязать несколько номеров отслеживания и только некоторые из них привязаны успешно, статус задачи все равно будет иметь значение COMPLETED. Чтобы подтвердить статус каждого номера отслеживания в соответствующем запросе, необходимо скачать пакетный отчет.

Примечание:

• Если статус задачи отображается как FAILED (Не выполнено), это означает, что из-за различных причин, включая серьезные сбои, запрос не может быть обработан, и пользователь должен повторить попытку.

Ниже приведены статусы и их описания.

Используйте эту конечную точку для загрузки отчета в формате JSON для асинхронной задачи, находящейся в состоянии COMPLETED (Выполнено).

С этим запросом связана следующая необходимая вводная информация:

• JobID — укажите jobID, для которого запрашиваете статус.

Примечание:

• Для этой конечной точки обязательно указывать jobID.
• Одновременно можно скачать отчет только по одной асинхронной задаче.
• Если вы пытаетесь загрузить отчет для задачи со статусом, отличным от COMPLETED (Выполнено), отображается сообщение об ошибке.

Успешный ответ на этот запрос предоставит отчет о задаче в формате JSON.

• В каждом запросе к проекту Advanced Integrated Visibility можно привязать не более 1000 номеров отслеживания.
• Максимальное суммарное количество номеров отслеживания, которые можно привязать к проекту Advanced Integrated Visibility, не ограничено.
• Привязанные номера отслеживания будут отключены от проекта Advanced Integrated Visibility по истечении 40 дней.
• Статусы созданных jobID и сведения о них в рамках проекта Advanced Integrated Visibility не будут доступны по истечении 90 дней.
• Защищенная информация об отслеживании, такая как адрес или подпись получателя, не будет доступна через подписку Advanced Integrated Visibility по номеру отслеживания.