API : lister et envoyer des modèles WhatsApp
Deux points d'accès permettent à votre logiciel d'utiliser vos modèles WhatsApp. GET /api/v1/whatsapp/templates liste vos modèles approuvés, et POST /api/v1/whatsapp/send-template en envoie un à un client depuis votre numéro par défaut. Les deux nécessitent une clé avec l'accès WhatsApp.
- Où
- Ask Menuthere support for a key
- Formule
- Nécessite un numéro WhatsApp Business connecté, disponible à partir de Pro.
- Mis à jour
Lister vos modèles
curl 'https://menuthere.com/api/v1/whatsapp/templates' -H 'Authorization: Bearer ck_live_YOUR_KEY'
Il renvoie les modèles approuvés de votre numéro par défaut : vous connaissez ainsi le nom exact et le nombre de valeurs dont chacun a besoin.
| Champ | Signification |
|---|---|
| name, language | Le nom du modèle et son code de langue. |
| category, status | Une catégorie comme MARKETING ou UTILITY. Le statut est APPROVED. |
| body_variables | Combien de valeurs {{n}} le corps nécessite. |
| has_header, header_format | S'il y a un en-tête, et TEXT, IMAGE, VIDEO ou DOCUMENT. |
Envoyer un modèle
POST /api/v1/whatsapp/send-template avec un corps JSON. Le message part de votre expéditeur par défaut, défini dans Plusieurs numéros et le numéro principal. Vous ne pouvez pas choisir le numéro dans l'appel.
| Champ | Obligatoire | De quoi il s'agit |
|---|---|---|
| to | Oui | Le numéro du client avec l'indicatif du pays. |
| template_name | Oui | Le nom issu de l'appel de liste. |
| language | Non | Retrouvée à partir du modèle approuvé si vous l'omettez. |
| body_params | Non | Tableau de valeurs pour {{1}}, {{2}} et ainsi de suite, dans l'ordre. |
| header_params | Non | Tableau de valeurs pour un en-tête texte. |
| header_media_url, header_media_type | Non | Un lien et image, video ou document pour un en-tête média. |
| button_params | Non | Tableau de valeurs pour un bouton URL dynamique. |
| idempotency_key | Non | Une référence de votre choix. id et un en-tête Idempotency-Key fonctionnent aussi. |
Un envoi réussi renvoie ok: true, le message_id, le numéro to et status: "sent". Si vous renvoyez la même clé d'idempotence, vous récupérez le premier résultat avec duplicate: true et rien n'est envoyé deux fois. Un envoi échoué libère la clé pour que vous puissiez réessayer.
Erreurs et limites
| Statut | `error` | Signification |
|---|---|---|
| 400 | missing_fields, invalid_json, invalid_number, template_error | Un champ obligatoire manque, le numéro semble erroné, ou le modèle ne convient pas aux valeurs envoyées. |
| 404 | template_not_found | Aucun modèle approuvé de ce nom sur votre numéro par défaut. |
| 409 | recipient_opted_out | Le client a répondu STOP. Aucun message n'est envoyé. |
| 409 | in_progress | Une requête avec la même clé d'idempotence est encore en cours. |
| 412 | no_whatsapp_number | Aucun numéro WhatsApp par défaut n'est connecté. |
| 429 | daily_limit_reached, rate_limited | La limite quotidienne WhatsApp de votre numéro est épuisée, ou la clé dépasse sa limite de débit. |
| 502 | send_failed | WhatsApp n'a pas pu être joint. Réessayez. |
Questions
Puis-je envoyer un message texte normal par l'API ?
Écrira-t-elle à quelqu'un qui s'est désabonné ?
Voir aussi
Vous ne trouvez pas ? Écrivez à [email protected] ou discutez avec nous, de 9 h à 21 h.Centre d'aideTarifsmenuthere.com