Udviklere

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

Se resultaterne af en brandvurdering

Læs vurderingsresultater for et brand på din konto, og følg en eksisterende vurdering gennem afventende, vellykkede eller mislykkede resultater.

På denne side
  1. Vælg det brand, du vil kontrollere
  2. Følg en eksisterende vurdering
  3. Forstå gebyrer for en tidligere bestilling
  4. Gentag læsningen uden at afgive en ny bestilling
  5. Hold registreringstrinnene adskilt
  6. Anmodning
  7. Svar
  8. Fejl
  9. Tilgængelighed og følgevirkninger

Vælg det brand, du vil kontrollere

Brug brand-id'et fra din konto. Gem det sammen med de tilhørende vurderingsposter, så en vurdering af én virksomhed ikke forveksles med en anden virksomheds vurdering. Brug ikke identifikatorer fra en anden konto.

Følg en eksisterende vurdering

Gem vettingId, evpId, vettingClass og vettingStatus når de er til stede. Den nuværende synkronisering behandler PENDING og UNSCORE som resultater, der stadig afventer yderligere kontrol, og ACTIVE og FAILED som endelige resultater til afregning. Læs de returnerede oplysninger, før du beslutter, om der er behov for opfølgning. En tom liste er ikke i sig selv bevis for, at en tidligere indsendelse ikke nåede frem til registret.

Forstå gebyrer for en tidligere bestilling

Når du kontrollerer status, bestiller du ikke en ny vurdering. Kontrollen kan dog afstemme et afsluttet resultat og afregne gebyret for en tidligere betalingspligtig vurderingsanmodning. Dette omfatter et eventuelt gebyr for en mislykket vurdering. Brug den pris og de vilkår, der blev gennemgået ved bestillingen; udled ikke dagens pris af et gammelt eksempel eller et statussvar.

Gentag læsningen uden at afgive en ny bestilling

Ved en midlertidig fejl skal du gemme brand-id'et og de kendte vurderings-id'er, overholde Retry-After og gentage denne læsning med gradvist længere ventetid mellem forsøgene. Afgiv ikke en ny bestilling på en vurdering, blot fordi statusopslaget mislykkedes eller returnerede et uventet svarindhold. Ved en vedvarende uoverensstemmelse skal du kontakte MultiTEL med de relevante reference-id'er via en autentificeret supportkanal.

Hold registreringstrinnene adskilt

Vurderingen fastlægger et vurderingsresultat for brandet. Kvalificering af kampagnen, registrering af kampagnen og tildeling af numre er fortsat separate trin. Kontrollér deres aktuelle status og krav, før du sender beskeder.

Anmodning

Brug en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Brug legitimationsoplysningerne til din konto, ikke legitimationsoplysninger til registret. Brandet skal være knyttet til den autentificerede konto.

Brug GET med brand-id'et i stien og det obligatoriske forespørgselsfilter vettingStatus. Det gennemgåede skema definerer en liste over statusværdier; dette eksempel anmoder om én ACTIVE-værdi. Denne vejledning fastslår ikke, hvordan flere værdier skal kodes, eller om udbyderen accepterer anmodninger uden filter. Anmodningen kræver intet indhold.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Stiparametre
NavnTypeObligatoriskBeskrivelse
brandIdtekststrengJaRegistrets brand-id, der er knyttet til din MultiTEL-konto. Dette er ikke dit konto-id eller et vurderings-id.
Forespørgselsparametre
NavnTypeObligatoriskBeskrivelse
vettingStatusliste af tekststrengeJaObligatorisk statusfilter. Tilladte værdier: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Eksemplet angiver én ACTIVE-værdi; der fremsættes ingen påstand om kodning af flere værdier eller om udbyderens accept af anmodninger uden filter.

Svar

Den nuværende rute bevarer registrets HTTP-status og svarindhold i stedet for at bruge det ældre v3-svaromslag. Den forkortede, fiktive liste illustrerer felter, der bruges i det lokale synkroniseringsforløb; den er ikke et registreret svar fra registret eller et garanteret fuldstændigt skema. Kontrollér HTTP-status og JSON, før du læser poster. Gem hvert vettingId sammen med det valgte brand.

Illustration af svarstrukturen; ikke aktuelle kontodata eller et gældende pristilbud.

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

Fejl

  • 401: Autentificering af kontoen mislykkedes. Kontrollér legitimationsoplysningerne, om API er aktiveret, og de gældende begrænsninger for kilde-IP-adresser.
  • 404: Brandet er ikke knyttet til denne konto, eller registret kunne ikke finde det. En afvisning på grund af manglende tilknytning til kontoen sker før anmodningen til registret.
  • 429: Grænsen for anmodninger til kontoen eller registret er nået. Overhold Retry-After, og brug gradvist længere ventetid mellem forsøgene.
  • 502/503: Transporten, registret, anmodningsbegrænseren eller den lokale behandling er utilgængelig. En fejl fastslår ikke, at en tidligere vurderingsanmodning mislykkedes.

Tilgængelighed og følgevirkninger

  • Denne GET-anmodning afgiver ikke en ny bestilling på en vurdering. Den henter resultater fra registret, skriver revisionsposter for anmodningen og synkroniserer gemte resultater.
  • Læsning af et afsluttet resultat kan afregne gebyret for en tidligere afgivet betalingspligtig vurderingsbestilling. En mislykket vurdering kan medføre et gældende gebyr for en mislykket vurdering. Gennemgå prisen og vilkårene ved bestilling; denne læsning er ikke et pristilbud.
  • En nyopdaget post, der importeres af denne GET-anmodning, klassificeres ikke automatisk som en ny betalingspligtig bestilling.
  • Et vellykket vurderingsresultat eller et resultat med status ACTIVE er ikke en kampagnegodkendelse, en tildeling af telefonnumre eller en tilladelse til at sende beskeder.