📘

Note:

1. Use the recipient parameter only when BSUID is enabled for the app.
2. When both to and recipient fields are used in the payload, the to field gets the priority.

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--data '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "{{PHONE_NUMBER}}",
		"recipient": "{{BSUID}}"
    "type": "document",
    "document": {
        "id": "{{MEDIA_ID}}", 
        "link": "{{MEDIA_LINK}}", 
        "caption": "{{MEDIA_CAPTION}}",
        "filename": "{{MEDIA_FILENAME}}"
    }
}'

Sample Response

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

Request Parameters

{
        "id": "{{MEDIA_ID}}", 
        "link": "{{MEDIA_LINK}}", 
        "caption": "{{MEDIA_CAPTION}}",
        "filename": "{{MEDIA_FILENAME}}"
    }

Status Codes