Utviklere

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

Sjekk resultatene av en merkevarevurdering

Hent vurderingsresultater for en merkevare på kontoen din, og følg en eksisterende vurdering fra ventende status til et vellykket eller mislykket resultat.

På denne siden
  1. Velg merkevaren du skal sjekke
  2. Følg en eksisterende vurdering
  3. Forstå gebyrene for en tidligere bestilling
  4. Prøv hentingen på nytt uten å sende inn en ny bestilling
  5. Hold registreringstrinnene atskilt
  6. Forespørsel
  7. Svar
  8. Feil
  9. Tilgjengelighet og sideeffekter

Velg merkevaren du skal sjekke

Bruk merkevare-ID-en fra kontoen din. Oppbevar den sammen med vurderingsoppføringene som returneres, slik at en vurdering av én virksomhet ikke forveksles med en vurdering av en annen. Ikke bruk identifikatorer fra en annen konto.

Følg en eksisterende vurdering

Ta vare på verdiene for vettingId, evpId, vettingClass og vettingStatus når de finnes. Den gjeldende synkroniseringen behandler PENDING og UNSCORE som resultater som fortsatt venter på ytterligere kontroll, og ACTIVE og FAILED som endelige resultater for avregning. Les detaljene som returneres, før du avgjør om det er behov for oppfølging. En tom liste er i seg selv ikke bevis på at en tidligere innsending ikke nådde registeret.

Forstå gebyrene for en tidligere bestilling

En statussjekk bestiller ikke en ny vurdering. Den kan imidlertid avstemme et ferdig resultat og avregne gebyret knyttet til en tidligere gebyrbelagt vurderingsforespørsel. Dette omfatter også et eventuelt gebyr for en mislykket vurdering. Legg til grunn prisen og vilkårene som ble gjennomgått ved bestilling; ikke utled dagens pris fra et gammelt eksempel eller et statussvar.

Prøv hentingen på nytt uten å sende inn en ny bestilling

Ved en forbigående feil må du ta vare på merkevare-ID-en og kjente vurderings-ID-er, følge Retry-After og prøve denne hentingen på nytt med gradvis økende ventetid mellom forsøkene. Ikke send inn en ny vurderingsbestilling bare fordi statusoppslaget mislyktes eller returnerte et uventet svarinnhold. Ved et vedvarende avvik må du kontakte MultiTEL via en autentisert brukerstøttekanal og oppgi de relevante referanse-ID-ene.

Hold registreringstrinnene atskilt

Vurderingen fastsetter et vurderingsresultat for merkevaren. Kvalifisering av kampanjen, registrering av kampanjen og tildeling av nummer er fortsatt separate trinn. Sjekk gjeldende status og krav for disse før du sender meldinger.

Forespørsel

Bruk en konto med aktivert API-tilgang over HTTPS fra en tillatt kilde-IP-adresse. Bruk påloggingsinformasjonen til kontoen din, ikke påloggingsinformasjonen til registeret. Merkevaren må være knyttet til den autentiserte kontoen.

GET med merkevare-ID-en i stien og det obligatoriske spørringsfilteret vettingStatus. Det gjennomgåtte skjemaet definerer en liste med statuser; dette eksemplet ber om én ACTIVE-verdi. Denne veiledningen fastslår ikke hvordan flere verdier skal kodes, eller om leverandøren godtar forespørsler uten filter. Forespørselsinnhold er ikke påkrevd.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Stiparametere
NavnDatatypePåkrevdBeskrivelse
brandIdtekststrengJaMerkevare-ID-en i registeret som er knyttet til MultiTEL-kontoen din. Dette er ikke konto-ID-en din eller en vurderings-ID.
Spørringsparametere
NavnDatatypePåkrevdBeskrivelse
vettingStatusliste med tekststrengerJaObligatorisk statusfilter. Tillatte verdier: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Eksemplet oppgir én ACTIVE-verdi; det hevdes ikke noe om koding av flere verdier eller om leverandøren godtar forespørsler uten filter.

Svar

Den gjeldende ruten bevarer registerets HTTP-status og svarinnhold i stedet for å bruke den eldre svarinnpakningen fra v3. Den forkortede, fiktive listen illustrerer felter som brukes i den lokale synkroniseringen; den er ikke et registrert svar fra registeret eller et garantert fullstendig skjema. Sjekk HTTP-status og JSON før du leser oppføringene. Oppbevar hver vettingId sammen med den valgte merkevaren.

Illustrasjon av svarstrukturen; dette er ikke faktiske kontodata eller et gjeldende pristilbud.

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

Feil

  • 401: Autentisering av kontoen mislyktes. Sjekk påloggingsinformasjonen, om API-tilgang er aktivert, og gjeldende begrensninger for kilde-IP-adresser.
  • 404: Merkevaren er ikke knyttet til denne kontoen, eller registeret fant den ikke. Avvisning fordi merkevaren ikke tilhører kontoen, skjer før forespørselen sendes til registeret.
  • 429: Grensen for forespørsler for kontoen eller registeret er nådd. Følg Retry-After og øk ventetiden gradvis mellom forsøkene.
  • 502/503: Transport, register, forespørselsbegrenser eller lokal behandling er utilgjengelig. En feil fastslår ikke at en tidligere vurderingsforespørsel mislyktes.

Tilgjengelighet og sideeffekter

  • Denne GET-forespørselen legger ikke inn en ny vurderingsbestilling. Den henter resultater fra registeret, skriver revisjonslogger for forespørselen og synkroniserer lagrede resultater.
  • Henting av et ferdig resultat kan avregne gebyret for en tidligere innsendt, gebyrbelagt vurderingsbestilling. En mislykket vurdering kan medføre et gjeldende gebyr for mislykket vurdering. Gå gjennom prisen og vilkårene ved bestilling; denne hentingen er ikke et pristilbud.
  • En nylig oppdaget oppføring som importeres av denne GET-forespørselen, klassifiseres ikke automatisk som en ny gebyrbelagt bestilling.
  • Et vellykket vurderingsresultat eller et resultat med status ACTIVE innebærer ikke godkjenning av kampanjen, tildeling av telefonnummer eller tillatelse til å sende meldinger.