Video Message

post

https://partner.gupshup.io/partner/app/{appId}/v3/message

Use this API to send a video message to a WhatsApp user.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Video messages display a thumbnail preview of a video image with an optional caption. When the WhatsApp user taps the preview, it loads the video and displays it to the user.

Meta Video Message Doc Link

📘
Note:

Use the recipient parameter only when BSUID is enabled for the app.

When both to and recipient fields are used in the payload, the to field gets the priority.

Request Parameters

Key	Description	Values	Data Types	Required/Optional	Constraints
Authorization	Access Token for the application	{{PARTNER_APP_TOKEN}}	String	Required	Should be a valid Partner App Access Token.
appId	App ID to fetch the access token	{{APP_ID}}	String	Required	The Id should be a valid app Id of Gupshup
messaging_product	Messaging product	whatsapp	String	Required
recipient_type	Recipient type	individual	String	Required
to	Destination phone number where the message needs to be sent	91785876xxxx	String	Required (Can be optional if BSUID is enabled for the app and recipient parameter is used instead)	Must be a valid phone number
recipient	Destination BSUID where the message needs to be sent	IN.461449821882xxxx	String	Optional	Must be a valid BSUID
type	Messaging type	video	String	Required	Type should be video to send video message.
video	Add id or link inside body	"video": {
"id" : "1166846181421424",
"caption": "A succulent eclipse!"
}	Object	Required	Key should be video to send video message.

Sample Request

curl --location --request POST 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "{{WHATSAPP_USER_PHONE_NUMBER}}",
		"recipient": "{{BSUID}}",
    "type": "video",
    "video": {
        "id": "{{MEDIA_ID}}", /* Only if using uploaded media */
        "link": "{{MEDIA_URL}}", /* Only if linking to your media */
        "caption": "{{VIDEO_CAPTION_TEXT}}"
    }
}'

Sample Response

{
    "messages": [
        {
            "id": "GUPSHUP_MESSAGE_ID"
        }
    ],
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "DESTINATION_PHONE_NO",
            "wa_id": "DESTINATION_PHONE_NO"
        }
    ]
}

Status Codes

Status Code	Response	Comments
Success
200	{ "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] }`
Error
401	{ "status": "error", "message": "Authentication Failed" }`	When API key authentication fails
400	{ "message": "Callback Billing must be enabled for this API", "status": "error" }`	If Callback billing is not enabled for the app
400	{ "message": "Invalid App Details", "status": "error" }`	If app details are not found

Supported Video Formats

Video Type	Extension	MIME Type	Max Size
3GPP	.3gp	video/3gp	16 MB
MP4 Video	.mp4	video/mp4	16 MB

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json