Actions8
Overview
This node interacts with the Faraz SMS REST API to perform various SMS-related operations. Specifically, the 'Get SMS' operation fetches a sent message by its unique bulk ID. This is useful for retrieving details about a previously sent SMS message, such as its content, status, and metadata. Practical applications include tracking message delivery, auditing sent messages, or integrating SMS history into workflows.
Use Case Examples
- Retrieve details of a sent SMS message using its bulk ID to verify delivery status.
- Fetch message content and metadata for record-keeping or reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Bulk ID | Unique bulk identifier of the message to retrieve. |
Output
JSON
bulkId- The unique identifier of the SMS message batch.message- The content of the SMS message.status- The delivery or processing status of the SMS message.timestamp- The time when the SMS message was sent or processed.
Dependencies
- Faraz SMS REST API
- An API key credential for Faraz SMS API
Troubleshooting
- Ensure the API key credential is correctly configured and valid; missing or invalid keys will cause authentication errors.
- Verify that the provided Bulk ID is correct and corresponds to an existing sent message; invalid IDs may result in errors or empty responses.
- Handle API errors gracefully; the node throws detailed error messages from the Faraz SMS API which can help diagnose issues such as rate limits, invalid parameters, or service outages.
Links
- Faraz SMS API Documentation - Official API documentation for Faraz SMS, useful for understanding available endpoints and parameters.