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 Option List
AI-generatedSummary
Sends an interactive option list message to a recipient via the 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 — Main message text
- title — Title for the interactive message
- footer — Footer text for the interactive message
- buttonLabel — Label for the list open button
- sections — Collection of button sections, each with title and rows containing description, ID, and title
- requestOptions — Options for request configuration including batching, SSL validation, proxy, and timeout
- allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
- proxy — HTTP proxy to use, optionally with authentication credentials
- timeout — Time in ms to wait for the server to send response headers before aborting the request
Output shape
object containing the identifier of the sent interactive message
Returns a success response with the message ID; on error returns a standard error envelope.
Examples
Example 1: Send a promotional option list to a customer immediately
Phone: 5511999999999, Message: 'Choose an option', Sections: [{Title: 'Option 1', Rows: [{Description: 'Details 1', ID: '1', Title: 'One'}] }], ButtonLabel: 'Select', Timeout: 10000
Example 2: Schedule a reminder message for tomorrow at 10:00 UTC
Phone: 5511999999999, ScheduledFor: '2025-10-02T10:00:00Z', Message: 'Your appointment is tomorrow', Title: 'Reminder', Sections: [{Title: 'Confirm', Rows: [{Description: 'Confirm attendance', ID: 'confirm', Title: 'Yes'}] }], DelayMessage: 0, DelayTyping: 0
Example 3: Send a list with batching using a proxy and custom timeout
Phone: 5511999999999, Sections: [{Title: 'Products', Rows: [{Description: 'Item A', ID: 'A', Title: 'A'}] }], ButtonLabel: 'Buy', RequestOptions: {Batching: {BatchSize: 50, BatchInterval: 1000}}, Proxy: 'http://user:pass@proxy.example.com:3128', Timeout: 15000