Actions137
- Business Actions
- Add Product to Collection
- Add Tag to Chat
- Create Collection
- Create Product
- Create Tag
- Delete Collection
- Delete Product
- Delete Tag
- Edit Collection
- Edit Tag
- Get Available Categories
- Get Business Profile
- Get Product
- Get Products By Phone
- Get Tag Colors
- List Collection Products
- List Collections
- List Products
- List Tags
- Remove Product From Collection
- Remove Tag From Chat
- Save Catalog Config
- Set Business Hours
- Set Categories
- Chat Actions
- Community Actions
- Contact Actions
- Event Actions
- Group Actions
- Instance Actions
- Interactive Message Actions
- Message Actions
- Message Action Actions
- Message Status Actions
- Newsletter Actions
- Poll Actions
- Privacy Actions
- Profile Actions
- Proxy Actions
- Queue Actions
- Status/Story Actions
- Webhook Actions
Interactive Message → Send Carousel
AI-generatedSummary
Send a carousel interactive message to a recipient via Zeda API.
Inputs
- phone (required) — Recipient phone number with country code
- delayMessage — Delay in seconds before sending the message (0 = API default 1-3s random)
- delayTyping — Show typing indicator for this many seconds before sending (1-15, 0 = off)
- scheduledFor — ISO 8601 timestamp for scheduled delivery (overrides Delay Message). Must be in the future.
- messageId — Message ID to reply to
- message — Text of the carousel message
- cardType — Type of carousel card layout, either Album Image or Horizontal Scroll Cards
- cards — Array of card objects each with header, footer, body, mediaUrl and optional button collection
- requestOptions — Additional request configuration such as batching, proxy, timeout, and SSL verification
- allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
- proxy — HTTP proxy to use, e.g. http://username:password@myproxy:3128
- timeout — Time in ms to wait for the server to send response headers before aborting the request
Output shape
A JSON object indicating the result of the send request, typically containing a success flag and any server-assigned IDs
The shape may include optional fields like requestId or error details; failures are reported via HTTP status codes.
Examples
Example 1: Send a carousel with two CTA buttons to a contact, scheduling it for tomorrow
phone: 551199999999, delayMessage: 5, cardType: HSCROLL_CARDS, cards: [{header: 'Promo', footer: 'Sale', body: 'Check out', mediaUrl: https://example.com/img.jpg, buttons: [{id: '123', label: 'View', type: cta_url, url: https://example.com}]}], scheduledFor: 2025-10-01T12:00:00Z
Example 2: Send a carousel immediately with custom typing delay and no scheduling
phone: 551199999999, delayTyping: 3, message: 'Hello!', cardType: ALBUM_IMAGE, cards: [{header: 'Alert', footer: 'Info', body: 'New update', mediaUrl: https://example.com/img.jpg}], requestOptions: {timeout: 15000}
Example 3: Resend a reply to an existing interactive message using its messageId
phone: 551199999999, messageId: abc123, cardType: HSCROLL_CARDS, cards: [{header: 'Reply', body: 'Re: your request', buttons: [{id: 'reply', label: 'OK', type: quick_reply}]}]