Flux d'inscription intégré à WhatsApp pour les partenaires techniques

Le flux d'inscription intégré hébergé par WhatsApp est une interface utilisateur d'inscription en marque blanche. Elle permet aux partenaires de Vonage d'intégrer leurs clients aux comptes WhatsApp Business sans avoir à créer, configurer ou héberger leur propre flux d'inscription intégré.

Conditions préalables

Afin de tirer parti de la solution d'inscription intégrée, les partenaires de Vonage doivent remplir les conditions préalables suivantes :

• S'enregistrer auprès de Meta en tant que fournisseur de technologie
• Faire vivre une métaapplication sur le tableau de bord des applications
• Disposer d'un "contrôle total" ou d'autorisations d'administration dans le portefeuille d'activités dans lequel un numéro WABA ou WhatsApp doit être intégré.
• Avoir soumis une demande de solution à Vonage, que la demande ait été acceptée et qu'un identifiant de solution ait été fourni.

Si vous avez des questions sur l'une des conditions préalables énumérées ci-dessus ou si vous avez besoin d'aide, veuillez contacter votre Account Manager de Vonage.

Déroulement du processus

Le processus d'inscription à WhatsApp Hosted Embedded est le suivant :

1. Le partenaire Vonage génère une URL d'inscription intégrée.
2. Le partenaire peut partager l'URL avec ses clients (par exemple par courrier électronique ou SMS, ou en intégrant l'URL sur sa propre page web).
3. L'URL dirige le client vers une expérience de flux d'inscription intégrée en marque blanche hébergée par Vonage, par le biais de laquelle l'enregistrement du WhatsApp Business Account (WABA) ou de l'onboarding du numéro WhatsApp peut être effectué
4. Le client complète le processus d'accueil en utilisant le flux d'inscription intégré.

Générer une URL d'inscription intégrée

Une URL d'inscription intégrée peut être générée en envoyant une requête POST à l'adresse Générer le point d'extrémité de l'URL du flux ES hébergé de la API du gestionnaire de canaux.

L'authentification peut se faire via l'authentification de base ou l'authentification par jeton porteur (JWT).

Le corps de la demande doit contenir un objet JSON avec, au minimum, un élément solution_id dont la valeur est l'identifiant de la solution fourni par Vonage (voir conditions préalables).

Le corps peut également contenir un api_key pour identifier le sous-compte Vonage du client pour lequel le partenaire souhaite créer l'URL (si cette propriété est omise, la clé API principale du compte Vonage primaire est utilisée).

A ttl peut également être spécifiée pour fixer une limite de temps à la validité de l'URL générée (Max 3 jours; en cas d'omission, la validité par défaut de 86400 secondes, ou un jour, est utilisée).

Exemple de corps de requête

{
  "solution_id": "123456789111213",
  "api_key": "abc123", // Optional
  "ttl": 3600 // Optional
}

Exemple de corps de réponse

Une réponse réussie renvoie un code d'état HTTP de 200 et inclure un corps de réponse avec un objet JSON qui contient l'URL d'inscription intégrée générée, ainsi qu'un identifiant de trace pour la demande.

{
  "id": "3amb0119-0196-42d1-8fb5-55a98s133546",
  "url": "https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8Ds"
}

Vérifier l'état du numéro de vérification du téléphone WhatsApp

Dans le cadre du processus d'enregistrement du numéro WhatsApp, un mot de passe à usage unique (OTP) sera envoyé au numéro enregistré afin de le vérifier. La vérification doit être effectuée avec succès avant que le numéro ne soit utilisé.

L'état de la vérification du numéro peut être contrôlé de la manière suivante :

• Vérification manuelle de l'état d'un numéro
• S'abonner aux mises à jour concernant un numéro

Vérification manuelle de l'état d'un numéro

Pour vérifier manuellement le statut d'un numéro, vous pouvez vous rendre dans l'interface du gestionnaire WhatsApp de votre WABA. Un numéro actif affichera un statut de Connecté.

S'abonner aux mises à jour concernant un numéro

Vous pouvez vous abonner aux mises à jour concernant le changement de statut de vérification d'un numéro en utilisant la fonction Abonnements aux notifications de WhatsApp.

Des abonnements peuvent être créés pour de nombreux événements différents ; vous trouverez plus d'informations à ce sujet dans la rubrique Document du guide sur les abonnements aux notifications de WhatsApp. Pour les mises à jour de l'état des numéros, vous devez créer un abonnement avec l'option account_update dans la rubrique whatsapp_subscribe_typesainsi que le vonage_number_onboarded dans la rubrique vonage_subscribe_types.

La notification est déclenchée par un PARTNER_ADDED et est envoyé au webhook ou au hook Slack que vous avez spécifié lors de la création de l'abonnement. La charge utile de la notification comprendra l'élément waba_id, solution_idet owner_business_id détails.

La charge utile d'un POST à l'adresse suivante https://api.nexmo.com/v2/whatsapp-manager/subscriptions ressemblerait à ce qui suit :

{
  "type": "webhook",
  "label": "#dk-test",
  "whatsapp_subscribe_types": "account_update", // or can be left blank ""
  "vonage_subscribe_types": "vonage_number_onboarded",
  "webhook": {
      "url" : "https://eo34s4y0tl.m.pipedream.net"
  }
}

Lier un numéro WhatsApp à une application Vonage

Pour que le numéro WhatsApp puisse être utilisé pour envoyer des messages via l'API Messages de Vonage, il doit être lié à une application Vonage.

Cela peut se faire par l'intermédiaire de l'option Tableau de bord Vonage ou par l'intermédiaire du Lier l'application à un point de terminaison de l'Account de la API Comptes externes.

Notes pour les partenaires

• Aucune activation séparée n'est requise pour qu'un partenaire/fournisseur technique de Vonage utilise le flux d'inscription intégré hébergé. Il est possible d'y accéder à l'aide de la page principale du site Web de Vonage. api-key et les informations d'identification associées.
• Seuls les WhatsApp Business Accounts (WABA) "partagés" des clients peuvent intégrer de nouveaux numéros WhatsApp via le flux d'inscription intégré hébergé ou tout autre flux d'inscription intégré. Pour les WABA OBO, l'onboarding manuel doit être utilisé. Veuillez consulter la page Méta-documentation pour plus de détails sur OBO et les WABA partagées.
• Les partenaires/fournisseurs de technologie de Vonage doivent s'assurer que leur(s) client(s) utilisant le flux hébergé intégré ont rempli et complété les détails de l'entreprise dans la section Info sur le portefeuille d'affaires. Si l'un des détails requis, par exemple le courriel professionnel de l'utilisateur, n'est pas valide, le processus d'intégration est susceptible d'échouer.
• Lors de l'enregistrement d'un numéro WhatsApp, le temps de réponse attendu de l'API Meta peut aller jusqu'à 120 secondes.
• Les tentatives d'enregistrement ou de désenregistrement pour chaque numéro WhatsApp sont limitées par Numbers (10 tentatives par numéro et par semaine). Après avoir atteint cette limite, le numéro sera bloqué pour l'enregistrement.