Actions8
Overview
This node interacts with the Faraz SMS REST API to retrieve the delivery status of message recipients based on a unique bulk message identifier. It is useful for tracking the delivery outcomes of bulk SMS campaigns, allowing users to monitor which recipients have successfully received the message and which have not. For example, after sending a bulk SMS campaign, a user can use this node to fetch the delivery status of all recipients associated with a specific bulk ID.
Use Case Examples
- A marketing team sends a promotional SMS to thousands of customers and uses this node to check the delivery status of each recipient to ensure the campaign's effectiveness.
- A customer support team sends appointment reminders via SMS and uses this node to verify which recipients received the reminders.
Properties
| Name | Meaning |
|---|---|
| Bulk ID | Unique bulk identifier of the message to retrieve. This is required to specify which bulk message's recipient statuses to fetch. |
Output
JSON
recipient- The recipient's phone number or identifier.status- Delivery status of the message for the recipient.otherProperties- Additional details returned by the Faraz SMS API about the recipient's message status.
Dependencies
- Faraz SMS REST API
- API key credential for authentication
Troubleshooting
- Ensure the provided Bulk ID is correct and corresponds to an existing bulk message in the Faraz SMS system.
- Verify that the API key credential is valid and has the necessary permissions to access message recipient statuses.
- Common error messages include API authentication errors (invalid or missing API key) and invalid Bulk ID errors. To resolve, check credentials and input parameters.
Links
- Faraz SMS API Documentation - Official API documentation for Faraz SMS, useful for understanding available endpoints and parameters.