PIX Session Message

Request Parameters

Key	Description	Value	Data type	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 no where the message need to be send	91785876xxxx	String	Required	Must be a valid phone number
type	Messaging type	text	String	Required	Type should be interactive to send interactive message.
interactive	Add interactive body	"interactive": {<Interactive body>}	object	Required	Key should be a interactive to send interactive message.

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
 "messaging_product": "whatsapp",
 "recipient_type": "individual",
 "to": {{destinationNumber}},
 "type": "interactive",
 "interactive": {
   "type": "order_details",
   "body": {
     "text": "Your message content"
   },
   "action": {
     "name": "review_and_pay",
     "parameters": {
       "reference_id": "987654333",
       "type": "digital-goods",
       "payment_type": "br",
       "payment_settings": [
         {
           "type": "pix_dynamic_code",
           "pix_dynamic_code": {
             "code": "00020101021226.gov.bcb.pix.example.com...",
             "merchant_name": "Account holder name",
             "key": "39580525000189",
             "key_type": "CNPJ"
           }
         }
       ],
       "currency": "BRL",
       "total_amount": {
         "value": 50000,
         "offset": 100
       },
       "order": {
         "status": "pending",
         "tax": {
           "value": 0,
           "offset": 100,
           "description": "optional text"
           },
         "items": [
           {
             "retailer_id": "1234567",
             "name": "Cake",
             "amount": {
               "value": 50000,
               "offset": 100
             },
             "quantity": 1
           }
         ],
         "subtotal": {
           "value": 50000,
           "offset": 100
         }
       }
     }
   }
 }
}'

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