Envoi de messages multimédias

Utilisez le nœud messages pour envoyer des messages contenant du son, des documents, des images, des stickers ou des vidéos à vos clients.

Essentiellement, lorsque vous envoyez un message qui contient un média, vous devez fournir soit l’ID du média importé, soit un lien vers le média dans le corps de la demande. Vous devez également spécifier le type du média que vous envoyez : audio, document, image, sticker ou video. Lorsque la requête est reçue, le média est importé sur le serveur WhatsApp et envoyé à l’utilisateur indiqué dans le champ to.

Il existe actuellement deux moyens d’envoyer des messages multimédias avec l’API WhatsApp Business :

ID : pour utiliser un ID, vous devez d’abord importer le média en utilisant le nœud media afin d’obtenir l’ID requis pour l’appel d’API messages.
Liens : pour utiliser un lien, vous devez fournir un lien HTTP(S) à partir duquel l’application téléchargera le média, vous évitant ainsi de l’importer vous-même.

Avant de commencer

Procédez comme suit :

Remplissez toutes les conditions requises indiquées dans la section Avant de commencer de la documentation sur les messages.
Importez le média à envoyer ou munissez-vous du lien vers ce média.

Étape 1 : envoyer une requête `POST` à `/messages`

Après avoir importé le média, utilisez l’ID renvoyé pour le champ id dans l’appel d’API qui envoie le message multimédia. Vous pouvez également fournir un paramètre link indiquant le média que vous voulez envoyer (actuellement, seuls les liens HTTP/HTTPS sont acceptés).

Utilisez l’un des paramètres obligatoires id ou link, mais pas les deux en même temps.

Exemple

À titre indicatif seulement, l’exemple ci-dessous illustre différents objets tels que audio, document, image, sticker et video. Un corps de requête valide n’est constitué que d’un seul de ces éléments.

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio" | "contact" | "document" | "image" | "location" | "sticker" | "text" | "video",
  
  "audio": {
    "id": "your-media-id"
  }
  
  "document": {
    "id": "your-media-id",
    "filename": "your-document-filename"
  }
  
  "document": {
    "link": "the-provider-name/protocol://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "document": {
    "link": "http(s)://the-url.pdf"
  }
  
  "video": {
    "id": "your-media-id"  
  }
  
  "image": {
    "link": "http(s)://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "image": {
    "id": "your-media-id"   
  }
  
  "sticker": {
    "id": "your-media-id"
  }
  
  "sticker": {
    "link": "http(s)://the-url",
    "provider": {
      "name" : "provider-name"
    }
  }
}

Pour en savoir plus sur les paramètres, consultez les rubriques suivantes :

Étape 2 : vérifier votre réponse

Une réponse positive comprend un objet messages avec un ID de message.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}

En cas d’échec de la réponse, un rappel est envoyé à votre URL Webhook, même si la réponse produit un ID de message similaire à celui d’un message envoyé avec succès. C’est pourquoi il est important de configurer un serveur Webhook.

Pour plus d’informations sur les erreurs, consultez l’article Codes d’erreur et d’état.

En savoir plus