Overview
| Type | Description | Main required field |
|---|
text | Message texte simple | text |
image | Image avec légende optionnelle | mediaUrl |
video | Vidéo avec légende optionnelle | mediaUrl |
audio | Fichier audio standard | mediaUrl |
voice_note | Note vocale WhatsApp | mediaUrl |
document | Fichier ou document | mediaUrl |
location | Localisation GPS | latitude, longitude |
contact | Partage d’un contact du répertoire | contactId |
instanceIdtotype ou templateId
Les endpoints POST /api/v1/messages/send et POST /api/v1/messages/schedule supportent deux modes :
- mode libre avec
type
- mode template avec
templateId
Direct send vs template send
Direct mode
Vous fournissez directement type et les champs associés.
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "text",
"text": "Hello Awa"
}
Template mode
Vous fournissez templateId et, si nécessaire, des variables custom.*.
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"contactId": "cnt_uuid",
"templateId": "tmpl_uuid",
"variables": {
"code": "PROMO10"
}
}
type effectif est celui du template.
text
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "text",
"text": "Hello Jean,\n\nVotre commande #1234 est prête."
}
| Field | Type | Required | Contraintes |
|---|
text | string | ✓ | 1 à 4096 caractères |
image
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "image",
"mediaUrl": "https://cdn.example.com/produit.jpg",
"text": "Nouvelle collection disponible"
}
| Field | Type | Required | Contraintes |
|---|
mediaUrl | URL | ✓ | URL publique |
text | string | no | Légende optionnelle |
video
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "video",
"mediaUrl": "https://cdn.example.com/demo.mp4",
"text": "Découvrez notre nouveau produit"
}
| Field | Type | Required | Contraintes |
|---|
mediaUrl | URL | ✓ | URL publique |
text | string | no | Légende optionnelle |
audio
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "audio",
"mediaUrl": "https://cdn.example.com/message.mp3"
}
voice_note
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "voice_note",
"mediaUrl": "https://cdn.example.com/note.ogg"
}
The difference between audio and voice_note is mainly how they are displayed in WhatsApp.
document
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "document",
"mediaUrl": "https://cdn.example.com/facture.pdf",
"text": "Facture avril 2026"
}
| Field | Type | Required | Contraintes |
|---|
mediaUrl | URL | ✓ | URL publique |
text | string | no | Label or caption |
location
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "location",
"latitude": 6.3654,
"longitude": 2.4183,
"locationName": "Boutique Cotonou Centre",
"locationAddress": "Avenue de la Marina, Cotonou"
}
| Field | Type | Required | Contraintes |
|---|
latitude | number | ✓ | Latitude décimale |
longitude | number | ✓ | Longitude décimale |
locationName | string | no | Location name |
locationAddress | string | no | Address |
{
"instanceId": "inst_uuid",
"to": "+33612345678",
"type": "contact",
"contactId": "cnt_uuid"
}
contactId doit appartenir à votre compte MsgFlash.
Common fields
| Field | Type | Required | Description |
|---|
instanceId | UUID | ✓ | Instance WhatsApp à utiliser |
to | string | ✓ | E.164 number |
type | enum | ✓ if no templateId | Direct message type |
templateId | UUID | ✓ if no type | MsgFlash template to use |
contactId | UUID | no | Source contact or template context |
variables | object | no | Valeurs pour custom.* |
scheduledAt | ISO 8601 | no | Utilisé uniquement sur /messages/schedule |
Un template peut être de type :
textimagevideoaudiodocument
Pour un template media, mediaUrl est obligatoire sur le template lui-même.
Example:
{
"name": "Brochure PDF",
"type": "document",
"body": "Hello {{contact.firstName}}, voici votre brochure.",
"mediaUrl": "https://cdn.example.com/brochure.pdf"
}
