Audio Message

Audio messages display an audio icon and a link to an audio file. When the WhatsApp user taps the icon, the WhatsApp client loads and plays the audio file.

Here you can send audio messages using this API.

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.
APP ID	App ID to fetch the access token	`bf9ee64c-3d4d-4ac4-xxxx-732e577007c4`	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 no where the message need to be send	`91785876xxxx`	String	Required	Must be a valid phone number.
type	Messaging type	interactive	String	Required	Type should be `interactive` to send address message.
audio	Add sticker body	`"audio": { "id" : "798882015472548" }`	Object	Required	Key should be `audio` to send audio 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}",
    "type": "audio",
    "audio": {
        "id": "{MEDIA_ID}"
    }
}'

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