Overview

This node interacts with the Faraz SMS REST API to perform various SMS-related operations. Specifically, the 'Fetch Inbox Messages' operation retrieves received SMS messages from the user's inbox. This node is useful for users who want to programmatically access their SMS inbox messages for processing, monitoring, or integration with other systems. For example, a business could use this node to automatically fetch and analyze customer replies to SMS campaigns.

Use Case Examples

1. Automatically fetch incoming SMS messages to update a customer support system.
2. Retrieve received SMS messages for logging and auditing purposes.

Output

JSON

• id - Unique identifier of the inbox message
• sender - Phone number or identifier of the message sender
• recipient - Phone number or identifier of the message recipient (the user's number)
• message - Content of the received SMS message
• receivedAt - Timestamp when the message was received
• status - Status of the message (e.g., read, unread)

Dependencies

• Requires an API key credential for Faraz SMS API authentication.

Troubleshooting

• Ensure the Faraz SMS API key credential is correctly configured and valid; otherwise, authentication errors will occur.
• If the API returns errors, check the error message for HTTP status codes and details to diagnose issues such as rate limits or invalid parameters.
• Make sure the node operation is set to 'Fetch Inbox Messages' to avoid unsupported operation errors.

Links

• Faraz SMS API Documentation - Official API documentation for Faraz SMS, detailing endpoints and usage.