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ètreTypeObligatoireDescription
waba_idstringOuiId of the WhatsApp Business account, from List business accounts.
fieldsstringNonComma-separated fields, for example id,display_phone_number,verified_name,status,quality_rating,messaging_limit_tier.
sortstringNonOrder of the numbers.Valeurs : creation_time.asc, creation_time.desc, last_onboarded_time.asc, last_onboarded_time.desc
limitintegerNonNumbers per page, up to 100.
afterstringNonThe 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

Voir les 10 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.