Send Transactional WhatsApp Carousel Template Message

Transactional WhatsApp API enables you to send targeted transactional WhatsApp Carousel messages to your users. You can trigger these WhatsApp messages once a user takes a specific action on your platform.

When creating a new template in either marketing or utility categories, you can select the Carousel template type. This feature enables the creation of multi-card messages, with each card displaying unique content, images, and interactive buttons. Carousel templates offer an engaging way to showcase multiple options or pieces of information within a single message, making it easier to capture user attention and encourage interaction.

Before sending Transactional WhatsApp Carousel template messages, make sure you create your carousel template in InOne first. Refer to Create a WhatsApp Business Carousel Template on InOne for step-by-step guidance.

Endpoint and Headers

Headers

Body Parameters

Sample Requests

Below is a sample request to send a WhatsApp Carousel template message.

curl --location 'https://whatsapp.useinsider.com/v1/send' \ --header 'Content-Type: application/json' \ --header 'x-ins-auth-key: INS.**************************************' \ --data '{ "from": "{{FROM}}", "messages": [ { "phoneNumber": "{{TO}}", "message": { "type": "template", "template": { "name": "{{TEMPLATE_NAME}}", "language": { "code": "{{LANG_CODE}}", "policy": "deterministic" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "{{BODY_1}}" } ] }, { "type": "carousel", "cards": [ { "card_index": 0, "components": [ { "type": "header", "parameters": [ { "type": "image", "image": { "id": "{{IMG_ID_1}}" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "{{CARD_TEXT_1}}" } ] }, { "type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [ { "type": "payload", "payload": "{{PAYLOAD_1}}" } ] }, { "type": "button", "sub_type": "url", "index": "1", "parameters": [ { "type": "text", "text": "{{URL_1}}" } ] } ] }, { "card_index": 1, "components": [ { "type": "header", "parameters": [ { "type": "image", "image": { "id": "{{IMG_ID_2}}" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "{{CARD_TEXT_2}}" } ] }, { "type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [ { "type": "payload", "payload": "{{PAYLOAD_2}}" } ] }, { "type": "button", "sub_type": "url", "index": "1", "parameters": [ { "type": "text", "text": "{{URL_2}}" } ] } ] } ] } ] } } } ] } '

You can use the sample request below if you want to use the quick reply buttons:

curl --location 'https://whatsapp.useinsider.com/v1/send' \ --header 'Content-Type: application/json' \ --header 'x-ins-auth-key: INS.1a2b3c4d5e6f' \ --data '{ "messages": [ { "phoneNumber": "+1**********", "message": { "type": "template", "template": { "name": "{{TEMPLATE_NAME}}", "language": { "code": "{{TEMPLATE_LANGUAGE_CODE}}" "policy": "deterministic", }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "{{PARAMETER_VALUE}}" } ] }, { "type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [ { "type": "payload", "payload": "1" } ] }, { "type": "button", "sub_type": "quick_reply", "index": "1", "parameters": [ { "type": "payload", "payload": "2" } ] } ] } } } ] }'

If you want to use CTA (Call To Action), you can use the sample request below:

curl --location 'https://whatsapp.useinsider.com/v1/send' \ --header 'x-ins-auth-key: INS.kjQu-+bL4HpeZqvgr1j0.d4IVgHl9GcE+_eaKxNA3P8M3q8-emrO3-zalg9GSF29mK+Jz5k' \ --header 'Content-Type: application/json' \ --data '{ "messages": [ { "phoneNumber": "+994558964184", "message": { "type": "template", "template": { "name": "mert_masterfile_media_with_button", "language": { "code": "en", "policy": "deterministic" }, "components": [ { "type": "header", "sub_type": "", "index": "", "parameters": [ { "type": "image", "image": { "link": "https://inshoppingcart.com/seleniumautomation/wp-content/uploads/2018/08/cap-2.jpg" } } ] }, { "type": "body", "sub_type": "", "index": "", "parameters": [ { "type": "text", "text": "https://vikingsankara.com?abc=sha" } ] }, { "type": "button", "sub_type": "url", "index": "0", "parameters": [ { "type": "text", "text": "https://vikingsankara.com" } ] } ] } } } ] }'

curl --location 'https://whatsapp.useinsider.com/v1/send' \ --header 'Content-Type: application/json' \ --header 'x-ins-auth-key: INS.tiNlcL284J8dwCpfoqdR.gpyLwFG-0fSHPS9+kZYNsI-D2IWFNjlaRDlXJrZjx2_ZPTP37I' \ --data '{ "messages": [ { "phoneNumber": "+994558964184", "message": { "type": "template", "template": { "name": "7_image_header_no_button_copy", "language": { "code": "fi", "policy": "deterministic" }, "components": [ { "type": "header", "sub_type": "", "index": "", "parameters": [ { "type": "image", "image": { "link": "https://image.useinsider.com/vikingsankara/media/whatsapp-business/11521/83rbBaWO7H63VmACSXiZ1716506118.jpg" } } ] }, { "type": "body", "sub_type": "", "index": "", "parameters": [ { "type": "text", "text": "shahla" } ] } ] } } } ] }'

Sample Responses

One key information will be returned for each message to be sent. This key will be added to all events related to the message.

{ "keys": [ "whatsapp-*************************" ] }

401 Unauthorized

If you use the wrong key, you will see the following error:

{ "message": "unauthorized" }

429 Rate Limit

If you send more than 1000 requests per second, you will see the following error:

{ "message": "rate limited" }

{
  "message": "ip-restricted",
  "error": {
    "message": "ip-restricted",
    "code": 1088
  }
}

Limitations

• All functions must be executed with a simple HTTPS POST request.

• Only new WhatsApp messages can be sent via this API. No data can be retrieved.

• The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.

• The rate limit is 1000 requests per second.

• Each card in the carousel template must include at least one button.

• All cards should have buttons of the same type and quantity.

• The template supports a minimum of 2 cards and a maximum of 6 cards per message.