Verfügbare Kampagnen-Anwendungsfälle einer Marke prüfen

Vorhandene Marke in Ihrem Konto auswählen

Verwenden Sie zunächst die Marken-ID des Registers, die Ihrem MultiTEL-Konto bereits zugeordnet ist. Diese Abfrage erstellt keine Marke und ordnet Ihrem Konto keine fremde Marke zu. Der aktuelle Kundenablauf prüft die Kontozugehörigkeit, bevor die zulässigen Anwendungsfälle abgefragt werden. Wenn die Abfrage 404 zurückgibt, überprüfen Sie das ausgewählte Konto und die Marke, anstatt eine lokale Zeilen-ID einzusetzen.

Auswahl der Anwendungsfälle aus diesem Ergebnis erstellen

Der allgemeine Katalog der Anwendungsfälle beschreibt die Optionen des Registers. Diese markenspezifische Abfrage liefert die Auswahlmöglichkeiten für die ausgewählte Marke. Behalten Sie jeden zurückgegebenen usecase-Wert bei und kombinieren Sie ihn mit der Anzeigebezeichnung und Beschreibung aus dem Katalog. Bieten Sie nicht jeden Eintrag des allgemeinen Katalogs so an, als wäre er für die Marke zulässig.

Das Portal erwartet diese Antwort als JSON-Liste. Wenn sie fehlt, fehlerhaft formatiert ist oder einen Fehler darstellt, behalten Sie die Formulareingaben des Kunden bei und zeigen Sie an, dass die zulässigen Anwendungsfälle nicht geladen werden konnten. Werten Sie dies nicht stillschweigend als Freigabe für einen Standardanwendungsfall. Das Register kann weitere Felder zurückgeben, die im gekürzten Beispiel nicht enthalten sind.

Anforderungen für den ausgewählten Anwendungsfall laden

Nachdem ein Kunde einen der zurückgegebenen Werte für den Anwendungsfall ausgewählt hat, rufen Sie /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} für dieselbe Marke ab. Diese Antwort liefert die Grenzen für untergeordnete Anwendungsfälle und betreiberspezifische Anforderungen. Nutzen Sie sie, um Nachrichtenbeispiele, Einwilligungen und weitere erforderliche Erklärungen einzuholen. Die Liste der zulässigen Anwendungsfälle allein reicht nicht aus, um eine vollständige Kampagnenregistrierung zusammenzustellen.

Kontopreise gesondert prüfen

Anbieterfelder wie monthlyFee, quarterlyFee oder annualFee beschreiben, sofern sie zurückgegeben werden, Metadaten zu Anbietergebühren. Sie ersetzen weder den für das Kundenkonto geltenden Preis noch die Registrierungsbedingungen. Das aktuelle Portal liest die Endkundenpreise für Kampagnen gesondert aus und kombiniert sie für die Prüfungsansicht mit den Daten zu zulässigen Anwendungsfällen. Leiten Sie aus den fest codierten Preisen der alten Enum-Hilfsfunktion keine dem Kunden zu berechnende Gebühr ab.

Bei Änderungen der Marke oder des Anwendungsfalls aktualisieren

Verwerfen Sie beim Wechsel der Marke die Auswahlmöglichkeiten der vorherigen Marke und laden Sie die zulässigen Anwendungsfälle für die neue Auswahl. Aktualisieren Sie vor dem Absenden die Anforderungen des ausgewählten Anwendungsfalls. Diese GET-Anfragen reichen keine Registrierung ein, aktivieren keine Kampagne und weisen keine Rufnummern zu.

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 der Markenkennung im URL-Pfad. Ein Anfragetext ist nicht erforderlich.

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

Antwort

Die aktuelle TCR-Route gibt den JSON-Antworttext des Registers direkt zurück und behält dessen HTTP-Status bei. Sie fügt keine bisherige status/response-Hülle aus v3 hinzu. Das gekürzte, fiktive Beispiel ist kein aktuelles Abfrageergebnis zu zulässigen Anwendungsfällen. Prüfen Sie vor der Verwendung den HTTP-Status und die erwartete JSON-Struktur. Das aktuelle Portal erwartet eine Liste von Datensätzen zu zulässigen Anwendungsfällen, die jeweils einen usecase angeben. Es kombiniert diese Datensätze mit dem usecase-Katalog, um Anzeigebezeichnungen zu erhalten, und liest Endkundenpreise gesondert aus. Zusätzliche Anbieterfelder können vorhanden sein.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

[
  {
    "usecase": "2FA"
  }
]

Fehler

• 401: Die Kontoauthentifizierung ist fehlgeschlagen. Prüfen Sie die API-Zugangsdaten, den Aktivierungsstatus und die geltenden Einschränkungen für Quell-IP-Adressen.
• 404: Die Marke ist dem authentifizierten Konto nicht zugeordnet, oder der Anbieter kann die angeforderte Marke oder Auswahl nicht finden. Eine lokale Ablehnung aufgrund fehlender Kontozugehörigkeit wird zurückgegeben, bevor eine Anfrage an den Anbieter erfolgt.
• Weitere Registerfehler: Der HTTP-Status und der Antworttext des vorgelagerten Dienstes bleiben erhalten. Ein ungültiger oder nicht verfügbarer Anwendungsfall ist kein erfolgreich zurückgegebener leerer Anforderungssatz.
• 429: Das Anfragelimit des Kontos oder das gemeinsam genutzte Anfragelimit des Anbieters wurde erreicht. Beachten Sie Retry-After.
• 502/503: Transportfehler oder fehlende Verfügbarkeit des Anbieters oder der Anfragenbegrenzung. Behalten Sie die Formulareingaben bei und wiederholen Sie die Anfrage mit zunehmenden Wartezeiten.

Verfügbarkeit und Nebeneffekte

• Die geprüfte GET-Anfrage prüft die bestehende Kontozugehörigkeit der Marke, kontaktiert das Register und schreibt Auditprotokolle zur Anfrage. Sie erstellt weder eine Marke noch eine Kampagne und erhebt keine Registrierungsgebühr.
• Metadaten zu Anbietergebühren sind kein Endkundenpreisangebot für MultiTEL-Kunden. Das Portal prüft die Kontopreise gesondert vor einer späteren Registrierungsanfrage.
• Zulässige Anwendungsfälle und Anforderungen können sich ändern. Aktualisieren Sie sie vor dem Absenden für die ausgewählte Marke und den ausgewählten Anwendungsfall. Eine erfolgreiche Abfrage ist weder eine Kampagnenfreigabe noch eine Rufnummernzuweisung oder eine Erlaubnis, mit dem Nachrichtenversand zu beginnen.