Utvecklare

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

Kontrollera ett varumärkes granskningsresultat

Läs granskningsresultat för ett varumärke på ditt konto och följ en befintlig granskning genom väntande, godkända eller misslyckade resultat.

På denna sida
  1. Välj det varumärke du vill kontrollera
  2. Följ en befintlig granskning
  3. Förstå avgifterna för en tidigare beställning
  4. Försök läsa igen utan att skicka en ny beställning
  5. Håll registreringsstegen åtskilda
  6. Begäran
  7. Svar
  8. Fel
  9. Tillgänglighet och sidoeffekter

Välj det varumärke du vill kontrollera

Använd varumärkes-ID:t från ditt konto. Spara det tillsammans med granskningsposterna som returneras så att en granskning av ett företag inte förväxlas med en granskning av ett annat företag. Använd inte identifierare från ett annat konto.

Följ en befintlig granskning

Spara vettingId, evpId, vettingClass och vettingStatus när de finns. Den nuvarande synkroniseringen behandlar PENDING och UNSCORE som resultat som fortfarande väntar på ytterligare kontroll, och ACTIVE och FAILED som slutliga resultat för avräkning. Läs de returnerade uppgifterna innan du avgör om någon uppföljning behövs. En tom lista är i sig inget bevis för att en tidigare inskickad begäran inte nådde registret.

Förstå avgifterna för en tidigare beställning

En statuskontroll beställer inte en ny granskning. Den kan däremot stämma av ett färdigt resultat och avräkna avgiften för en tidigare debiterbar granskningsbegäran. Detta omfattar en eventuell avgift för en misslyckad granskning. Utgå från det pris och de villkor som granskades vid beställningen; dra inga slutsatser om dagens pris utifrån ett gammalt exempel eller ett statussvar.

Försök läsa igen utan att skicka en ny beställning

Vid ett tillfälligt fel ska du spara varumärkes-ID:t och kända gransknings-ID:n, följa Retry-After och försöka läsa igen med successivt längre väntetid mellan försöken. Skicka inte en ny granskningsbeställning bara för att statusuppslagningen misslyckades eller returnerade en oväntad svarskropp. Vid en bestående avvikelse ska du kontakta MultiTEL med relevanta referens-ID:n via en autentiserad supportkanal.

Håll registreringsstegen åtskilda

Granskningen fastställer ett granskningsresultat för varumärket. Kvalificering av kampanjen, kampanjregistrering och nummertilldelning är fortfarande separata steg. Kontrollera deras aktuella status och krav innan du skickar meddelanden.

Begäran

Använd ett aktiverat API-konto över HTTPS från en tillåten käll-IP-adress. Använd inloggningsuppgifterna för ditt konto, inte för registret. Varumärket måste vara kopplat till det autentiserade kontot.

Använd GET med varumärkes-ID:t i sökvägen och det obligatoriska frågefiltret vettingStatus. Det granskade schemat definierar en array med statusvärden; detta exempel begär ett enda ACTIVE-värde. Den här guiden fastställer inte hur flera värden ska kodas eller om leverantören accepterar begäranden utan filter. Ingen begärandekropp krävs.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Sökvägsparametrar
NamnTypObligatoriskBeskrivning
brandIdsträngJaRegistrets varumärkes-ID som är kopplat till ditt MultiTEL-konto. Detta är inte ditt konto-ID eller ett gransknings-ID.
Frågeparametrar
NamnTypObligatoriskBeskrivning
vettingStatusarray med strängarJaObligatoriskt statusfilter. Tillåtna värden: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Exemplet anger ett enda ACTIVE-värde; inga påståenden görs om kodning av flera värden eller om leverantören accepterar begäranden utan filter.

Svar

Den nuvarande routen behåller registrets HTTP-status och svarskropp i stället för att använda det äldre svarsomslaget för v3. Den förkortade fiktiva arrayen visar fält som används av det lokala synkroniseringsflödet; den är varken ett insamlat registersvar eller ett garanterat fullständigt schema. Kontrollera HTTP-status och JSON innan du läser posterna. Spara varje vettingId tillsammans med det valda varumärket.

Illustrativ svarsstruktur; inga aktuella kontouppgifter eller någon aktuell prisuppgift.

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

Fel

  • 401: Autentiseringen av kontot misslyckades. Kontrollera inloggningsuppgifterna, att API är aktiverat och tillämpliga begränsningar för käll-IP-adresser.
  • 404: Varumärket är inte kopplat till det här kontot, eller så kunde registret inte hitta det. Ett avslag på grund av kontotillhörighet sker innan begäran skickas till registret.
  • 429: Gränsen för antalet begäranden för kontot eller registret har nåtts. Följ Retry-After och använd successivt längre väntetid mellan försöken.
  • 502/503: Transporten, registret, begränsaren för begäranden eller den lokala bearbetningen är inte tillgänglig. Ett fel fastställer inte att en tidigare granskningsbegäran misslyckades.

Tillgänglighet och sidoeffekter

  • Denna GET-begäran gör ingen ny granskningsbeställning. Den hämtar resultat från registret, skriver granskningsloggposter för begäran och synkroniserar lagrade resultat.
  • När ett färdigt resultat läses kan avgiften för en tidigare lagd debiterbar granskningsbeställning avräknas. En misslyckad granskning kan medföra en tillämplig avgift för misslyckandet. Granska priset och villkoren vid beställningen; denna läsning är ingen prisuppgift.
  • En nyupptäckt post som importeras av denna GET-begäran klassificeras inte automatiskt som en ny debiterbar beställning.
  • Ett godkänt granskningsresultat eller ett granskningsresultat med status ACTIVE innebär inte att kampanjen har godkänts, att ett telefonnummer har tilldelats eller att det finns tillstånd att skicka meddelanden.