Summa icon

Summa

Consume Summa API (v.0.1.7)

Actions182

Overview

This node interacts with the Summa API to manage various telecommunication subscription resources. Specifically, for the SS Subscription resource and the Remove All Supplementary Service operation, it removes all supplementary services associated with a given subscriber identified by their IMSI (International Mobile Subscriber Identity). This is useful in scenarios where an operator or system administrator needs to reset or clear all supplementary service settings for a subscriber, such as disabling call forwarding, barring, or other value-added services in bulk.

Practical examples include:

  • Clearing all supplementary services before applying a new configuration profile.
  • Removing all active supplementary services from a subscriber who is changing plans or leaving the network.
  • Automating cleanup of supplementary services during SIM swaps or subscription deactivations.

Properties

Name Meaning
Imsi The International Mobile Subscriber Identity (IMSI) uniquely identifying the subscriber whose supplementary services are to be removed. This is a required string input.
Supplementary Service Type The type/category of supplementary service to remove. This is a required string input specifying which kind of supplementary services should be cleared.

Output

The node outputs JSON data representing the result of the removal operation. Typically, this will include confirmation of success or failure, status codes, and possibly details about which supplementary services were removed. The exact structure depends on the Summa API response but generally includes:

  • A success indicator or error message.
  • Details about the affected subscriber and supplementary services.
  • Any relevant metadata returned by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Summa API via an API key credential configured in n8n.
  • The node uses an HTTP client internally to communicate with the Summa backend.
  • Proper permissions and API access rights are necessary to perform supplementary service removals.

Troubleshooting

  • Invalid IMSI: If the IMSI provided is incorrect or not found, the API may return an error indicating the subscriber does not exist. Verify the IMSI format and correctness.
  • Insufficient Permissions: Errors related to authorization may occur if the API key lacks rights to modify supplementary services. Ensure the API credentials have appropriate scopes.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the Summa API endpoint.
  • Incorrect Supplementary Service Type: Providing an unsupported or invalid supplementary service type may cause the operation to fail. Confirm valid types with the API documentation.
  • API Rate Limits: Excessive requests might trigger rate limiting; handle retries or backoff accordingly.

Links and References

  • Summa API official documentation (refer to your organization's internal or public API docs).
  • Telecommunications standards for IMSI and supplementary services.
  • n8n documentation on creating and using custom nodes with API credentials.

Discussion