Skip to main content
POST
/
v1
/
whatsapp
/
messages
/
send-media
Send Media Message
curl --request POST \
  --url https://karibu.briq.tz/v1/whatsapp/messages/send-media \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "recipient": "<string>",
  "media_url": "<string>"
}
'
{
  "success": true,
  "data": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider_message_id": "<string>"
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": null
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-API-Key
string
required
​
X-App-ID
string | null

Body

application/json
​
recipient
string
required
Required string length: 4 - 20
Example:

"255712345678"

​
media_kind
enum<string>
required
Available options:
IMAGE,
DOCUMENT,
VIDEO
​
media_url
string
required

Publicly reachable URL of the media asset.

Minimum string length: 1
​
sender_id
string<uuid> | null
​
caption
string | null
Maximum string length: 1024
​
filename
string | null
Maximum string length: 255
​
check_window
boolean
default:true

Response

Sent synchronously (status: sent)

WhatsApp send envelope (WaApiResponse with a WaSendResult data payload).

​
success
boolean
default:true
required
​
data
WaSendResult · object
required

Payload returned in data for a successful send.

​
request_id
string<uuid>
required
​
errors
null