Messages
Envoyer des messages hub partenaire aux utilisateurs finaux.
Envoyer un message
POST /api/v1/messages
Crée un message hub autonome (pas une conversation support).
En-têtes
Authorization: Bearer <api_key>
Content-Type: application/json
Paramètres du corps
| Champ | Type | Requis | Description |
|---|---|---|---|
phone | string | yes | Destination E.164 |
body | string | * | Corps texte / légende (requis pour text) |
content_type | string | no | Défaut text. Voir types de médias |
template_code | string | no | Rendu avec vars |
vars | object | no | Variables de modèle |
priority | string | no | otp · notification · chat · … |
idempotency_key | string | no | Dédupliquer les retries |
media_url | string | * | URL de fichier distant pour les types média |
media_base64 | string | * | Fichier base64 à la place de l'URL |
media_filename | string | no | Nom d'affichage |
media_mimetype | string | no | Type MIME |
link_url / url | string | * | Pour content_type=link |
link_label / cta | string | no | Libellé du bouton |
link_title | string | no | Titre de la carte |
link_description | string | no | Description de la carte |
link_image_url | string | no | Image de la carte |
html | string | * | Pour content_type=html |
subject | string | no | Titre de newsletter (html) |
preview | string | no | Teaser texte brut (html) |
Exemple texte
curl -X POST "$API/messages" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+228XXXXXXXX",
"body": "Votre dossier est en cours de traitement.",
"priority": "notification",
"idempotency_key": "seed-dossier-1001"
}'
Réponse 201
{
"message_id": 142,
"ref": "52c22ee01478…",
"phone": "+228XXXXXXXX",
"partner": "seed",
"direction": "out",
"content_type": "text",
"body": "Votre dossier est en cours de traitement.",
"state": "delivered",
"priority": "notification",
"created_at": "2026-07-21 07:10:00"
}
Obtenir un message
GET /api/v1/messages/{message_id}
Renvoie le message et les tentatives de livraison optionnelles.
Lister les messages
GET /api/v1/messages
| Query | Description |
|---|---|
phone | Filtrer par téléphone du compte |
state | queued · delivered · read · … |
q | Recherche corps / contact |
limit | Taille de page |
Marquer lu / non lu (outils partenaire)
POST /api/v1/messages/{id}/read
POST /api/v1/messages/{id}/unread
POST /api/v1/messages/read
Envoi chat agent
POST /api/v1/agent/messages
Utilisé par les agents Partner Hub. Peut s'attacher à une conversation support ouverte lorsque c'est approprié. Préférez /messages pour les notifications hub automatisées.
