Support

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

ChampTypeRequisDescription
phonestringyesDestination E.164
bodystring*Corps texte / légende (requis pour text)
content_typestringnoDéfaut text. Voir types de médias
template_codestringnoRendu avec vars
varsobjectnoVariables de modèle
prioritystringnootp · notification · chat · …
idempotency_keystringnoDédupliquer les retries
media_urlstring*URL de fichier distant pour les types média
media_base64string*Fichier base64 à la place de l'URL
media_filenamestringnoNom d'affichage
media_mimetypestringnoType MIME
link_url / urlstring*Pour content_type=link
link_label / ctastringnoLibellé du bouton
link_titlestringnoTitre de la carte
link_descriptionstringnoDescription de la carte
link_image_urlstringnoImage de la carte
htmlstring*Pour content_type=html
subjectstringnoTitre de newsletter (html)
previewstringnoTeaser 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

QueryDescription
phoneFiltrer par téléphone du compte
statequeued · delivered · read · …
qRecherche corps / contact
limitTaille 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.