API On-Premises de la plateforme WhatsApp Business

Compte

/v1/account

Nous entamons l’abandon progressif de l’API On-Premises. Ce point de terminaison ne peut plus être utilisé pour enregistrer des numéros de téléphone professionnels et renvoie désormais l’erreur suivante :

{
  "code": 1005,
  "title": "Access denied",
  "details": "Unknown error: biz_link_on_prem_reg_blocked"
}

Le nœud account permet d’inscrire votre client de l’API WhatsApp Business.

Veuillez noter que le Coreapp redémarrera si un nouveau numéro est enregistré dans un ensemble contenant un numéro déjà enregistré.

Arêtes

Les arêtes ci-dessous sont connectées à ce nœud :

ArêteDescription

/verify

Une fois le code d’inscription reçu via la méthode que vous avez spécifiée, terminez l’inscription de votre compte à l’aide de cette arête.

Avant de commencer

Vous aurez besoin des éléments suivants :

Copier le certificat encodé au format Base64

Une chaîne représentant le certificat encodé au format Base64 est générée pour vous. Elle sert à la validation au cours de l’inscription du client de l’API WhatsApp Business.

  1. Accédez aux Paramètres de l’entreprise dans votre Meta Business Manager.
  2. Dans le menu Comptes, cliquez sur Comptes WhatsApp, puis sélectionnez votre compte WhatsApp dans la liste Comptes WhatsApp, s’il n’a pas déjà été mis en surbrillance.
  3. Accédez à l’onglet Paramètres, puis cliquez sur le bouton Gestionnaire WhatsApp.
  4. Sous l’onglet Numéros de téléphone, vous devriez voir les numéros figurant dans la liste. Cliquez sur le bouton Voir en regard du numéro de téléphone pour lequel vous souhaitez obtenir le certificat.
    Obtenir le certificat
  5. La chaîne de certificat s’affichera sur fond gris dans une boîte de dialogue. Cliquez sur Obtenir le certificat.
    Téléchargez la chaîne du certificat
  6. Utilisez cette chaîne du certificat dans le paramètre cert lors de l’inscription sur le point de terminaison account.

Pour en savoir plus, consultez la documentation sur le nom d’usage.

Contraintes

  • Vous devez utiliser le compte admin pour inscrire l’application.
  • Si vous réinscrivez votre compte, le Coreapp doit être redémarré une fois l’inscription terminée.

Demande

Pour demander un code d’inscription, effectuez un appel POST vers ce point de terminaison. Dans votre appel, ajoutez votre numéro de téléphone et votre chaîne du certificat encodé au format Base64. Vous pouvez recevoir votre code par SMS ou appel vocal.

Exemple

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.
{
  "account": [{
      "vname": "decoded-vname-from-cert"
  }]
}

Si des erreurs sont renvoyées, consultez la rubrique Messages d’erreur et d’état pour en savoir plus.

Paramètres

NomDescription

cc

Obligatoire.

Indicatif numérique du pays pour le numéro de téléphone que vous souhaitez inscrire

phone_number

Obligatoire.

Numéro de téléphone que vous souhaitez inscrire, sans l’indicatif du pays ni le symbole Plus (+)

method

Obligatoire.

Méthode de réception de votre code d’inscription
Options : voice, sms

cert

Obligatoire.

Certificat encodé au format Base64

pin

Facultatif.

Code PIN à six chiffres existant : ce dernier n’est requis que lorsque la validation en deux étapes est activée pour ce compte.

Modifier votre code PIN de vérification en deux étapes

Pour modifier le code PIN de vérification en deux étapes de votre numéro de téléphone professionnel :

  1. Chargez votre portefeuille business dans le Gestionnaire WhatsApp.
  2. Si le panneau Numéros de téléphone n’est pas chargé automatiquement, accédez à Outils du compte (icône de boîte à outils) > Numéros de téléphone.
  3. Cliquez sur l’icône en forme d’engrenage pour accéder aux paramètres du numéro de téléphone.
  4. Cliquez sur Vérification en deux étapes.
  5. Cliquez sur Changer le code PIN et suivez les instructions.

Vous devez fournir votre code PIN actuel pour le changer. Notez que vous pouvez aussi définir un nouveau code PIN via nos API :

Désactivation de la vérification en deux étapes

Pour désactiver la vérification en deux étapes, suivez les instructions pour changer de code PIN, mais cliquez sur le bouton Désactiver la vérification en deux étapes à la fin du processus. Un e-mail contenant un lien sera envoyé à l'adresse e-mail associée à votre portefeuille business. Utilisez ce lien pour désactiver la vérification en deux étapes. Une fois la vérification en deux étapes désactivée, vous pouvez la réactiver en définissant un nouveau code PIN.

Questions/réponses

Oui, nous pouvons configurer un nouveau numéro de téléphone ou modifier le nom vérifié lorsque vous êtes prêt à lancer un direct.

Permalien

Les numéros gratuits sont autorisés à condition que votre indicatif pays existe. Les numéros gratuits sans indicatif pays ne peuvent pas être identifiés. Le même numéro peut s’appliquer à deux pays différents.

Veuillez noter qu’il existe également des complexités supplémentaires en ce qui concerne les numéros gratuits. Généralement, si vous composez un numéro gratuit avec l’indicatif pays lorsque vous êtes dans ce pays, cela ne fonctionnera pas. En d’autres termes, il est possible que les clients issus de votre pays essaient de composer le numéro indiqué dans votre fiche de contact professionnel (indicatif pays inclus) et que cela ne fonctionne pas. Si cela devient problématique, vous devrez leur expliquer clairement.

Pour en savoir plus sur les numéros gratuits, cliquez ici.

Permalien

Si vous sauvegardez votre configuration actuelle et la restaurez sur le nouvel ordinateur, les informations d’enregistrement devraient être transférées avec le reste de votre implémentation. Consultez la documentation Paramètres de sauvegarde et de restauration pour plus d’informations.

Permalien

Vous pouvez enregistrer de nouveaux numéros de téléphone et supprimer les anciens dans votre compte WhatsApp dans Facebook Business Manager.

  1. Dans votre compte WhatsApp, accédez à Paramètres.
  2. Cliquez sur Gestionnaire WhatsApp.
  3. Sélectionnez l’onglet Numéros de téléphone. Vous pourrez gérer tous les numéros de téléphone de ce compte.
Permalien

Si l’enregistrement par texto échoue à cause d’un trop grand nombre de tentatives et que le message « accès refusé » s’affiche, essayez de vous enregistrer par le biais d’un appel.

Permalien

Malheureusement, vous devrez choisir un autre numéro de téléphone pouvant recevoir des textos ou des appels afin que nous puissions vous envoyer le code d’enregistrement. Par le passé, les codes d’enregistrement manuels étaient autorisés mais ceux-ci ne sont plus pris en charge. Les numéros de téléphone ayant utilisé des codes d’enregistrement manuels continueront à être pris en charge si nécessaire. Pour tout nouveau numéro de téléphone, les codes d’enregistrement ne seront transmis que par le biais d’un appel ou d’un texto.

Consultez ce guide, si vous souhaitez utiliser un numéro de téléphone 1800 ou un numéro de téléphone gratuit.

Permalien

En savoir plus