Kataloge für die Nachrichtenregistrierung laden

Auswahlmöglichkeiten vor dem Erstellen eines Registrierungsformulars laden

Verwenden Sie den aktuellen Katalog für die Nachrichtenregistrierung, um Auswahlmöglichkeiten bereitzustellen, anstatt Registerwerte fest zu hinterlegen. Für ein Markenformular lädt das Portal Kataloge für Unternehmensform, Branche, Typ der alternativen Unternehmenskennung, Beziehung zur Marke, Land, US-Bundesstaat und Börse. Für ein Kampagnenformular lädt es Anwendungsfälle, gültige untergeordnete Anwendungsfälle und Konnektivitätspartner. Bewahren Sie jeden zurückgegebenen maschinenlesbaren Wert zusammen mit seiner Anzeigebezeichnung auf; verwenden Sie beim Erstellen einer späteren Anfrage den Wert und keine übersetzte Bezeichnung.

Katalog auswählen

Die TCR-Antwort direkt verarbeiten

Der Antwortinhalt stammt direkt von der TCR-API. Anders als bei vielen älteren /v3-Endpunkten gibt es keine zusätzliche Hülle aus status/response. Prüfen Sie vor der Auswertung den HTTP-Status. Ein Katalog kann Bezeichnungen als Zeichenfolgen oder strukturierte Definitionen enthalten; gehen Sie daher nicht davon aus, dass jeder Wert dieselben Felder hat. Wenn die HTTP-Anfrage erfolgreich ist, der Inhalt aber kein gültiges JSON in der erwarteten Struktur ist, melden Sie einen fehlgeschlagenen Abruf, anstatt ihn stillschweigend durch eine leere Liste zu ersetzen.

Katalogauswahl von Eignungsprüfung und Preisermittlung trennen

Ein allgemeiner Katalog von Anwendungsfällen gibt nicht an, für welche Anwendungsfälle eine bestimmte Marke zugelassen ist. Das aktuelle Portal führt vor dem Erstellen einer Kampagne eine markenspezifische Eignungsabfrage durch und prüft die ausgewählten Netzbetreiberanforderungen. Ebenso entsprechen Gebührenmetadaten eines Lieferanten nicht dem endgültigen Endkundenpreis des Kontos. Prüfen Sie den für das Konto geltenden Preis und die Registrierungsbedingungen gesondert. Das Laden eines Katalogs genehmigt weder eine Marke noch eine Kampagne oder eine Rufnummer für den Nachrichtenversand.

Mit nicht verfügbaren Katalogen umgehen

Bewahren Sie die Formulareingaben des Kunden auf, wenn ein Abruf fehlschlägt. Zeigen Sie den Fehler an, beachten Sie Retry-After bei Rückgabe und verwenden Sie zunehmend längere Wartezeiten zwischen Wiederholungsversuchen. Laden Sie nicht ständig alle Kataloge erneut und behandeln Sie einen Fehler wegen einer Anfrageratenbegrenzung oder einen Übertragungsfehler nicht als gültigen leeren Katalog. Diese GET-Anfrage erfordert keinen Idempotenzschlüssel und wird nicht aus dem Idempotenzspeicher für Änderungen erneut ausgeführt.

Anfrage

Verwenden Sie ein aktiviertes API-Konto über HTTPS von einer zulässigen Quell-IP-Adresse aus. Die aktuelle Route unterstützt die Authentifizierungsrichtlinie des Kontos, einschließlich Basic-Authentifizierung und aktivierter API-Konten mit Bearer-Authentifizierung. Verwenden Sie keine Zugangsdaten des Anbieters.

GET mit einem unterstützten Katalognamen im Pfad. Übergeben Sie zutreffende Katalogfilter in der Abfragezeichenfolge. Ein Anfrageinhalt ist nicht erforderlich.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Antwort

Diese TCR-Route gibt den Inhalt des Registers direkt mit dessen HTTP-Status zurück. Sie verwendet nicht die ältere Hülle status.code/status.msg/response aus v3. Katalogstrukturen unterscheiden sich: Manche ordnen Werten beschreibende Objekte zu, andere ordnen Werten Zeichenfolgen zu. Behalten Sie die maschinenlesbaren Schlüssel bei, wenn Sie später ein Formular absenden. Das gekürzte fiktive Beispiel für usecase veranschaulicht eine Zuordnung mit Objekten als Werten, keinen aktuellen Katalog und kein garantiert vollständiges Schema. Prüfen Sie sowohl den HTTP-Status als auch die erwartete JSON-Struktur.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Fehler

• 401: Die Kontoauthentifizierung ist fehlgeschlagen. Prüfen Sie die API-Zugangsdaten, den Aktivierungsstatus und die geltenden Einschränkungen für Quell-IP-Adressen.
• 400/404 und andere Registerfehler: Ungültiger oder nicht verfügbarer Katalog oder Filter. Die aktuelle Route behält den HTTP-Status und den Antwortinhalt des vorgelagerten Dienstes bei; es gibt keine universelle v3-Fehlerhülle.
• 429: Das Anfragelimit des Kontos oder das gemeinsam genutzte Anfragelimit des Anbieters wurde erreicht. Beachten Sie Retry-After und wiederholen Sie die Anfrage mit zunehmend längeren Wartezeiten.
• 502: Das Register konnte nicht erreicht werden. Die Verfügbarkeit ist unbekannt; geben Sie keine leere Auswahl als erfolgreiches Ergebnis zurück.
• 503: Die Anfragebegrenzung oder der vorgelagerte Dienst ist nicht verfügbar. Prüfen Sie vor einem erneuten Versuch den Inhalt und einen gegebenenfalls vorhandenen Retry-After-Header.

Verfügbarkeit und Nebenwirkungen

• Diese GET-Anfrage für Kataloge erstellt im geprüften Ablauf weder eine Marke noch eine Kampagne, reicht keine Registrierung ein, reserviert keine Ressource und berechnet keine Registrierungsgebühr. Sie kontaktiert den Anbieter und schreibt Auditprotokolle zur Anfrage.
• Katalogdefinitionen und etwaige Gebührenmetadaten des Lieferanten sind kein Endkundenpreisangebot. Das aktuelle Portal ruft die Endkundenpreise für Kampagnen gesondert ab; die veraltete Hilfsfunktion getCampaignPrice und alte Preisannotationen in Aufzählungen dürfen nicht als verbindliche Preisdefinition dieser Route behandelt werden.
• Ein unterstützter Katalogeintrag ist kein Nachweis dafür, dass eine bestimmte Marke für diesen Anwendungsfall zugelassen ist. Schließen Sie vor einer späteren Registrierungsanfrage die markenspezifische Eignungsprüfung, Erklärungen, Einwilligung und Prüfung der Kontopreise ab.