v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams Service

Send Media

Send a WhatsApp media message (image, document, audio, video, …) that references a file you have already uploaded with the Upload file endpoint. Pass the media_id returned by that upload.

Each entry sends one media message; include message_content for an optional caption, or conversation_uuid to reply into an existing conversation.

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

post/streams/whatsapp/send_media

Request body

Example request

{
  "messages": [
    {
      "message_content": "Here is your receipt.",
      "conversation_uuid": "e2a489db-bb8a-4f51-9692-726153599c57",
      "media": {
        "media_id": "01d1e10f-2b3c-4d5e-6f70-3707906010e2"
      }
    }
  ]
}

Response

The media message was accepted for delivery.

statusboolean

true when the batch was accepted. Individual messages may still carry an error.

task_idstring

Identifier for the accepted batch (processed asynchronously).

Example response

{
  "status": true,
  "task_id": "ca550f7e-9eb5-45b3-9830-e82b407ede02",
  "messages": [
    {
      "internal_id": "1001",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "conversation_uuid": "e2a489db-bb8a-4f51-9692-726153599c57",
      "error": "0x31",
      "details": "reached daily limit"
    }
  ]
}