Création d'une marque RCS et d'un agent à l'aide de l'API du gestionnaire de canaux

Pour utiliser l'offre RCS de Vonage, une marque doit enregistrer certaines métadonnées au niveau de la marque, puis créer un agent qui représente la marque dans RCS, le faire vérifier, puis l'utiliser dans l'API Messages lors de l'envoi de messages RCS. L'API Channel Manager fournit des points de terminaison pour gérer ces entités (marque, agent) de manière programmatique.

Ce guide vous accompagne :

  • Quelles sont les conditions préalables à remplir ?
  • Les points finaux de la gestion de la marque : ce qu'ils font, quelles sont les données requises.
  • Les points d'extrémité de la gestion des agents : ce qu'ils font, quelles sont les données requises.
  • Le flux de travail complet de l'accueil : étapes, transitions d'état.

Conditions préalables

Avant de commencer à utiliser les points d'extrémité de l'API, assurez-vous de ce qui suit :

  • Vous avez un compte API Vonage.
  • Vous êtes autorisé à appeler les API de gestion de la marque et de gestion des agents.
  • Vous avez rassemblé toutes les métadonnées nécessaires concernant la marque ou l'agent : nom de la marque, logo, image de la bannière, site web, politique de confidentialité, conditions de service, informations sur le courrier électronique ou l'affichage, etc.
  • Vous comprenez les exigences en matière de vérification dans votre territoire cible (par exemple aux États-Unis).

Composants clés de l'API

Il existe deux entités principales :

  • Marque : représente votre organisation (entreprise, identité de la marque).
  • Agent : représente l'identité de la marque lors de l'envoi de messages (nom, logo, couleur, etc.).

Points finaux de la gestion de la marque

Ces points d'accès sont utilisés pour créer ou mettre à jour l'entité Brand.

Fonctionnement Méthode et chemin HTTP Objectif
Liste des marques
GET
https://api.nexmo.com/v1/channel-manager/rcs/brands		 Listez toutes les marques sous votre Account.
Créer une marque
POST
https://api.nexmo.com/v1/channel-manager/rcs/brands		 Créer une nouvelle marque.
Mise à jour de la marque PATCH https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id Modifier le nom de la marque.
Supprimer la marque [SUPPRIMER] https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id Supprimer une marque RCS existante.

Points finaux de gestion des agents

Ces points d'extrémité sont utilisés pour créer des agents sous une marque. Un agent est ce qui est nécessaire pour envoyer le RCS en tant que marque.

Fonctionnement Méthode et chemin HTTP Objectif
Liste des agents
GET
https://api.nexmo.com/v1/channel-manager/rcs/agents		 Liste de tous les agents sous votre Account ou sous une marque.
Créer un agent
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents		 Enregistrer un agent pour une marque donnée, notamment en fournissant des actifs de marque (logo, bannière), des informations d'affichage, un numéro de téléphone, une description, etc.
Obtenir un agent
GET
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id		 Récupérer les métadonnées de l'agent, son statut, la marque associée, etc.
Agent de mise à jour
PUT
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id		 Modifier les métadonnées de l'agent, les images, éventuellement le numéro de téléphone, la description. Certains champs peuvent être verrouillés après vérification.
Mise à jour partielle Agent PATCH https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id Mise à jour partielle d'un agent RCS existant.
Obtenir des transporteurs
GET
https://api.nexmo.com/v1/channel-manager/rcs/metadata/carriers		 Récupérer la liste du transporteur.
Ajouter des transporteurs à l'agent
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/carriers		 Ajouter des transporteurs à un agent RCS existant.
Ajouter des dispositifs de test à l'agent
POST
https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices		 Ajouter des dispositifs de test à un agent RCS existant.
Retirer le dispositif de test de l'agent [SUPPRIMER] https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id Supprimer un dispositif de test d'un agent RCS existant.

Flux de travail pour l'accueil des nouveaux arrivants

Il s'agit du flux d'intégration typique pour la mise en place des points de terminaison de la marque et de l'agent :

  1. Créer une marque

Commencez par créer une marque avec le POST /v1/channel-manager/rcs/brands point de terminaison. Dans cette requête, vous enregistrez votre nom de marque. Une fois la marque créée, l'API renvoie un fichier brand_id à laquelle vous devez faire référence dans toutes les étapes suivantes.

  1. Créer un agent

Lorsque la marque existe, vous créez un agent en appelant la fonction POST /v1/channel-manager/rcs/agents point final. L'agent représente le profil en contact avec le client qui délivrera les messages RCS au nom de votre marque. Dans cette demande, vous fournissez le brand_id ainsi que le nom d'affichage de l'agent, sa description, ses images et ses coordonnées. L'API répond par un agent_idqui devient l'identifiant de toutes les opérations effectuées sur l'agent.

  1. Ajouter des numéros de test

Additionnez les numéros de test à l'aide de la fonction POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices point final. Ces chiffres vous permettent de tester l'expérience de l'agent avant sa mise en service.

  1. Agent de lancement

Lancer l'agent en utilisant PUT /v1/channel-manager/rcs/agents/:agent_id ou en utilisant PATCH /v1/channel-manager/rcs/agents/:agent_id et en fournissant des informations pertinentes.

Note : Vous ne pouvez modifier l'agent que jusqu'à ce qu'il soit lancé. Après le lancement, veuillez contacter votre Account Manager ou l'assistance Vonage pour toute autre modification.

  1. Sélectionner les transporteurs

Sélectionnez les transporteurs qui doivent accueillir l'agent en appelant la fonction POST /v1/channel-manager/rcs/agents/{agentId}/carriers . Dans cette demande, vous spécifiez la liste des identifiants de l'opérateur où vous souhaitez que l'agent soit lancé. Vous pouvez revoir la configuration du transporteur avec GET /v1/channel-manager/rcs/carriers.

Lorsque les opérateurs et Google approuvent l'agent, celui-ci n'est pas immédiatement disponible en production. Au lieu de cela, la demande est soumise à un examen interne par notre équipe opérationnelle, qui travaillera avec les opérateurs pour achever le lancement. Le processus prend généralement de 4 à 8 semaines, après quoi vous pouvez commencer à utiliser l'agent en tant qu'expéditeur dans l'API Messages pour envoyer des messages RCS à vos clients.

Maintenance continue

Si certaines métadonnées doivent être mises à jour (logo, description), vérifiez quels champs sont modifiables après la vérification ou contactez votre Account Manager. Certains peuvent être verrouillés.

Statut des agents

Statut Description
DRAFT Statut temporaire pendant une brève période après l'envoi des informations sur l'agent, pendant que les processus d'arrière-plan sont lancés. Le dossier de l'agent est incomplet pendant cette phase.
CREATED Le dossier de l'agent est complet et stocké en toute sécurité dans le système.
PENDING L'agent a été soumis pour vérification. Les opérateurs et Google examinent la marque. L'agent n'est pas disponible pour le lancement tant qu'il n'a pas passé toutes les vérifications.
REJECTED L'agent n'a pas réussi le processus de vérification et ne peut pas être lancé.
LAUNCHED L'agent a passé tous les contrôles de vérification et a reçu l'approbation des opérateurs et de Google. Il est désormais actif et peut être utilisé comme expéditeur dans Messages API pour les conversations RCS.

Pour en savoir plus

Guide de l'agent RCS
Référence API du gestionnaire de canaux