Lister les numéros de téléphone avec l'API WhatsApp
Liste les numéros de téléphone professionnels d'un compte professionnel WhatsApp avec id, display_phone_number, verified_name et quality_rating. Cet id est le phone_number_id des outils de message et de profil. La réponse contient data et paging.cursors.after : passez-le comme after pour lire la page suivante.
- Identifiant
- whatsapp_list_phone_numbers
L'appel
POST https://connect.reportei.com/api/tools/whatsapp_list_phone_numbers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"waba_id": "<waba_id>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| waba_id | string | Oui | Id of the WhatsApp Business account, from List business accounts. |
| fields | string | Non | Comma-separated fields, for example id,display_phone_number,verified_name,status,quality_rating,messaging_limit_tier. |
| sort | string | Non | Order of the numbers.Valeurs : creation_time.asc, creation_time.desc, last_onboarded_time.asc, last_onboarded_time.desc |
| limit | integer | Non | Numbers per page, up to 100. |
| after | string | Non | The paging.cursors.after of the previous response. |
Connexions possibles
Votre client connecte son compte WhatsApp une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/whatsapp_list_phone_numbers. Il devient la définition de tool de votre agent sans conversion.
Autres tools WhatsApp
- Lister les comptes professionnelsGETListe les comptes professionnels WhatsApp accessibles à l'utilisateur système, avec id et nom. Cet id est le waba_id des autres outils, que Meta appelle désormais aussi Messaging account id. La réponse contient data et paging.cursors.after : passez-le comme after pour lire la page suivante.
- Obtenir un compte professionnelGETRenvoie un compte professionnel WhatsApp avec les champs demandés, qui peuvent être des données du compte ou des analytics. Sans fields, seuls id et name reviennent.
- Envoyer un messagePOSTEnvoie un message depuis un numéro de téléphone professionnel et renvoie son id dans messages[0].id. Les types libres (text, image, video, document, audio) n'atteignent que les personnes qui ont écrit au numéro au cours des dernières 24 heures ; pour démarrer une conversation, envoyez le type template avec un modèle approuvé issu de Lister les modèles de message. Meta facture les messages au compte selon ses tarifs WhatsApp.
- Lister les modèles de messageGETListe les modèles de message d'un compte professionnel WhatsApp avec id, name, language, status, category et components. La réponse contient data et paging.cursors.after : passez-le comme after pour lire la page suivante.
- Créer un modèle de messagePOSTCrée un modèle de message et le soumet à la revue de Meta, en renvoyant id, status et category. Il peut être envoyé une fois le statut APPROVED, ce qui peut prendre jusqu'à 24 heures. Les variables sont {{1}}, {{2}} au format POSITIONAL ou {{first_name}} au format NAMED, et chacune a besoin d'un exemple. Un en-tête image, vidéo ou document nécessite un file handle issu d'un upload, que cette connexion ne fait pas.
- Mettre à jour un modèle de messagePOSTModifie un modèle et le renvoie en revue. Seuls les modèles aux statuts APPROVED, REJECTED ou PAUSED peuvent être modifiés, et uniquement leur catégorie et leurs components ; components remplace toutes les parties. Un modèle approuvé accepte jusqu'à 10 modifications en 30 jours et 1 en 24 heures, et sa catégorie ne peut pas changer.
- Supprimer un modèle de messageDELETESupprime un modèle par son nom, dans toutes les langues, ou uniquement la version dont l'id est hsm_id. Le nom d'un modèle approuvé supprimé ne peut pas être réutilisé pendant 30 jours.
- Obtenir le profil professionnelGETRenvoie le profil professionnel que voient les gens sur un numéro de téléphone : about, address, description, email, websites, vertical et profile_picture_url.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
