API WhatsApp Business Management

Récupérer les numéros de téléphone

Récupérez les numéros de téléphone enregistrés par une entreprise pour son compte WhatsApp Business à l’aide de l’API WhatsApp Business Management.

Avant de commencer

Vous aurez besoin des éléments suivants :

  • L’ID du compte WhatsApp Business pour les numéros de téléphone de l’entreprise que vous souhaitez récupérer
  • Un token d’accès d’utilisateur système lié au compte WhatsApp Business
  • L’autorisation whatsapp_business_management

Limites

  • Cette API peut récupérer uniquement les numéros de téléphone enregistrés. L’ajout, la mise à jour et la suppression des numéros de téléphone ne sont pas autorisés avec cette API.

Obtenir tous les numéros de téléphone

Pour obtenir la liste de tous les numéros de téléphone associés à un compte WhatsApp Business, envoyez une requête GET au point de terminaison Compte WhatsApp Business > Numéros de téléphone.

De plus, vous pouvez trier les numéros de téléphone en ordre croissant ou décroissant avec last_onboarded_time, qui correspond au moment où l’inscription intégrée a été effectuée. Par défaut, ils sont triés en ordre décroissant.

Exemple de requête

Formaté pour une meilleure lisibilité.
curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}"

En cas de réussite, un objet JSON est renvoyé avec la liste de tous les noms, numéros de téléphone, ID numéro de téléphone et indices de qualité associés à une entreprise. Les résultats sont triés par date de réalisation des inscriptions intégrées dans l’ordre chronologique inverse (la plus récente en premier).

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
      
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

Exemple de requête

Formaté pour une meilleure lisibilité.
curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}]&sort=['last_onboarded_time_ascending']"

En cas de réussite, un objet JSON est renvoyé avec la liste de tous les noms, numéros de téléphone, ID numéro de téléphone et indices de qualité associés à une entreprise. Cette liste est triée par ordre croissant à partir de la date à laquelle l’utilisateur·ice a effectué l’inscription intégrée. Ainsi, l’inscription la plus récente est affichée en dernier dans la liste.

{
  "data": [
   {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    },
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"     
    }   
  ]
}

Filtrer les numéros de téléphone

Vous pouvez interroger des numéros de téléphone et les filtrer selon leur account_mode. Cette option de filtrage est actuellement testée en mode bêta. Elle n’est pas accessible à tous les développeurs.

Paramètres

NomDescription

field

Valeur : account_mode

operator

Valeur : EQUAL

value

Valeurs : SANDBOX, LIVE

Exemple de requête

curl -i -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-ID}/phone_numbers?filtering=[{"field":"account_mode","operator":"EQUAL","value":"SANDBOX"}]&access_token=access-token"

Exemple de réponse

{
  "data": [
    {
      "id": "1972385232742141",    
      "display_phone_number": "+1 631-555-1111",
      "verified_name": "John’s Cake Shop",
      "quality_rating": "UNKNOWN",
    }
  ],
  "paging": {
	"cursors": {
		"before": "abcdefghij",
		"after": "klmnopqr"
	}
   }
}

Obtenir un seul numéro de téléphone

Pour obtenir des informations sur un numéro de téléphone, envoyez une requête GET au point de terminaison Numéro de téléphone WhatsApp Business :

Syntaxe de la requête

GET https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>

Exemple de requête

curl \
'https://graph.facebook.com/v15.0/105954558954427/' \
-H 'Authorization: Bearer EAAFl...'

En cas de réussite, un objet JSON est renvoyé avec le nom, le numéro de téléphone, l’ID numéro de téléphone et l’indice de qualité de l’entreprise associée au numéro de téléphone interrogé.

{
  "code_verification_status" : "VERIFIED",
  "display_phone_number" : "15555555555",
  "id" : "105954558954427",
  "quality_rating" : "GREEN",
  "verified_name" : "Support Number"
}

Obtenir le statut du nom à l’écran (bêta)

Utilisez le paramètre de chaîne de requête fields=name_status pour obtenir le statut du nom à l’écran associé à un numéro de téléphone spécifique. Ce champ est disponible uniquement en mode bêta et pour certaines équipes de développement.

Exemple de requête

curl \
'https://graph.facebook.com/v15.0/105954558954427?fields=name_status' \
-H 'Authorization: Bearer EAAFl...'

Exemple de réponse

{
  "id" : "105954558954427",
  "name_status" : "AVAILABLE_WITHOUT_REVIEW"
}

Les valeurs disponibles pour name_status sont :

  • APPROVED : le nom a été approuvé. Vous pouvez télécharger votre certificat maintenant.
  • AVAILABLE_WITHOUT_REVIEW : le certificat du téléphone est disponible et le nom à l’écran peut être utilisé sans examen.
  • DECLINED : le nom n’a pas été approuvé. Vous ne pouvez pas télécharger votre certificat.
  • EXPIRED : votre certificat a expiré et ne peut plus être téléchargé.
  • PENDING_REVIEW : votre demande de nom est en cours d’examen. Vous ne pouvez pas télécharger votre certificat.
  • NONE : aucun certificat n’est disponible.

Remarque : les certificats sont valables pendant sept jours.

En savoir plus

Pour obtenir la liste de toutes les valeurs possibles pour chaque champ, consultez la référence de l’API Graph du champ Numéro de téléphone.