Ontwikkelaars

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

Bekijk de beoordelingsresultaten van een merk

Lees de beoordelingsresultaten van een merk binnen uw account en volg een bestaande beoordeling terwijl deze nog in behandeling is of succesvol dan wel onsuccesvol wordt afgerond.

Op deze pagina
  1. Selecteer het merk dat u wilt controleren
  2. Volg een bestaande beoordeling
  3. Krijg inzicht in de kosten van een eerdere bestelling
  4. Probeer de gegevens opnieuw op te halen zonder een nieuwe bestelling te plaatsen
  5. Houd de registratiestappen gescheiden
  6. Verzoek
  7. Antwoord
  8. Fouten
  9. Beschikbaarheid en neveneffecten

Selecteer het merk dat u wilt controleren

Gebruik de merk-ID uit uw account. Bewaar deze bij de resulterende beoordelingsgegevens, zodat beoordelingen van verschillende bedrijven niet met elkaar worden verward. Gebruik geen identificatoren van een ander account.

Volg een bestaande beoordeling

Bewaar de waarden voor vettingId, evpId, vettingClass en vettingStatus wanneer deze aanwezig zijn. De huidige synchronisatie behandelt PENDING en UNSCORE als resultaten die nog op verdere controle wachten, en ACTIVE en FAILED als definitieve resultaten voor de afrekening. Lees de geretourneerde details voordat u beslist of er verdere actie nodig is. Een lege lijst bewijst op zichzelf niet dat een eerdere indiening het register niet heeft bereikt.

Krijg inzicht in de kosten van een eerdere bestelling

Door de status te controleren bestelt u geen nieuwe beoordeling. De controle kan wel een definitief resultaat afstemmen en de kosten afrekenen van een eerder aangevraagde betaalde beoordeling. Daaronder vallen ook eventuele kosten voor een onsuccesvolle beoordeling. Ga uit van de prijs en voorwaarden die u bij het bestellen hebt bekeken; leid de huidige prijs niet af uit een oud voorbeeld of een statusantwoord.

Probeer de gegevens opnieuw op te halen zonder een nieuwe bestelling te plaatsen

Bewaar bij een tijdelijke storing de merk-ID en de bekende beoordelings-ID's, houd rekening met Retry-After en probeer de gegevens opnieuw op te halen met steeds langere wachttijden tussen pogingen. Bestel geen nieuwe beoordeling alleen omdat het opvragen van de status is mislukt of een onverwachte antwoordinhoud heeft opgeleverd. Neem bij een blijvende afwijking via een geauthenticeerd ondersteuningskanaal contact op met MultiTEL en vermeld de relevante referentie-ID's.

Houd de registratiestappen gescheiden

De beoordeling levert een beoordelingsresultaat voor het merk op. Het toetsen van een campagne aan de vereisten, het registreren van de campagne en het toewijzen van nummers blijven afzonderlijke stappen. Controleer de huidige status en vereisten van die stappen voordat u berichten verstuurt.

Verzoek

Gebruik een account waarvoor API is ingeschakeld en maak via HTTPS verbinding vanaf een toegestaan bron-IP-adres. Gebruik de inloggegevens van uw account, niet die van het register. Het merk moet aan het geauthenticeerde account zijn gekoppeld.

Gebruik GET met de merk-ID in het pad en het verplichte queryfilter vettingStatus. Het beoordeelde schema definieert een array met statussen; in dit voorbeeld wordt één waarde ACTIVE opgevraagd. Deze handleiding stelt niet vast hoe meerdere waarden moeten worden gecodeerd of dat de provider verzoeken zonder filter accepteert. Een verzoekinhoud is niet vereist.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Padparameters
NaamGegevenstypeVerplichtBeschrijving
brandIdtekenreeksJaDe merk-ID in het register die aan uw MultiTEL-account is gekoppeld. Dit is niet uw account-ID of een beoordelings-ID.
Queryparameters
NaamGegevenstypeVerplichtBeschrijving
vettingStatusarray van tekenreeksenJaVerplicht statusfilter. Toegestane waarden: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Het voorbeeld geeft één waarde ACTIVE mee; er wordt geen uitspraak gedaan over de codering van meerdere waarden of over acceptatie van verzoeken zonder filter door de provider.

Antwoord

De huidige route behoudt de HTTP-status en de antwoordinhoud van het register in plaats van de verouderde antwoordomhulling van v3 te gebruiken. De ingekorte fictieve array toont velden die door het lokale synchronisatiepad worden gebruikt; het is geen vastgelegd registerantwoord en geen gegarandeerd volledig schema. Controleer de HTTP-status en JSON voordat u records uitleest. Bewaar elke vettingId bij het geselecteerde merk.

Voorbeeld van de antwoordstructuur; geen werkelijke accountgegevens of actuele prijsopgave.

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

Fouten

  • 401: De accountauthenticatie is mislukt. Controleer de inloggegevens, of API is ingeschakeld en welke beperkingen voor bron-IP-adressen van toepassing zijn.
  • 404: Het merk is niet aan dit account gekoppeld of het register kon het niet vinden. Een weigering omdat het merk niet bij het account hoort, vindt plaats voordat het verzoek naar het register wordt gestuurd.
  • 429: De verzoeklimiet voor het account of het register is bereikt. Houd rekening met Retry-After en gebruik steeds langere wachttijden tussen herhaalpogingen.
  • 502/503: De transportlaag, het register, de verzoekbegrenzer of de lokale verwerking is niet beschikbaar. Een fout bewijst niet dat een eerdere beoordelingsaanvraag is mislukt.

Beschikbaarheid en neveneffecten

  • Dit GET-verzoek bestelt geen nieuwe beoordeling. Het haalt resultaten uit het register op, schrijft auditgegevens over het verzoek weg en synchroniseert opgeslagen resultaten.
  • Het uitlezen van een definitief resultaat kan de kosten afrekenen van een eerder bestelde betaalde beoordeling. Bij een onsuccesvolle beoordeling kunnen daarvoor geldende kosten in rekening worden gebracht. Bekijk de prijs en voorwaarden bij het bestellen; het opvragen van deze gegevens is geen prijsopgave.
  • Een nieuw ontdekt record dat door dit GET-verzoek wordt geïmporteerd, wordt niet automatisch als een nieuwe betaalde bestelling aangemerkt.
  • Een succesvol beoordelingsresultaat of een resultaat met de status ACTIVE betekent niet dat een campagne is goedgekeurd, dat een telefoonnummer is toegewezen of dat u toestemming hebt om berichten te versturen.