API Cloud

Plateforme WhatsApp Business > API Cloud > Guides

Migrer de l’API Cloud vers l’API On-Premises

L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.

Ce document explique comment migrer les numéros de téléphone professionnels de l’API Cloud à l’API On-Premises. Pour migrer de l’API On-Premises vers l’API Cloud, consultez Migrer de l’API On-Premises vers l’API Cloud.

Notez que la migration d’un numéro de téléphone professionnel d’une API à une autre diffère de sa migration d’un compte WhatsApp Business à un autre.

La migration N’A PAS d’incidence sur les éléments suivants :

  • le nom à l’écran, le statut de vérification ou l’évaluation de qualité du numéro de téléphone professionnel
  • les modèles utilisés par le numéro de téléphone professionnel ou leurs statuts
  • le compte WhatsApp Business détenteur, son statut de compte business officiel ou sa limite en matière de messages

Avant d’effectuer une migration, toutefois, vous devez connaître les éventuelles différences entre les API et prendre les mesures qui s’imposent avant de passer à la procédure de migration décrite dans ce document.

Recommandations

Une fois que vous vous êtes assuré·e que votre application peut gérer toutes les différences entre les API, il est recommandé de commencer par migrer un numéro de téléphone professionnel peu utilisé et de vérifier que toutes les fonctionnalités que vous comptez proposer avec l’API On-Premises fonctionnent correctement. Cela fait, vous pourrez migrer d’autres numéros.

Nous vous recommandons également de migrer vos numéros de téléphone lorsque le trafic vers votre API On-Premises est faible.

Différences entre les API

Vérifiez que votre application peut gérer ces différences avant de commencer le processus de migration.

Webhooks

Les structures de charge utile des webhooks des API Cloud et Business Management diffèrent de celles de l’API On-Premises. Nous vous recommandons de créer un nouveau point de terminaison webhook qui peut gérer exclusivement les webhooks de l’API On-Premises.

Consultez les documents suivants pour mieux comprendre les différences de charges utiles :

Notez qu’une fois la migration vers l’API On-Premises terminée, les webhooks de l’API Cloud correspondant au numéro de téléphone professionnel ne seront plus diffusés et la distribution des webhooks de l’API On-Premises commencera.

Contenu multimédia

Vous ne pouvez pas utiliser les ID des contenus multimédias importés dans l’API Cloud lors de l’envoi de messages avec l’API On-Premises. Vous devez donc réimporter le contenu à l’aide de l’API On-Premises pour générer les nouveaux ID, ou utiliser l’URL des contenus si ces derniers sont hébergés sur un serveur public. Consultez Envoi de messages multimédias.

Codes d’erreur

Les codes d’erreur des API Cloud et Business Management diffèrent de ceux de l’API On-Premises. Reportez-vous aux documents suivants :

Messages Appuyer pour parler

L’API On-Premises identifie les messages Appuyer pour parler (Push-To-Talk, PTT) des webhooks lorsque messages.type est défini sur voice, mais l’API Cloud les identifie lorsque messages.audio.voice est configuré sur true.

Temps d’inactivité

L’inactivité commence dès que vous effectuez l’enregistrement (étape 3) et ne doit durer que quelques secondes. Pendant ce laps de temps, les messages que les utilisateur·ices WhatsApp envoient au numéro sont ignorés en silence.

Nous vous recommandons vivement de planifier la migration durant les heures creuses d’utilisation du numéro afin de minimiser l’impact du temps d’inactivité.

Étape 1 : Intégrer l’API On-Premises

Dans la mesure où vous migrez un numéro de téléphone professionnel vers l’API On-Premises, assurez-vous que votre application utilise bien le client de l’API On-Premises et que les webhooks du compte WhatsApp Business associé au numéro de téléphone professionnel sont correctement configurés.

Étape 2 : Se préparer à la migration

Nous vous recommandons de cesser l’envoi de messages le temps de la migration.

Vous devez configurer certains paramètres réseau pour connecter le client de l’API WhatsApp Business On-Premises aux serveurs WhatsApp. Pour vous assurer que tout est prêt, consultez la section Configurer et débuguer votre réseau.

Étape 3 : Enregistrer le client de l’API

Enregistrez le numéro de téléphone professionnel sur le client de l’API On-Premises. Pour cela, appelez le point de terminaison /account :

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

En fonction de la réponse reçue, la procédure d’inscription peut être considérée comme terminée ou nécessiter une autre étape avant la finalisation. En cas de réussite, vous recevez l’un des codes d’état HTTP suivants. Suivez les instructions correspondant à la réponse que vous avez reçue :

  • 201 Created : le compte existe déjà. Vous êtes déjà inscrit·e, vous n’avez donc pas besoin d’effectuer une quelconque opération supplémentaire.
  • 202 Accepted : le compte n’existe pas. En fonction de la méthode sélectionnée dans la demande, consultez votre boîte de réception de textos ou d’appels vocaux pour obtenir le code d’inscription. La réponse inclura une charge utile renvoyée contenant le vname, décodé du paramètre cert, afin que vous puissiez confirmer qu’il s’agit du bon nom d’usage. Si tout est correct, passez à la section Terminer l’inscription de votre compte pour finaliser l’inscription.

Si vous souhaitez consulter tous les champs disponibles pour ce point de terminaison, cliquez ici.

Une fois l’inscription terminée, le client de l’API On-Premises sera celui qui recevra les messages.

Étape 4 : Définir des partitions

Une fois votre client enregistré, vous pouvez définir des partitions si nécessaire.

Étape 5 : Commencer à envoyer des messages

Tout est prêt pour envoyer des messages à votre clientèle. Consultez le guide Envoyer des messages pour plus de conseils.