Passer au contenu principal
Tous les endpoints qui envoient un message (démarrer une conversation, répondre, entrant Shortext, envoi v1.0), ainsi que chaque message d’une réponse ou d’un webhook, utilisent le même objet message :
type vaut text, template, interactive ou media ; content en dépend. Chaque endpoint accepte les types qui ont du sens pour lui : par exemple, un message entrant Shortext est uniquement text.

Texte

string
requis
Le texte, jusqu’à 4 096 caractères. Sur WhatsApp, une URL dans le texte s’affiche comme un lien.

Modèle

string
requis
Le nom du modèle, tel que listé par GET /templates.
string
requis
La langue du modèle, par exemple fr ou en_US. Le modèle doit être approuvé dans cette langue.
object
Les variables du corps, par nom : { "name": "Brice", "order": "A-1042" }. Pour les modèles à variables numérotées ({{1}}, {{2}}), donnez une liste de paramètres WhatsApp dans l’ordre.
object
Pour un en-tête texte avec variables : { "name": "valeur" }. Pour un en-tête média : { "url": "https://..." } (et filename pour un document). Sans url, le média enregistré avec le modèle est envoyé.
array
Les paramètres des boutons dynamiques, au format de la WhatsApp Cloud API.
string
défaut:"utility"
utility, marketing ou authentication.
En v2.0, Shortext vérifie le modèle avant de l’envoyer à WhatsApp et répond 1002 avec un message explicite quand le modèle n’existe pas sur le numéro, n’est pas approuvé dans cette langue, ou qu’il manque une variable (body.missing les liste). Voir Envoyer un modèle.

Interactif

string
requis
button (boutons de réponse), list, cta_url, quick_reply, carousel, flow ou payment.
string
requis
Le texte du message, jusqu’à 1 024 caractères.
object
requis
Les boutons, sections ou le lien, au format action de la WhatsApp Cloud API.
object
{ "type": "text" | "image" | "video" | "document" | "audio", "value": "texte ou URL", "filename": "pour les documents" }.
Jusqu’à 60 caractères.
WhatsApp autorise jusqu’à 3 boutons de réponse, et jusqu’à 10 sections de 10 lignes dans une liste.

Média

string
requis
image, video, document ou audio.
string
requis
Une URL publique depuis laquelle Shortext peut télécharger le fichier.
string
Jusqu’à 1 024 caractères (pas pour l’audio).
string
Le nom de fichier affiché pour un document.
string
Le type MIME, par exemple application/pdf.

Les messages dans les réponses et les webhooks

Les messages renvoyés par l’API et envoyés dans les webhooks message.* enveloppent le même objet :
  • direction vaut inbound (venant du contact) ou outbound (de l’agent IA, d’un membre de votre équipe ou de l’API).
  • message.id est l’identifiant sur le canal (identifiant de message WhatsApp ; sur un endpoint Shortext, votre propre identifiant de message).
  • status vaut received pour les messages entrants, puis sent, delivered, read ou failed pour les messages sortants ; les changements sont envoyés par le webhook message.status.