Проверьте результаты проверки бренда

Выберите бренд, который хотите проверить

Используйте идентификатор бренда из своей учётной записи. Храните его вместе с полученными записями о проверке, чтобы не перепутать проверки разных компаний. Не используйте идентификаторы из другой учётной записи.

Отслеживайте уже начатую проверку

Сохраняйте значения vettingId, evpId, vettingClass и vettingStatus при их наличии. Текущий механизм синхронизации рассматривает PENDING и UNSCORE как результаты, ещё ожидающие дальнейшей проверки, а ACTIVE и FAILED — как окончательные результаты для расчёта платы. Прежде чем решать, нужны ли дальнейшие действия, изучите полученные сведения. Сам по себе пустой список не доказывает, что ранее отправленная заявка не дошла до реестра.

Разберитесь с платой за ранее оформленный заказ

Проверка статуса не оформляет заказ на повторную проверку. Однако она может сверить окончательный результат и выполнить расчёт платы за ранее заказанную платную проверку. Это включает плату за неуспешную проверку, если она предусмотрена условиями. Руководствуйтесь ценой и условиями, с которыми вы ознакомились при оформлении заказа; не определяйте текущую цену по старому примеру или ответу на запрос статуса.

Повторите чтение данных, не оформляя новый заказ

При временном сбое сохраните идентификатор бренда и известные идентификаторы проверок, соблюдайте Retry-After и повторите чтение данных с увеличением интервалов между попытками. Не оформляйте новый заказ на проверку только потому, что запрос статуса завершился сбоем или вернул неожиданное тело ответа. Если несоответствие сохраняется, обратитесь в MultiTEL через канал поддержки с аутентификацией и укажите соответствующие идентификаторы.

Рассматривайте этапы регистрации отдельно

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

Запрос

Используйте учётную запись с включённым доступом к API, подключаясь по HTTPS с разрешённого исходного IP-адреса. Используйте учётные данные своей учётной записи, а не данные для доступа к реестру. Бренд должен быть связан с учётной записью, прошедшей аутентификацию.

Запрос GET с идентификатором бренда в пути и обязательным фильтром vettingStatus в строке запроса. Рассмотренная схема определяет массив статусов; в этом примере запрашивается одно значение ACTIVE. Это руководство не устанавливает способ кодирования нескольких значений и не подтверждает, что провайдер принимает запросы без фильтра. Тело запроса не требуется.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"

Параметры пути
Имя	Тип	Обязательный	Описание
`brandId`	строка	Да	Идентификатор бренда в реестре, связанный с вашей учётной записью MultiTEL. Это не идентификатор учётной записи и не идентификатор проверки.

Параметры строки запроса
Имя	Тип	Обязательный	Описание
`vettingStatus`	массив строк	Да	Обязательный фильтр статуса. Допустимые значения: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. В примере передаётся одно значение ACTIVE; способ кодирования нескольких значений и приём провайдером запросов без фильтра не подтверждаются.

Ответ

Текущий маршрут сохраняет статус HTTP и тело ответа реестра, не используя устаревшую оболочку ответа v3. Сокращённый вымышленный массив показывает поля, используемые локальным механизмом синхронизации; это не записанный ответ реестра и не гарантированно полная схема. Перед чтением записей проверьте статус HTTP и JSON. Храните каждый vettingId вместе с выбранным брендом.

Пример структуры ответа; это не реальные данные учётной записи и не предложение с текущей ценой.

[
  {
    "vettingId": "example-vetting-id",
    "evpId": "example-review-provider",
    "vettingClass": "STANDARD",
    "vettingStatus": "ACTIVE"
  }
]

Ошибки

401: Не удалось выполнить аутентификацию учётной записи. Проверьте учётные данные, включён ли доступ к API, и действующие ограничения по исходному IP-адресу.
404: Бренд не связан с этой учётной записью либо реестр не смог его найти. Отказ из-за отсутствия принадлежности бренда учётной записи происходит до отправки запроса в реестр.
429: Достигнут лимит запросов для учётной записи или реестра. Соблюдайте Retry-After и увеличивайте интервалы между повторными попытками.
502/503: Недоступны транспортный уровень, реестр, механизм ограничения запросов или локальная обработка. Ошибка не доказывает, что ранее отправленная заявка на проверку завершилась неудачей.

Доступность и побочные эффекты

Этот запрос GET не оформляет новый заказ на проверку. Он получает результаты из реестра, записывает сведения о запросе в журнал аудита и синхронизирует сохранённые результаты.
Чтение окончательного результата может привести к расчёту платы за ранее заказанную платную проверку. За неуспешную проверку может взиматься плата, если она предусмотрена условиями. Ознакомьтесь с ценой и условиями при оформлении заказа; это чтение данных не является ценовым предложением.
Впервые обнаруженная запись, импортированная этим запросом GET, не классифицируется автоматически как новый платный заказ.
Успешный результат проверки или результат со статусом ACTIVE не означает одобрения кампании, назначения телефонного номера или разрешения на отправку сообщений.