Actions10
Overview
This node allows sending various types of messages through a messaging API, focusing here on the "Send Options List" operation within the "Send Message" resource. It enables sending a text message accompanied by an interactive options list button. When users receive this message, they see a button that, when clicked, displays a list of selectable options with titles, descriptions, and IDs.
Common scenarios include:
- Customer support bots offering predefined choices to users.
- Interactive surveys or polls where users select from given options.
- Menu selections in chat-based ordering systems.
Example: Sending a message "Choose your preferred delivery time:" with a button labeled "Select Time" that opens a list of time slots as options.
Properties
| Name | Meaning |
|---|---|
| Phone | The recipient's phone number in international format (e.g., 5511999999999). |
| Text | The main text message content sent alongside the options list. |
| Button Label | The label displayed on the button that reveals the options list when clicked. |
| Options Title | The title shown above the list of options when the button is pressed. |
| Options | A collection of options, each with: |
| - Option Title: The visible title of the option. | |
| - Option Description: Additional descriptive text for the option. | |
| - Option ID: Identifier for the option, useful for tracking user selection. | |
| Additional Fields | Optional extra settings including: |
| - Delay Message: Seconds to wait before sending the message (1-15). | |
| - Delay Typing: Seconds to show "Typing..." status before sending (0-15). | |
| - Message ID to Reply: ID of a message to which this message should reply. |
Output
The node outputs a JSON array where each element corresponds to the response from the messaging API for each input item processed. The structure typically includes confirmation details about the sent message, such as message IDs or status.
If binary data were involved (not in this operation), it would represent media content sent or received.
Dependencies
- Requires an active connection to the messaging API service via an API key credential configured in n8n.
- The node uses HTTP POST requests to send messages.
- No additional external dependencies beyond the configured API access.
Troubleshooting
- Unknown Operation Error: If an unsupported operation is selected, the node throws an error indicating the operation is not known. Ensure "send-option-list" is correctly chosen.
- Unknown Resource Error: Selecting a resource other than "send-message" will cause an error. Confirm the resource setting.
- Invalid Phone Number: The phone number must be in the correct international format; otherwise, the API may reject the request.
- Missing Required Fields: Omitting required fields like Phone, Text, Button Label, Options Title, or Options will cause errors.
- API Request Failures: Network issues or invalid API credentials can cause request failures. Verify API key validity and network connectivity.
- Delays Misconfiguration: Setting delay values outside allowed ranges (Delay Message: 1-15 seconds, Delay Typing: 0-15 seconds) may cause unexpected behavior.
Links and References
- Messaging API Documentation (Replace with actual API docs)
- n8n Documentation on Creating Custom Nodes
- Interactive Messages Guide (Replace with relevant resource)