4Jawaly SMS Sender icon

4Jawaly SMS Sender

Send SMS messages via 4Jawaly API

Actions4

Get Balance

AI-generated

Overview

This node integrates with the 4Jawaly SMS API to perform operations related to SMS messaging and account management. Specifically, the 'Get Balance' operation retrieves the user's account balance and package information from the 4Jawaly service. This is useful for users who want to monitor their SMS credit balance and active packages to manage their SMS sending capabilities effectively. For example, a business using 4Jawaly to send marketing SMS can use this node to check their remaining balance before sending bulk messages.

Use Case Examples

  1. A marketing team checks their SMS balance before launching a campaign to ensure they have enough credits.
  2. A developer automates monitoring of SMS package usage and balance to trigger alerts when credits are low.

Properties

Name Meaning
Additional Options Optional settings to customize the API request, including batch size for requests and timeout duration in milliseconds.
Return Collection Boolean flag to determine whether to return the full collection of balance data or just the total balance.
Page Size Number of results to return per page when fetching balance data.

Output

JSON

  • success - Indicates if the operation was successful.
  • operation - The operation performed, e.g., 'getBalance'.
  • data
    • collection - Array of balance packages if 'Return Collection' is true.
    • total_balance - The total account balance.

Dependencies

  • 4Jawaly API

Troubleshooting

  • Ensure the API credentials are correctly configured and valid to avoid authentication errors.
  • If the API returns an error message, check the message for details and verify the request parameters such as page size and return collection flag.
  • Timeout errors may occur if the 'Timeout' setting is too low; increase it if necessary.

Links

Discussion