Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
The node interacts with the SparkBot WhatsApp API, specifically allowing users to retrieve details about outbound messages sent via the platform. The "Get Message" operation under the "Outbound Messages" resource fetches information about a specific outbound message by its ID. This is useful for scenarios where you want to track message delivery status, review message content, or audit communication history.
Practical examples include:
- Fetching the status and metadata of a sent WhatsApp message to confirm delivery.
- Retrieving additional related data such as the device used, agent handling the message, or events associated with the message.
- Integrating message retrieval into workflows that require conditional logic based on message state or history.
Properties
| Name | Meaning |
|---|---|
| Message ID | The unique identifier of the outbound message to retrieve. |
| Include | Additional related information to include in the response. Options: Device, Agent, Events |
- Message ID is required to specify which message to get.
- Include is optional and allows fetching extra details:
- Device: Information about the device that sent the message.
- Agent: Details about the agent responsible for the message.
- Events: Related events (e.g., delivery, read receipts) linked to the message.
Output
The output JSON contains detailed information about the requested outbound message. This typically includes message content, status, timestamps, and identifiers. If the "Include" property is used, the output will also contain nested objects or arrays with additional data about the device, agent, or events related to the message.
The node does not explicitly handle binary data for this operation; all returned data is structured JSON.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- The node depends on the external SparkBot service being accessible and properly configured.
- No additional environment variables are indicated beyond the API key credential.
Troubleshooting
Common issues:
- Invalid or missing Message ID will cause errors; ensure the ID is correct and exists.
- Network or authentication failures if the API key is invalid or expired.
- Requesting unsupported "Include" options may result in incomplete data or errors.
Error messages:
- Errors related to "message not found" indicate the provided Message ID does not exist.
- Authentication errors suggest problems with the API key credential setup.
- Timeout or connectivity errors imply network issues or SparkBot service downtime.
To resolve these:
- Verify the Message ID correctness.
- Check and update the API key credential.
- Ensure network connectivity and SparkBot service availability.
Links and References
- SparkBot WhatsApp API Documentation (general reference for API capabilities)
- n8n documentation on creating custom nodes for further customization guidance