Use this API to send messages using the Text based message.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Note:
- Sending Marketing Templates through MM Lite for enhanced delivery optimization. For more details, refer to MM Lite document.
- To send a text-based message template, make a
POSTcall to/PHONE_NUMBER_ID/messagesand attach a message object withtype=template. Then, add atemplateobject.- Substitute the placeholder properties below using the properties table.
- Use the
recipientparameter only when BSUID is enabled for the app- When both
toandrecipientfields are used in the payload, thetofield gets the priority.
Request Parameters
| Key | Value | Description | Data type | Required/Optional | Constraints |
|---|---|---|---|---|---|
Authorization |
{{PARTNER_APP_TOKEN}} |
Access Token for the application |
String |
Required |
Should be a valid |
appId |
{{APP_ID}} |
App ID to fetch the |
String |
Required |
The ID should be a valid app Id of Gupshup. |
messaging_product |
Messaging product |
String |
Required |
||
recipient_type |
individual |
Recipient type |
String |
Required |
|
to |
91785876xxxx |
Destination phone number where the message needs to be sent |
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 |
IN.461449821882xxxx |
Destination BSUID where the message needs to be sent |
String |
Optional |
Must be a valid BSUID |
type |
template |
Messaging type |
String |
Required |
The type should be |
template |
|
Template message inside body |
Object |
Required |
<NAMED_PARAMETER_ <POSITIONAL_PARAMT Required when you have used positional |
Sample Request
curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'accept: application/json' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"recipient": "BSUID",
"type": "template",
"template": {
"name": "TEMPLATE_NAME",
"language": {
"code": "LANGUAGE_AND_LOCALE_CODE"
},
"components": [
"<NAMED_PARAMETER_INPUT>",
"<POSITIONAL_PARAMETER_INPUT>"
]
}
}' 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 | ||
| 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 |
| 401 | { "status": "error", "message": "Authentication Failed" } | When API key authentication fails |