Documentation API
Envoyez des messages WhatsApp, gérez vos contacts et listez vos modèles approuvés depuis vos propres systèmes - CRM, e-commerce, helpdesk ou applications personnalisées.
Pour commencer
Chaque requête va à l'URL de base de votre API suivie de votre UID vendeur et du chemin du point de terminaison :
https://www.smartbulkmessenger.com/api/{vendor_uid}/contact/send-message
Vous trouverez votre UID vendeur et votre jeton d'accès dans votre console, sous Paramètres -> API Access & Webhook. L'accès API doit être inclus dans votre plan.
Authentification
Envoyez votre jeton comme jeton Bearer dans l'en-tête Authorization (recommandé), ou comme paramètre d'URL « token » :
Authorization: Bearer YOUR_TOKEN
Format des numéros de téléphone
Les numéros de téléphone s'écrivent toujours avec l'indicatif du pays, sans préfixe + ni 0 - par exemple 237690000000.
Réponses
Chaque réponse utilise la même enveloppe. En cas d'échec, « result » vaut « failed » et « message » explique pourquoi - par exemple « Invalid Token », ou une erreur de validation nommant le champ manquant. Les points de terminaison ping et de messagerie (envoi de message, média, modèle et interactif) exigent aussi l'accès API dans votre plan et répondent HTTP 401 sans lui ; les points de terminaison contacts et liste des modèles fonctionnent avec votre seul jeton.
{
"result": "success",
"message": "...",
"data": { }
}
Points de terminaison
| Méthode | Point de terminaison | Objectif | Paramètres requis |
|---|---|---|---|
| GET | /ping |
Vérifie vos identifiants et l'accès API de votre plan - n'envoie rien | - |
| POST | /contact/send-message |
Envoyer un message texte libre. WhatsApp ne le livre qu'à l'intérieur de la fenêtre de service client de 24 heures - utilisez un message modèle en dehors de la fenêtre. | phone_number, message_body |
| POST | /contact/send-media-message |
Envoyer un message média (les règles de la fenêtre de 24 heures s'appliquent) | phone_number, media_type (image | video | document | audio), media_url |
| POST | /contact/send-template-message |
Envoyer un message modèle approuvé - fonctionne à tout moment, y compris pour démarrer une conversation | phone_number, template_name, template_language - plus the template variables below |
| POST | /contact/send-interactive-message |
Envoyer un message interactif : boutons de réponse par défaut, un bouton d'appel à l'action URL (interactive_type = cta_url), ou une liste (interactive_type = list) | phone_number + buttons.1...buttons.3, or cta_url.display_text + cta_url.url, or list_data |
| GET | /contact/template-list |
Lister vos modèles WhatsApp approuvés (nom, langue, catégorie, composants) | - |
| POST | /contact/create |
Créer un contact | phone_number - optional: first_name, last_name, email, language_code, country (country name) |
| GET | /contact/{phone_number} |
Récupérer un contact par numéro de téléphone | - |
| POST | /contact/update/{phone_number} |
Mettre à jour un contact (le numéro de téléphone est dans l'URL) | any of first_name, last_name, email, language_code, country (country name) |
| POST | /contact/assign-team-member |
Assigner un membre de l'équipe à une conversation de contact | phone_number, username_or_email |
Chaque point de terminaison d'envoi accepte « from_phone_number_id » lorsque vous avez plusieurs numéros WhatsApp et voulez choisir l'expéditeur ; sans cela, votre numéro par défaut est utilisé.
Paramètres des messages modèles
Les variables des modèles peuvent contenir des champs de contact dynamiques tels que {first_name}, {last_name}, {full_name}, {email}, {phone_number}, {country} et {language_code} - ils sont remplacés par les valeurs du contact lors de l'envoi du message.
{
"phone_number": "237690000000",
"template_name": "your_template_name",
"template_language": "en",
"header_image": "https://example.com/image.jpg",
"header_video": "https://example.com/video.mp4",
"header_document": "https://example.com/document.pdf",
"header_document_name": "{full_name}",
"header_field_1": "{full_name}",
"location_latitude": "22.22",
"location_longitude": "22.22",
"location_name": "Example Name",
"location_address": "Example address",
"field_1": "{first_name}",
"field_2": "{last_name}",
"button_0": "{full_name}",
"button_1": "{phone_number}",
"copy_code": "EXAMPLE_CODE"
}
Exemples
Envoyer un message modèle avec cURL
curl -X POST "https://www.smartbulkmessenger.com/api/YOUR_VENDOR_UID/contact/send-template-message" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone_number": "237690000000",
"template_name": "your_template_name",
"template_language": "en",
"field_1": "{first_name}"
}'
Réponse d'envoi réussie
{
"result": "success",
"message": "...",
"data": {
"log_uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"contact_uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone_number": "237690000000",
"wamid": "wamid.xxxxxxxxxxxx",
"status": "sent"
}
}
Vérifier votre connexion (ping)
curl "https://www.smartbulkmessenger.com/api/YOUR_VENDOR_UID/ping" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"result": "success",
"message": "API connection successful",
"data": {
"vendor_uid": "YOUR_VENDOR_UID",
"status": "ok",
"server_time": "2026-01-01T00:00:00+00:00"
}
}
Webhook
Si vous activez le point de terminaison webhook dans Paramètres -> API Access & Webhook, les charges WhatsApp entrantes sont transmises à votre point de terminaison par POST dans ce format :
{
"contact": {
"status": "existing/updated/new",
"phone_number": "237690000000",
"uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"first_name": "...",
"last_name": "...",
"email": "...",
"language_code": "en",
"country": "..."
},
"message": {
"whatsapp_business_phone_number_id": "...",
"whatsapp_message_id": "wamid....",
"replied_to_whatsapp_message_id": "wamid....",
"is_new_message": true,
"body": null,
"status": null,
"media": {
"type": "image",
"link": "link to media",
"caption": null,
"mime_type": "image/jpeg",
"file_name": "...",
"original_filename": "..."
}
},
"whatsapp_webhook_payload": {
"...": "the original WhatsApp webhook data"
}
}