Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). Specifically, for the Resource "Network" and Operation "Update GSM Sim Card Balance Number For Company," it updates the balance number associated with a GSM SIM card for a given company within a specified hub. This operation is useful in scenarios where telecom or network administrators need to programmatically update or correct the balance number linked to a company's SIM cards, such as managing prepaid balances or updating contact numbers for billing purposes.

Practical examples include:

  • Automatically updating SIM card balance numbers after a recharge transaction.
  • Synchronizing balance numbers across multiple hubs or companies in a telecom management system.
  • Integrating with external billing or CRM systems to keep SIM card information current.

Properties

Name Meaning
Company Id The unique identifier of the company whose GSM SIM card balance number is being updated.
Hub Id The unique identifier of the hub where the company’s SIM card is registered.
Balance Number The new balance number to set for the GSM SIM card; maximum length is 64 characters.
Additional Fields Optional fields; currently supports:
- Sim Card Index Numeric index specifying which SIM card to update if multiple are present (1 or 2).

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation details such as success status, updated balance number, and possibly metadata about the company or SIM card affected. The exact structure depends on the Ajax API response but generally confirms that the balance number was successfully updated.

No binary data output is indicated or expected from this operation.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential configured in n8n.
  • The node uses internal backend modules for HTTP communication and state management.
  • Proper configuration of credentials and network access to the Ajax API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing incorrect companyId or hubId may result in errors indicating the entity was not found.
    • Supplying an invalid balanceNumber (e.g., exceeding max length) might cause validation errors.
    • Incorrect simCardIndex values other than 1 or 2 could lead to unexpected behavior or errors.
  • Error Messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Not Found errors: Double-check the companyId and hubId values for correctness.
    • Validation errors: Ensure all required fields are provided and conform to expected formats and constraints.

Links and References

Discussion