RCS Brand und Agent Builder mit Channel Manager API

Um das RCS-Angebot von Vonage zu nutzen, muss eine Marke einige Metadaten auf Markenebene registrieren, dann einen Agenten erstellen, der die Marke in RCS repräsentiert, ihn verifizieren lassen und ihn dann in der Messages API beim Senden von RCS-Nachrichten verwenden. Die Channel Manager API bietet Endpunkte für die programmatische Verwaltung dieser Entitäten (Marke, Agent).

Dieser Leitfaden hilft Ihnen dabei:

  • Welche Voraussetzungen müssen erfüllt sein?
  • Die Endpunkte des Markenmanagements: was sie tun, welche Daten erforderlich sind.
  • Die Endpunkte der Agentenverwaltung: was sie tun und welche Daten erforderlich sind.
  • Der vollständige Onboarding-Workflow: Schritte, Statusübergänge.

Voraussetzungen

Bevor Sie mit den API-Endpunkten beginnen, stellen Sie sicher, dass:

  • Sie haben einen Vonage API Account.
  • Sie sind berechtigt, Brand Management und Agent Management APIs aufzurufen.
  • Sie haben alle erforderlichen Metadaten der Marke/des Agenten erfasst: Markenname, Logo, Bannerbild, Website, Datenschutzbestimmungen, Nutzungsbedingungen, E-Mail-/Anzeige-Informationen usw.
  • Sie kennen die Überprüfungsanforderungen in Ihrem Zielgebiet (z. B. in den USA).

Wichtige API-Komponenten

Es gibt zwei Haupteinheiten:

  • Marke: repräsentiert Ihre Organisation (Unternehmen, Markenidentität).
  • Agent: repräsentiert die Identität der Marke beim Senden von Nachrichten (Name, Logo, Farbe usw.).

Endpunkte des Markenmanagements

Diese Endpunkte werden zur Erstellung oder Aktualisierung der Entität Marke verwendet.

Operation HTTP-Methode und Pfad Zweck
Marken auflisten
GET
https://api.nexmo.com/v1/channel-manager/rcs/brands		 Listen Sie alle Marken unter Ihrem Account auf.
Marke erstellen
POST
https://api.nexmo.com/v1/channel-manager/rcs/brands		 Schaffen Sie eine neue Marke.
Marke aktualisieren PATCH https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id Ändern Sie den Markennamen.
Marke löschen
DELETE
https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id		 Löschen Sie eine bestehende RCS-Marke.

Endpunkte der Agentenverwaltung

Diese Endpunkte werden verwendet, um Agenten unter einer Marke zu erstellen. Ein Agent ist erforderlich, um RCS als Marke zu senden.

Operation HTTP-Methode und Pfad Zweck
Liste Agenten
GET
https://api.nexmo.com/v1/channel-manager/rcs/agents		 Listen Sie alle Agenten unter Ihrem Account oder unter einer Marke auf.
Agent erstellen
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents		 Registrierung eines Agenten für eine bestimmte Marke, einschließlich der Bereitstellung von Branding-Assets (Logo, Banner), Anzeigeinformationen, Telefonnummer, Beschreibung usw.
Agent holen
GET
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id		 Abrufen der Metadaten des Agenten, des Status, der zugehörigen Marke usw.
Agent aktualisieren
PUT
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id		 Metadaten des Agenten, Bilder, eventuell Telefonnummer und Beschreibung ändern. Einige Felder können nach der Überprüfung gesperrt werden.
Teilweise aktualisieren Agent PATCH https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id Teilweise Aktualisierung eines bestehenden RCS-Agenten.
Träger erhalten
GET
https://api.nexmo.com/v1/channel-manager/rcs/metadata/carriers		 Holen Sie die Liste der Fluggesellschaften ab.
Spediteure zum Agenten hinzufügen
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/carriers		 Hinzufügen von Trägern zu einem bestehenden RCS-Agenten.
Testgeräte zum Agenten hinzufügen
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices		 Hinzufügen von Testgeräten zu einem bestehenden RCS-Agenten.
Testgerät vom Agenten entfernen
DELETE
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id		 Entfernen Sie ein Testgerät aus einem vorhandenen RCS-Agenten.

Onboarding-Workflow

Dies ist der typische Onboarding-Fluss für die Zusammenstellung von Marken- und Agentenendpunkten:

  1. Marke erstellen

Beginnen Sie mit der Schaffung einer Marke mit dem POST /v1/channel-manager/rcs/brands Endpunkt. In dieser Anfrage registrieren Sie Ihren Markennamen. Sobald die Marke erstellt ist, gibt die API eine brand_id auf die Sie sich in allen nachfolgenden Schritten beziehen müssen.

  1. Agent erstellen

Wenn die Marke existiert, erstellen Sie einen Agenten, indem Sie die Funktion POST /v1/channel-manager/rcs/agents Endpunkt. Der Agent stellt das kundenorientierte Profil dar, das RCS-Nachrichten im Namen Ihrer Marke zustellen wird. In dieser Anfrage geben Sie die brand_id zusammen mit dem Anzeigenamen, der Beschreibung, den Bildern und den Kontaktinformationen des Agenten. Die API antwortet mit einer agent_idder zum Bezeichner für alle Operationen mit dem Agenten wird.

  1. Test-Nummern hinzufügen

Fügen Sie Testnummern mit Hilfe der POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices Endpunkt. Anhand dieser Numbers können Sie das Agentenerlebnis testen, bevor es in Betrieb geht.

  1. Launch Agent

Starten Sie den Agenten mit PUT /v1/channel-manager/rcs/agents/:agent_id oder mit PATCH /v1/channel-manager/rcs/agents/:agent_id und durch die Bereitstellung relevanter Informationen.

Hinweis: Sie können den Agenten nur bearbeiten, bis er gestartet wurde. Nach dem Start wenden Sie sich bitte an Ihren Account Manager oder den Vonage Support, wenn Sie weitere Änderungen vornehmen möchten.

  1. Transportunternehmen auswählen

Wählen Sie die Träger, die den Agenten beherbergen sollen, indem Sie die Funktion POST /v1/channel-manager/rcs/agents/{agentId}/carriers Endpunkt. In dieser Anforderung geben Sie die Liste der Träger-IDs an, unter denen der Agent gestartet werden soll. Sie können die Trägerkonfiguration mit GET /v1/channel-manager/rcs/carriers.

Wenn die Netzbetreiber und Google den Agenten genehmigen, wird dieser nicht sofort in der Produktion verfügbar gemacht. Stattdessen wird der Antrag zur internen Prüfung durch unser Betriebsteam weitergeleitet, das mit den Betreibern zusammenarbeitet, um die Einführung abzuschließen. Dieser Prozess dauert in der Regel 4-8 Wochen. Danach können Sie den Agenten als Absender in der Messages API verwenden, um RCS-Nachrichten an Ihre Kunden zu übermitteln.

Laufende Wartung

Wenn einige Metadaten aktualisiert werden müssen (Logo, Beschreibung), prüfen Sie, welche Felder nach der Überprüfung bearbeitet werden können, oder wenden Sie sich an Ihren Account Manager. Einige können gesperrt sein.

Status der Agenten

Status Beschreibung
DRAFT Vorübergehender Status für einen kurzen Zeitraum nach Übermittlung der Agenteninformationen, während Backend-Prozesse eingeleitet werden. Der Agentendatensatz ist in dieser Phase unvollständig.
CREATED Der Datensatz des Agenten ist vollständig und sicher im System gespeichert.
PENDING Der Agent wurde zur Überprüfung eingereicht. Die Betreiber und Google prüfen die Marke. Der Agent bleibt für den Start nicht verfügbar, bis er alle Prüfungen bestanden hat.
REJECTED Der Agent hat den Verifizierungsprozess nicht bestanden und kann nicht gestartet werden.
LAUNCHED Der Agent hat alle Verifizierungsprüfungen bestanden und die Genehmigung von Netzbetreibern und Google erhalten. Er ist jetzt aktiv und kann als Absender in der Messages API für RCS-Konversationen verwendet werden.

Weitere Lektüre

RCS Agent Builder Anleitung
Kanalmanager-API-Referenz