section-9134a21
API-WHATSAPP
section-1
1 URL de base
L'URL de base par défaut pour l'API WhatsApp LAfricaMobile est https://waba-dev.lafricamobile.com.
Si vous souhaitez envoyer un message à l'aide du /messages
point de terminaison, vous devez ajouter le point de terminaison à votre URL de base, puis effectuer la requête POST.
Vous trouverez ci-dessous un exemple de requête POST complète à la ressource : https://waba-dev.lafricamobile.com/messages.
section-2
2 Autorisation
Actuellement, il n'y a qu'une seule méthode d'autorisation disponible
* API KEY
Récupérez votre clé API
Connectez-vous à LAfricaMobile . Vous aurez besoin d'un compte d'utilisateur valide pour cela.
Une fois toutes les étapes du processus de configuration terminées avec succès, vous pouvez générer une clé API. Lorsque le numéro de téléphone a le statut de configuration TERMINÉ, le bouton Générer une clé API est activé. Cliquez sur le bouton pour afficher la clé API dans votre navigateur.
Chaque point de terminaison décrit plus loin dans la documentation doit être accessible avec une requête HTTP + SSL et soit avec une autorisation basée sur une clé API.
Lors des requêtes POST, les données JSON spécifiées dans les documents doivent être envoyées en tant que charge utile de données POST.
Chaque demande au doit être autorisée à l'aide d'une authentification par clé API. L'ajout de LAM-API-KEY dans l'en-tête avec votre clé API unique en tant que valeur accordera l'accès.
Exemple de requête POST avec curl :
curl \
-H "LAM-API-KEY: {{your-api-key}}" \
-X POST \
https://{{base-url}}/messages \
-H "Accept: application/json"
...
Exemple utilisant POSTMAN :
section-3
3 Envoi de messages
Utilisez le nœud de messages /messages
pour envoyer des messages texte, des médias, des documents et des modèles de message à vos clients.
Vous pouvez envoyer des messages en POST appelant le /messages
nœud quel que soit le type de message.
Le contenu du corps du message JSON diffère pour chaque type de message (texte, image, etc.).
Voici un exemple simple pour envoyer un message texte :
POST /messages
{
"recipient_type": " individu ",
"to": "whatsapp-id",
"type": "text",
"text": {
"body": " votre-message-contenu "
}
}
section-4
4 Réception de messages
Vous devez configurer un rappel (URL de webhook) pour recevoir des messages.
Les webhooks peuvent être utilisés pour :
- Notifications de messages entrants : utilisez-le pour recevoir une notification lorsque vous avez reçu un message.
- Notifications d'état des messages : surveillez l'état des messages envoyés.
Si un événement webhook n'est pas livré pour une raison quelconque (par exemple, le client est hors ligne) ou si la requête webhook renvoie un code d'état HTTP autre que 200, nous réessayons la livraison du webhook. Nous continuons à réessayer la livraison avec des retards croissants jusqu'à un certain délai (généralement 24 heures, bien que cela puisse varier), ou jusqu'à ce que la livraison réussisse.
=> Exigences relatives aux webhooks
Pour déployer un webhook en direct pouvant recevoir des événements de webhook de l'API WhatsApp Business, votre code doit avoir les éléments suivants :
- Prise en charge HTTPS
- Un certificat SSL valide
=> Définir votre URL de rappel
Envoyez une requête POST au /configs/webhook
point de terminaison pour définir la ressource.
POST /configs/webhook
{
"url": "{{your-callback-url}}"
}
-