Vývojáři

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

Zkontrolujte výsledky prověření značky

Načtěte výsledky prověření značky ve svém účtu a sledujte již zahájené prověření od čekajícího stavu po úspěšný či neúspěšný výsledek.

Na této stránce
  1. Vyberte značku, kterou kontrolujete
  2. Sledujte již zahájené prověření
  3. Seznamte se s poplatky za dřívější objednávku
  4. Opakujte načtení bez odeslání další objednávky
  5. Provádějte jednotlivé kroky registrace odděleně
  6. Požadavek
  7. Odpověď
  8. Chyby
  9. Dostupnost a vedlejší účinky

Vyberte značku, kterou kontrolujete

Použijte identifikátor značky ze svého účtu. Uchovávejte jej společně s výslednými záznamy o prověření, aby nedošlo k záměně prověření jednoho podniku za prověření jiného. Nepoužívejte identifikátory z jiného účtu.

Sledujte již zahájené prověření

Uchovávejte hodnoty vettingId, evpId, vettingClass a vettingStatus, pokud jsou k dispozici. Současná synchronizace považuje stavy PENDING a UNSCORE za výsledky, které stále čekají na další kontrolu, a stavy ACTIVE a FAILED za konečné výsledky pro vyúčtování. Než se rozhodnete, zda jsou potřeba další kroky, přečtěte si vrácené podrobnosti. Samotný prázdný seznam nedokazuje, že předchozí podání nebylo doručeno do registru.

Seznamte se s poplatky za dřívější objednávku

Kontrola stavu neobjednává další prověření. Může však sladit dokončený výsledek s uloženými údaji a vyúčtovat poplatek spojený s dřívější zpoplatněnou žádostí o prověření. To zahrnuje i případný poplatek za neúspěšné prověření. Vycházejte z ceny a podmínek, se kterými jste se seznámili při objednání; dnešní cenu neodvozujte ze starého příkladu ani z odpovědi na dotaz na stav.

Opakujte načtení bez odeslání další objednávky

Při přechodné chybě si uchovejte identifikátor značky a známé identifikátory prověření, dodržujte Retry-After a opakujte toto načtení s postupně prodlužovanými intervaly mezi pokusy. Neodesílejte novou objednávku prověření jen proto, že zjištění stavu selhalo nebo vrátilo neočekávané tělo odpovědi. Pokud nesoulad přetrvává, obraťte se na MultiTEL prostřednictvím autentizovaného kanálu podpory a uveďte příslušné referenční identifikátory.

Provádějte jednotlivé kroky registrace odděleně

Prověření stanovuje výsledek posouzení značky. Posouzení způsobilosti kampaně, registrace kampaně a přiřazení čísla zůstávají samostatnými kroky. Před odesíláním zpráv zkontrolujte jejich aktuální stav a požadavky.

Požadavek

Použijte účet s povoleným přístupem k API přes HTTPS z povolené zdrojové IP adresy. Použijte přihlašovací údaje svého účtu, nikoli přihlašovací údaje registru. Značka musí být přidružena k autentizovanému účtu.

Požadavek GET s identifikátorem značky v cestě a povinným filtrem dotazu vettingStatus. Přezkoumané schéma definuje pole stavů; tento příklad požaduje jednu hodnotu ACTIVE. Tato příručka nepotvrzuje způsob kódování více hodnot ani to, že poskytovatel přijímá požadavky bez filtru. Tělo požadavku není vyžadováno.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Parametry cesty
NázevTypPovinnýPopis
brandIdřetězecAnoIdentifikátor značky v registru přidružený k vašemu účtu MultiTEL. Nejde o identifikátor vašeho účtu ani o identifikátor prověření.
Parametry dotazu
NázevTypPovinnýPopis
vettingStatuspole řetězcůAnoPovinný filtr stavu. Povolené hodnoty: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Příklad předává jednu hodnotu ACTIVE; netvrdí se zde nic o způsobu kódování více hodnot ani o tom, že poskytovatel přijímá požadavky bez filtru.

Odpověď

Současná cesta zachovává stav HTTP a tělo odpovědi registru namísto použití starší obálky odpovědi v3. Zkrácené smyšlené pole ukazuje pole používaná místní synchronizací; nejde o zachycenou odpověď registru ani o zaručeně úplné schéma. Před čtením záznamů zkontrolujte stav HTTP a JSON. Každý vettingId uchovávejte společně s vybranou značkou.

Ilustrační struktura odpovědi; nejde o skutečná data účtu ani o aktuální cenovou nabídku.

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

Chyby

  • 401: Autentizace účtu selhala. Zkontrolujte přihlašovací údaje, zda je povolen přístup k API, a platná omezení zdrojových IP adres.
  • 404: Značka není přidružena k tomuto účtu nebo ji registr nemohl najít. K odmítnutí kvůli tomu, že značka nepatří účtu, dochází před odesláním požadavku do registru.
  • 429: Byl dosažen limit požadavků účtu nebo registru. Dodržujte Retry-After a postupně prodlužujte intervaly mezi pokusy.
  • 502/503: Přenos, registr, omezovač požadavků nebo místní zpracování nejsou dostupné. Chyba nedokazuje, že dřívější žádost o prověření selhala.

Dostupnost a vedlejší účinky

  • Tento požadavek GET nevytváří novou objednávku prověření. Načítá výsledky z registru, zapisuje auditní záznamy požadavku a synchronizuje uložené výsledky.
  • Načtení dokončeného výsledku může vést k vyúčtování poplatku za dříve zadanou zpoplatněnou objednávku prověření. Neúspěšné prověření může podléhat příslušnému poplatku za neúspěch. Při objednávání si prostudujte cenu a podmínky; toto načtení není cenovou nabídkou.
  • Nově nalezený záznam importovaný tímto požadavkem GET není automaticky zařazen jako nová zpoplatněná objednávka.
  • Úspěšný výsledek prověření nebo výsledek se stavem ACTIVE neznamená schválení kampaně, přiřazení telefonního čísla ani oprávnění odesílat zprávy.