Numéros de téléphone pré-vérifiés

Ce document vous explique la marche à suivre pour proposer à vos clients finaux et clientes finales des numéros de téléphone professionnels pré-vérifiés dans la nouvelle procédure Inscription intégrée. Les numéros de téléphone professionnels pré-vérifiés sont des numéros de téléphone d’entreprise que vous avez déjà vérifiés, et qui évitent à vos clients finaux et clientes finales d’avoir à vous contacter pour obtenir un mot de passe à usage unique.

Screenshot of pre-verifed phone numbers in Embedded Signup flow

Notez que ces numéros de téléphone sont représentés par des objets Numéro de téléphone pré-vérifié WhatsApp Business, qui sont temporaires. Lorsqu’un client ou une cliente final·e sélectionne un de ces numéros et termine la nouvelle procédure d’inscription intégrée, l’objet temporaire est remplacé par un objet Numéro de téléphone WhatsApp Business dont vous devez impérativement récupérer l’ID pour enregistrer le numéro.

Conditions requises

Restrictions

  • Uniquement disponible dans le cadre de la nouvelle procédure Inscription intégrée. Pour savoir comment activer cette dernière, consultez le document Intégrer le flux d’inscription.
  • Il vous incombe de garder une trace des entreprises qui réclament un numéro de téléphone professionnel pré-vérifié.
  • Si un numéro professionnel pré-vérifié n’est pas réclamé dans le cadre du flux d’inscription intégrée dans les 90 jours suivant la vérification, son statut redevient « non vérifié » et il doit faire l’objet d’une nouvelle vérification pour retrouver son statut pendant 90 jours supplémentaires.
  • Les numéros de téléphone professionnels pré-vérifiés qui ne sont pas réclamés ne peuvent pas être re-vérifiés pendant les 45 jours précédant le rétablissement de leur statut « non vérifié ». Ce temps est indiqué par le champ verification_expiry_time.
  • Si vous ne vérifiez pas les numéros de téléphone dans les 90 jours (étape 3) suivant leur ajout à votre pool de numéros pré-vérifiés (étape 1), ceux-ci sont supprimés de votre pool et vous devrez de nouveau les ajouter.

Création de numéros pré-vérifiés

Suivez ces étapes pour créer un numéro de téléphone professionnel pré-vérifié, le faire apparaître dans l’inscription intégrée et l’enregistrer après qu’il a été réclamé par un client ou une cliente final·e.

Étape 1 : Créer un numéro de téléphone professionnel pré-vérifié

Utilisez le point de terminaison Compte business > Ajouter des numéros de téléphone pour créer un numéro de téléphone professionnel pré-vérifié sur votre entreprise. Cela l’ajoute à votre pool de numéros.

Syntaxe de la requête

POST /<BUSINESS_ACCOUNT_ID>/add_phone_numbers
  ?phone_number=<PHONE_NUMBER>

Réponse

En cas de réussite, l’API renvoie un ID de numéro de téléphone pré-vérifié WhatsApp Business. Conservez cette valeur, vous en aurez besoin dans la requête suivante.

{
  "id": "<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>"
}

Exemple de requête

curl -X POST 'https://graph.facebook.com/v19.0/506914307656634/add_phone_numbers?phone_number=15550783881' \
-H 'Authorization: Bearer EAAJB...'

Exemple de réponse

{
  "id": "106540352242922"
}

Pour connaître les formats de numéro de téléphone et les paramètres de requête pris en charge, consultez la référence sur le point de terminaison Compte business > Ajouter des numéros de téléphone.

Étape 2 : Demander un code de vérification

Utilisez le point de terminaison Numéro de téléphone pré-vérifié WhatsApp Business > Demander un code pour demander à recevoir un mot de passe à usage unique par SMS ou message vocal pour le numéro de téléphone professionnel pré-vérifié nouvellement créé.

Syntaxe de la requête

POST /<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>/request_code
  ?code_method=<CODE_METHOD>
  &language=<LANGUAGE>

Réponse

En cas de réussite, l’API renvoie true.

{
  "success": <SUCCESS>
}

Un SMS ou un message vocal fournissant un mot de passe à usage unique est en outre envoyé au numéro de téléphone. Conservez ce mot de passe pour la requête suivante.

Syntaxe du SMS contenant le mot de passe à usage unique

WhatsApp code <CODE>

Syntaxe du message vocal contenant le mot de passe à usage unique

Le message est répété trois fois.

Verification code is <CODE>

Exemple de requête

curl -X POST 'https://graph.facebook.com/v19.0/106540352242922/request_code?code_method=SMS&language=en_US' \
-H 'Authorization: Bearer EAAJB...'

Exemple de réponse

{
  "success": true
}

SMS contenant le mot de passe à usage unique

WhatsApp code 123-456

Message vocal contenant le mot de passe à usage unique

Le message est répété trois fois.

Verification code is 123456

Pour connaître les méthodes de code, les langages et les paramètres de requête pris en charge, consultez la référence sur le point de terminaison Numéro de téléphone pré-vérifié WhatsApp Business > Demander un code.

Étape 3 : Vérifier le numéro

Utilisez le point de terminaison Numéro de téléphone pré-vérifié WhatsApp Business > Vérifier le code pour vérifier le numéro de téléphone professionnel avec son mot de passe à usage unique.

Syntaxe de la requête

POST /<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>/verify_code
  ?code=<CODE>

Réponse

En cas de réussite, l’API renvoie true, et le statut code_verification_status du numéro de téléphone est défini sur VERIFIED pendant 90 jours.

{
  "success": <SUCCESS>
}

Exemple de requête

curl -X POST 'https://graph.facebook.com/v19.0/106540352242922/verify_code?code=123456' \
-H 'Authorization: Bearer EAAJB...'

Exemple de réponse

{
  "success": true
}

Pour connaître les paramètres de requête pris en charge, consultez la référence sur le point de terminaison Numéro de téléphone pré-vérifié WhatsApp Business > Vérifier le code.

Une fois qu’un numéro de téléphone professionnel pré-vérifié dispose d’un statut « vérifié » (ou un ensemble de tels numéros), affichez-le dans la nouvelle procédure d’inscription intégrée.

Afficher les numéros pré-vérifiés dans l’inscription intégrée

Vous pouvez afficher les numéros de téléphone professionnels pré-vérifiés dans la nouvelle procédure d’inscription intégrée par le biais d’un formulaire prédéfini. Pour ce faire, ajoutez un objet preVerifiedPhone avec une propriété ids à l’objet setup, puis affectez les ID de vos numéros de téléphone professionnels pré-vérifiés en tant que tableau de chaînes à la propriété ids :

{
  scope: '<SCOPE>',
  extras: {
    feature: '<FEATURE>',
    setup: {
      preVerifiedPhone: {
        ids: [<IDS>]
      }
    }
  }
}

Par exemple :

{
  scope: 'business_management,whatsapp_business_management',
  extras: {
    feature: 'whatsapp_embedded_signup',
    version: 2,
    setup: {
	business: {
	  name: 'Acme Inc.',
	  email: 'johndoe@acme.com',
	  phone: {
	    code: 1,
	    number: '6505551234'
        },
	  website: 'https://www.acme.com',
        address: {
          streetAddress1: '1 Acme Way',
          city: 'Acme Town',
          state: 'CA',
          zipPostal: '94000',
          country: 'US'
        },
        timezone: 'UTC-08:00'
      },
      phone: {
        displayName: 'Acme Inc.',
        category: 'ENTERTAIN',
        description: 'Gears and widgets'
      },
      preVerifiedPhone: {
        ids: ['106540352242922','105954558954427']
      }
    }
  }
}

Notez que si un numéro de téléphone professionnel pré-vérifié doté d’un statut VERIFIED n’est pas réclamé dans les 90 jours suivant la vérification, son statut est défini sur UNVERIFIED. Le numéro reste toutefois affiché dans la nouvelle procédure d’inscription intégrée. Si un client ou une cliente final·e tente de réclamer un numéro non vérifié, il ou elle doit procéder à une vérification, en d’autres termes, vous demander un mot de passe à usage unique.

Pour éviter ce désagrément, nous vous recommandons de noter la date de vérification d’un numéro et de le revérifier avant que son statut ne redevienne « non vérifié ».

Si vous ne savez pas à quand remonte votre dernière vérification d’un numéro de téléphone professionnel pré-vérifié, interrogez le point de terminaison Numéros de téléphone professionnels pré-vérifiés WhatsApp Business et lisez les champs code_verification_time et verification_expiry_time qui indiquent la date et l’heure de la dernière vérification et sa date d’expiration.

Déterminer si un numéro a été réclamé dans le flux d’inscription intégrée

Consultez la section Obtenir les ID de numéros de téléphone réclamés.

Obtenir les ID de numéros de téléphone réclamés

Effectuez une requête GET sur le point de terminaison Compte WhatsApp Business > Numéros de téléphone. Elle renvoie tous les numéros de téléphone WhatsApp Business d’un compte WhatsApp Business.

Recherchez la propriété display_phone_number dans chacun des objets renvoyés dans les résultats. Si la valeur display_phone_number d’un objet affiche le numéro de téléphone (ex. : 16505551234), ce dernier a été réclamé. Copiez la valeur de la propriété id de l’objet. Cette valeur correspond à l’ID du nouvel objet Numéro de téléphone WhatsApp Business désormais associé au numéro (l’ancien ID est devenu obsolète).

Vous pouvez également utiliser le même point de terminaison avec l’extension field pour demander le champ display_phone_number et spécifier le numéro de téléphone. Par exemple :

GET /102290129340398/phone_numbers?display_phone_number=16505551234

Si la requête renvoie un objet Numéro de téléphone WhatsApp Business avec ce numéro de téléphone, ce dernier a été réclamé et vous devez copier son id.

Obtenir les numéros de téléphone professionnels pré-vérifiés

Utilisez le point de terminaison Compte business > Numéros pré-vérifiés pour obtenir la liste de tous les objets Numéro de téléphone pré-vérifié WhatsApp Business, tous statuts de vérification confondus, du pool de votre compte business :

GET /<BUSINESS_ACCOUNT_ID>/preverified_numbers

Les résultats sont automatiquement triés par date/heure de création. Vous pouvez également utiliser l’extension de champ pour demander le champ code_verification_status afin que l’API ne renvoie que les numéros de téléphone professionnels pré-vérifiés dotés de l’état de vérification spécifié :

GET /<BUSINESS_ACCOUNT_ID>/preverified_numbers?code_verification_status=VERIFIED

Partage et annulation du partage de numéros vérifiés

Envoyez une requête POST au point de terminaison Entreprise > Numéros pré-vérifiés partagés pour partager des numéros de téléphone professionnels pré-vérifiés avec des partenaires commerciaux, ou une requête DELETE au même point de terminaison pour annuler le partage de ces numéros.

Les numéros de téléphone professionnels pré-vérifiés peuvent être affichés dans le flux d’inscription intégrée par des partenaires commerciaux.

Si vous partagez des numéros avec plusieurs partenaires commerciaux, nous vous recommandons de leur demander de récupérer la liste des numéros pré-vérifiés partagés avant de les afficher dans l’inscription intégrée. Cela réduit la probabilité qu’un partenaire essaie d’afficher un numéro qui a déjà été réclamé (les nombres réclamés ne s’affichent pas dans le flux, mais le partenaire pourrait ne pas le savoir et se demander pourquoi ils n’apparaissent pas).

Syntaxe de la requête de partage

POST /<BUSINESS_ID>/share_preverified_numbers
  ?partner_business_id=<PARTNER_BUSINESS_ID>
  &preverified_id=<PREVERIFIED_ID>

Syntaxe de la requête d’annulation de partage

DELETE /<BUSINESS_ID>/share_preverified_numbers
  ?partner_business_id=<PARTNER_BUSINESS_ID>
  &preverified_id=<PREVERIFIED_ID>

Réponse

En cas de réussite, l’API renvoie true. Quand vous partagez un numéro, notifiez-le à votre partenaire commercial et fournissez-lui l’ID du numéro concerné. Quand vous annulez le partage d’un numéro, celui-ci n’est plus présenté au partenaire dans son implémentation de l’inscription intégrée.

{
  "success": <SUCCESS>
}

Exemple de requête de partage

curl -X POST 'https://graph.facebook.com/v17.0/share_preverified_numbers?partner_business_id=506914307656634&preverified_id=1706193509821738' \
-H 'Authorization: Bearer EAAH0...'

Exemple de requête d’annulation de partage

curl -X DELETE 'https://graph.facebook.com/v17.0/share_preverified_numbers?partner_business_id=506914307656634&preverified_id=1706193509821738' \
-H 'Authorization: Bearer EAAH0...'

Exemple de réponse

{
  "success": true
}

Enregistrement par programmation de numéros pré-vérifiés

Vous pouvez contourner la sélection du numéro de téléphone via l’inscription intégrée et enregistrer par programmation des numéros de téléphone professionnels pré-vérifiés sur le compte WhatsApp Business d’un client ou d’une cliente final·e. Pour ce faire, suivez les étapes présentées dans le document Enregistrer des numéros de téléphone, mais utilisez un ID de numéro de téléphone professionnel pré-vérifié à l’étape 1, puis passez à l’étape 4.

Syntaxe de la requête

Utilisez cette requête pour créer un numéro de téléphone professionnel WhatsApp sur un compte WhatsApp Business à l’aide d’un ID de numéro de téléphone professionnel pré-vérifié. Cela remplace l’étape 1.

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/phone_numbers

Corps de la publication

{
  "preverified_id": "<PREVERIFIED_ID>",
  "country_dial_code": "<COUNTRY_DIAL_CODE>",
  "display_phone_number": "<DISPLAY_PHONE_NUMBER>",
  "verified_name": "<VERIFIED_NAME>"
}

Propriétés

Espace réservéDescriptionExemple de valeur

<PREVERIFIED_ID>

Chaîne

Obligatoire.


L’ID du numéro de téléphone professionnel pré-vérifié.

6635066806614622

<COUNTRY_DIAL_CODE>

Chaîne

Obligatoire.


L’indicatif de pays du numéro de téléphone professionnel pré-vérifié.

1

<DISPLAY_PHONE_NUMBER>

Chaîne

Obligatoire.


Le numéro à afficher pour le numéro de téléphone professionnel pré-vérifié.

5550783881

<VERIFIED_NAME>

Chaîne

Obligatoire.


Le nom à l’écran du numéro de téléphone professionnel pré-vérifié.

Lucky Shrub

Syntaxe de la réponse

En cas de réussite, l’API renvoie l’ID d’un numéro de téléphone WhatsApp Business. Utilisez cet ID pour enregistrer le numéro (étape 4 dans le document Enregistrer des numéros de téléphone).

{
  "id": "<ID>"
}

Propriétés de la réponse

Espace réservéDescriptionExemple de valeur

<ID>

ID d’un numéro de téléphone WhatsApp Business


Cet objet a remplacé l’objet Numéro de téléphone WhatsApp Business pré-vérifié

108692048990658

Exemple de requête

curl 'https://graph.facebook.com/v19.0/506914307656634/phone_numbers' \
-H 'Content-Type: text/plain' \
-H 'Authorization: Bearer EAAH7...' \
-d '
{
  "preverified_id": "6635066806614622",
  "country_dial_code": "1",
  "display_phone_number": "5550783881",
  "verified_name": "Lucky Shrub"
}'

Exemple de réponse

{
  "id": "108692048990658"
}