Prüfergebnisse einer Marke abrufen

Zu prüfende Marke auswählen

Verwenden Sie die Marken-ID aus Ihrem Konto. Bewahren Sie sie zusammen mit den zugehörigen Prüfdatensätzen auf, damit die Prüfung eines Unternehmens nicht mit der eines anderen Unternehmens verwechselt wird. Verwenden Sie keine Kennungen aus einem anderen Konto.

Bestehende Prüfung verfolgen

Bewahren Sie die Werte für vettingId, evpId, vettingClass und vettingStatus auf, sofern vorhanden. Die aktuelle Synchronisierung behandelt PENDING und UNSCORE als Ergebnisse, die noch auf weitere Prüfung warten, und ACTIVE und FAILED als endgültige Ergebnisse für die Abrechnung. Lesen Sie die zurückgegebenen Details, bevor Sie entscheiden, ob weitere Schritte erforderlich sind. Eine leere Liste allein ist kein Beleg dafür, dass eine frühere Einreichung die Registrierungsstelle nicht erreicht hat.

Gebühren für einen früheren Auftrag verstehen

Eine Statusabfrage beauftragt keine weitere Prüfung. Sie kann jedoch ein abgeschlossenes Ergebnis abgleichen und die Gebühr für einen früheren kostenpflichtigen Prüfauftrag abrechnen. Dies schließt eine gegebenenfalls anfallende Gebühr bei fehlgeschlagener Prüfung ein. Maßgeblich sind der Preis und die Bedingungen, die Sie bei der Auftragserteilung geprüft haben; leiten Sie den heutigen Preis nicht aus einem alten Beispiel oder einer Statusantwort ab.

Abruf wiederholen, ohne einen weiteren Auftrag zu erteilen

Bewahren Sie bei einem vorübergehenden Fehler die Marken-ID und die bekannten Prüfungs-IDs auf, beachten Sie Retry-After und wiederholen Sie diesen Abruf mit zunehmenden Wartezeiten. Erteilen Sie keinen neuen Prüfauftrag, nur weil die Statusabfrage fehlgeschlagen ist oder einen unerwarteten Antwortinhalt zurückgegeben hat. Wenden Sie sich bei einer anhaltenden Abweichung über einen authentifizierten Supportkanal an MultiTEL und geben Sie die entsprechenden Referenz-IDs an.

Registrierungsschritte getrennt behandeln

Die Überprüfung liefert ein Prüfergebnis für die Marke. Die Qualifizierung einer Kampagne, ihre Registrierung und die Rufnummernzuweisung bleiben separate Schritte. Prüfen Sie deren aktuellen Status und Anforderungen, bevor Sie Nachrichten versenden.

Anfrage

Verwenden Sie ein freigeschaltetes API-Konto über HTTPS von einer zulässigen Quell-IP-Adresse aus. Verwenden Sie die Zugangsdaten Ihres Kontos, nicht die Zugangsdaten der Registrierungsstelle. Die Marke muss dem authentifizierten Konto zugeordnet sein.

GET mit der Marken-ID im Pfad und dem erforderlichen Abfragefilter vettingStatus. Das geprüfte Schema definiert ein Array von Statuswerten; dieses Beispiel fragt einen einzelnen Wert ACTIVE ab. Dieser Leitfaden belegt weder die Kodierung mehrerer Werte noch die Akzeptanz ungefilterter Anfragen durch den Anbieter. Ein Anfrageinhalt ist nicht erforderlich.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"

Antwort

Die aktuelle Route behält den HTTP-Status und den Antwortinhalt der Registrierungsstelle bei, anstatt das bisherige Antwortformat von v3 zu verwenden. Das gekürzte, fiktive Array veranschaulicht Felder, die vom lokalen Synchronisierungsablauf verarbeitet werden; es ist weder eine aufgezeichnete Antwort der Registrierungsstelle noch ein garantiert vollständiges Schema. Prüfen Sie den HTTP-Status und die JSON-Daten, bevor Sie Datensätze lesen. Bewahren Sie jede vettingId zusammen mit der ausgewählten Marke auf.

Beispielhafter Aufbau einer Antwort; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

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

Fehler

• 401: Die Kontoauthentifizierung ist fehlgeschlagen. Prüfen Sie die Zugangsdaten, die Freischaltung der API und die geltenden Beschränkungen für Quell-IP-Adressen.
• 404: Die Marke ist diesem Konto nicht zugeordnet oder wurde von der Registrierungsstelle nicht gefunden. Eine Ablehnung aufgrund fehlender Kontozugehörigkeit erfolgt vor der Anfrage an die Registrierungsstelle.
• 429: Das Anfragelimit des Kontos oder der Registrierungsstelle wurde erreicht. Beachten Sie Retry-After und verwenden Sie zunehmende Wartezeiten zwischen Wiederholungsversuchen.
• 502/503: Die Übertragung, die Registrierungsstelle, die Anfragebegrenzung oder die lokale Verarbeitung ist nicht verfügbar. Ein Fehler belegt nicht, dass ein früherer Prüfauftrag fehlgeschlagen ist.

Verfügbarkeit und Nebenwirkungen

• Diese GET-Anfrage erteilt keinen neuen Prüfauftrag. Sie ruft Ergebnisse der Registrierungsstelle ab, schreibt Auditdatensätze zur Anfrage und synchronisiert gespeicherte Ergebnisse.
• Der Abruf eines abgeschlossenen Ergebnisses kann die Gebühr für einen zuvor erteilten kostenpflichtigen Prüfauftrag abrechnen. Bei einer fehlgeschlagenen Prüfung kann eine entsprechende Gebühr anfallen. Prüfen Sie den Preis und die Bedingungen bei der Auftragserteilung; dieser Abruf ist kein Preisangebot.
• Ein neu entdeckter Datensatz, der durch diese GET-Anfrage importiert wird, wird nicht automatisch als neuer kostenpflichtiger Auftrag eingestuft.
• Ein erfolgreiches Prüfergebnis oder ein Prüfergebnis mit dem Status ACTIVE stellt weder eine Kampagnengenehmigung noch eine Rufnummernzuweisung oder eine Erlaubnis zum Versenden von Nachrichten dar.