Изберете марката, която проверявате
Използвайте идентификатора на марката от вашия акаунт. Съхранявайте го заедно с получените записи от проверката, за да не бъде объркана проверката на едно предприятие с тази на друго. Не използвайте идентификатори от друг акаунт.
Проследете съществуваща проверка
Запазете 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 не представлява одобрение на кампания, присвояване на телефонен номер или разрешение за изпращане на съобщения.