WhatsApp API

Envoi WhatsApp professionnel avec file, médias et suivi de livraison

GET
/whatsapp/v1/messages

Liste les messages appartenant à la clé API du client.

Paramètres

Nom Description
status string
Optionnel 		Filtre : queued, processing, sent, delivered, read, failed ou cancelled.
limit integer
Optionnel 		Nombre de messages retournés, de 1 à 100. Valeur par défaut : 25.
Success 200 OK 
{
    "success": true,
    "message": "Messages récupérés.",
    "data": [
        {
            "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
            "to": "+509XXXXXXXX",
            "type": "text",
            "status": "sent",
            "reference": "resultat-001"
        }
    ],
    "count": 1,
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
GET
/whatsapp/v1/messages/status

Retourne le statut et les dates de suivi d’un message appartenant au client.

Paramètres

Nom Description
id uuid
Requis 		Identifiant public retourné lors de la mise en file.
Success 200 OK 
{
    "success": true,
    "message": "Statut du message récupéré.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "to": "+509XXXXXXXX",
        "type": "text",
        "status": "delivered",
        "reference": "resultat-001",
        "attempts": 1,
        "created_at": "2026-08-15 17:57:37",
        "sent_at": "2026-08-15 17:57:42",
        "delivered_at": "2026-08-15 17:57:45"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send

Alias compatible qui ajoute un message texte à la file WhatsApp.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
message string
Requis 		Texte à envoyer, limité à 4096 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-audio

Ajoute un audio ou une note vocale à la file depuis un fichier, une URL HTTPS ou du base64.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
file file
Optionnel 		Fichier multipart. Fournir exactement une source parmi file, url ou base64.
url string
Optionnel 		URL HTTPS publique. Fournir exactement une source parmi file, url ou base64.
base64 string
Optionnel 		Contenu base64 ou data URI. Fournir exactement une source parmi file, url ou base64.
mimetype string
Optionnel 		Type MIME déclaré pour une source base64.
caption string
Optionnel 		Légende facultative, limitée à 1024 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
ptt boolean
Optionnel 		True pour envoyer un fichier OGG/Opus comme note vocale.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-contact

Ajoute une fiche contact WhatsApp à la file.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
contact_name string
Requis 		Nom affiché sur la fiche contact, 120 caractères maximum.
contact_number string
Requis 		Numéro international du contact avec ou sans le signe +.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-document

Ajoute un document à la file depuis un fichier multipart, une URL HTTPS ou du base64.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
file file
Optionnel 		Fichier multipart. Fournir exactement une source parmi file, url ou base64.
url string
Optionnel 		URL HTTPS publique. Fournir exactement une source parmi file, url ou base64.
base64 string
Optionnel 		Contenu base64 ou data URI. Fournir exactement une source parmi file, url ou base64.
mimetype string
Optionnel 		Type MIME déclaré pour une source base64.
caption string
Optionnel 		Légende facultative, limitée à 1024 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
filename string
Optionnel 		Nom obligatoire pour un document transmis par URL ou base64; déduit pour un fichier multipart.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-image

Ajoute une image à la file depuis un fichier multipart, une URL HTTPS ou du base64.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
file file
Optionnel 		Fichier multipart. Fournir exactement une source parmi file, url ou base64.
url string
Optionnel 		URL HTTPS publique. Fournir exactement une source parmi file, url ou base64.
base64 string
Optionnel 		Contenu base64 ou data URI. Fournir exactement une source parmi file, url ou base64.
mimetype string
Optionnel 		Type MIME déclaré pour une source base64.
caption string
Optionnel 		Légende facultative, limitée à 1024 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-location

Ajoute une localisation avec coordonnées et description optionnelle.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
latitude number
Requis 		Latitude WGS84 comprise entre -90 et 90.
longitude number
Requis 		Longitude WGS84 comprise entre -180 et 180.
description string
Optionnel 		Nom du lieu facultatif, 255 caractères maximum.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-poll

Ajoute un sondage WhatsApp natif à la file.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
name string
Requis 		Question du sondage, 255 caractères maximum.
options array
Requis 		De 2 à 12 options distinctes, 100 caractères maximum chacune.
allow_multiple_answers boolean
Optionnel 		Autorise plusieurs réponses lorsque true.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-text

Ajoute un message texte à la file WhatsApp.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
message string
Requis 		Texte à envoyer, limité à 4096 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}
POST
/whatsapp/v1/send-video

Ajoute une vidéo à la file depuis un fichier multipart, une URL HTTPS ou du base64.

Paramètres

Nom Description
to string
Requis 		Numéro international avec ou sans le signe +, par exemple +509XXXXXXXX.
file file
Optionnel 		Fichier multipart. Fournir exactement une source parmi file, url ou base64.
url string
Optionnel 		URL HTTPS publique. Fournir exactement une source parmi file, url ou base64.
base64 string
Optionnel 		Contenu base64 ou data URI. Fournir exactement une source parmi file, url ou base64.
mimetype string
Optionnel 		Type MIME déclaré pour une source base64.
caption string
Optionnel 		Légende facultative, limitée à 1024 caractères.
reference string
Optionnel 		Référence métier facultative, limitée à 100 caractères.
Success 200 OK 
{
    "success": true,
    "message": "Message ajouté à la file d’attente.",
    "data": {
        "id": "247e25d7-a29c-4767-a4de-d25efeda278a",
        "status": "queued",
        "reference": "resultat-001",
        "created_at": "2026-08-15 17:57:37",
        "status_endpoint": "/whatsapp/v1/messages/status?id=247e25d7-a29c-4767-a4de-d25efeda278a"
    },
    "request_id": "db8c825ed809a80b"
}
Error Response 
{
    "success": false,
    "message": "Le champ requis est invalide ou manquant.",
    "request_id": "dad25a5be612fe94"
}