Програмери

GET/tcr/v2/brand/{brandId}/externalVetting

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

Прочитајте резултате провере бренда са свог налога и пратите постојећу проверу кроз резултате на чекању, успешне или неуспешне резултате.

На овој страници
  1. Изаберите бренд који проверавате
  2. Пратите постојећу проверу
  3. Разумевање накнада за ранију наруџбину
  4. Поновите читање без слања нове наруџбине
  5. Раздвојите кораке регистрације
  6. Захтев
  7. Одговор
  8. Грешке
  9. Доступност и пратећи ефекти

Изаберите бренд који проверавате

Користите идентификатор бренда са свог налога. Чувајте га уз добијене записе о провери како се провера једног предузећа не би помешала са провером другог. Не користите идентификаторе другог налога.

Пратите постојећу проверу

Сачувајте 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 не представља одобрење кампање, доделу телефонског броја нити дозволу за слање порука.