Fejlesztők

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

Egy márka átvilágítási eredményeinek ellenőrzése

Kérdezze le a fiókjához tartozó márka átvilágítási eredményeit, és kövesse a meglévő felülvizsgálatot a függőben lévő állapottól a sikeres vagy sikertelen eredményig.

Ezen az oldalon
  1. Válassza ki az ellenőrizni kívánt márkát
  2. Kövesse a meglévő felülvizsgálatot
  3. Ismerje meg a korábbi megrendeléshez kapcsolódó díjakat
  4. Ismételje meg a lekérdezést újabb megrendelés beküldése nélkül
  5. Kezelje külön a regisztráció lépéseit
  6. Kérés
  7. Válasz
  8. Hibák
  9. Elérhetőség és mellékhatások

Válassza ki az ellenőrizni kívánt márkát

Használja a fiókjában szereplő márkaazonosítót. Őrizze meg a kapott átvilágítási rekordokkal együtt, nehogy az egyik vállalkozás felülvizsgálatát összetévessze egy másikéval. Ne használja másik fiók azonosítóit.

Kövesse a meglévő felülvizsgálatot

Őrizze meg a vettingId, evpId, vettingClass és vettingStatus mezők értékét, ha szerepelnek a válaszban. A jelenlegi szinkronizálás a PENDING és UNSCORE állapotokat további ellenőrzésre váró eredményként, az ACTIVE és FAILED állapotokat pedig az elszámolás szempontjából végleges eredményként kezeli. Olvassa el a visszakapott részleteket, mielőtt eldönti, szükséges-e további intézkedés. Az üres lista önmagában nem bizonyítja, hogy egy korábbi beküldés nem jutott el a nyilvántartóhoz.

Ismerje meg a korábbi megrendeléshez kapcsolódó díjakat

Az állapot ellenőrzése nem rendel meg újabb felülvizsgálatot. Ugyanakkor egyeztetheti a lezárult eredményt, és elszámolhatja egy korábbi, díjköteles felülvizsgálati kérelem díját. Ez az esetlegesen alkalmazandó sikertelenségi díjat is magában foglalja. A megrendeléskor áttekintett árat és feltételeket vegye alapul; ne következtessen a mai árra egy régi példából vagy egy állapotlekérdezés válaszából.

Ismételje meg a lekérdezést újabb megrendelés beküldése nélkül

Átmeneti hiba esetén őrizze meg a márkaazonosítót és az ismert átvilágítási azonosítókat, tartsa be a Retry-After fejlécben megadott várakozási időt, és növekvő várakozási időközökkel próbálja újra a lekérdezést. Ne küldjön be új felülvizsgálati megrendelést pusztán azért, mert az állapotlekérdezés sikertelen volt, vagy váratlan választörzset adott vissza. Tartós eltérés esetén hitelesített támogatási csatornán keresse meg a MultiTEL ügyfélszolgálatát a megfelelő hivatkozási azonosítókkal.

Kezelje külön a regisztráció lépéseit

Az átvilágítás a márkára vonatkozó felülvizsgálati eredményt állapítja meg. A kampány jogosultságának megállapítása, a kampány regisztrációja és a telefonszám hozzárendelése továbbra is külön lépések. Üzenetküldés előtt ellenőrizze ezek aktuális állapotát és követelményeit.

Kérés

Használjon engedélyezett API-fiókot HTTPS kapcsolaton, engedélyezett forrás IP-címről. A saját fiókja hitelesítő adatait használja, ne a nyilvántartóhoz tartozó hitelesítő adatokat. A márkának a hitelesített fiókhoz kell tartoznia.

GET kérés, az útvonalban a márkaazonosítóval és a kötelező vettingStatus lekérdezési szűrővel. A felülvizsgált séma állapotok tömbjét definiálja; ez a példa egyetlen ACTIVE értéket kér le. Ez az útmutató nem igazolja több érték kódolási módját, sem azt, hogy a szolgáltató elfogadja a szűrő nélküli kérést. Kéréstörzs nem szükséges.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Útvonalparaméterek
NévTípusKötelezőLeírás
brandIdkarakterláncIgenA MultiTEL-fiókjához tartozó, nyilvántartói márkaazonosító. Ez nem a fiókazonosítója és nem átvilágítási azonosító.
Lekérdezési paraméterek
NévTípusKötelezőLeírás
vettingStatuskarakterláncok tömbjeIgenKötelező állapotszűrő. Megengedett értékek: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. A példa egyetlen ACTIVE értéket ad meg; nem állítja, hogy több érték kódolási módja vagy a szűrő nélküli kérés szolgáltató általi elfogadása igazolt.

Válasz

A jelenlegi útvonal megőrzi a nyilvántartó HTTP-állapotkódját és választörzsét a korábbi v3 válaszburkoló használata helyett. A rövidített, kitalált tömb a helyi szinkronizálási folyamat által felhasznált mezőket szemlélteti; nem a nyilvántartótól rögzített válasz és nem garantáltan teljes séma. A rekordok olvasása előtt ellenőrizze a HTTP-állapotkódot és a JSON tartalmát. Minden vettingId értéket a kiválasztott márkával együtt őrizzen meg.

Szemléltető válaszstruktúra; nem élő fiókadat és nem aktuális árajánlat.

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

Hibák

  • 401: A fiók hitelesítése sikertelen. Ellenőrizze a hitelesítő adatokat, az API engedélyezett állapotát és a vonatkozó forrás-IP-korlátozásokat.
  • 404: A márka nem ehhez a fiókhoz tartozik, vagy a nyilvántartó nem találta. Ha a fiókhoz tartozás ellenőrzése miatt történik elutasítás, arra a nyilvántartónak küldött kérés előtt kerül sor.
  • 429: A fiók vagy a nyilvántartó kérési korlátja elérve. Tartsa be a Retry-After fejlécben megadott várakozási időt, és alkalmazzon növekvő várakozási időközöket.
  • 502/503: Az adatátvitel, a nyilvántartó, a kéréskorlátozó vagy a helyi feldolgozás nem érhető el. A hiba nem bizonyítja, hogy egy korábbi felülvizsgálati kérelem sikertelen volt.

Elérhetőség és mellékhatások

  • Ez a GET kérés nem ad le új átvilágítási megrendelést. Lekéri a nyilvántartó eredményeit, auditnapló-bejegyzéseket ír a kérésről, és szinkronizálja a tárolt eredményeket.
  • Egy lezárult eredmény lekérdezése elszámolhatja egy korábban leadott, díjköteles átvilágítási megrendelés díját. Sikertelen felülvizsgálat esetén az alkalmazandó sikertelenségi díj felszámítható. A megrendeléskor tekintse át az árat és a feltételeket; ez a lekérdezés nem árajánlat.
  • Az ezzel a GET kéréssel importált, újonnan felfedezett rekord nem minősül automatikusan új, díjköteles megrendelésnek.
  • A sikeres vagy ACTIVE állapotú átvilágítási eredmény nem jelenti a kampány jóváhagyását, telefonszám hozzárendelését vagy az üzenetküldés engedélyezését.