Summa icon

Summa

Consume Summa API (v.0.1.7)

Actions182

HLR Subscription → Add Custom HLR ODB

AI-generated

Overview

This node integrates with the Summa API to add a custom Home Location Register (HLR) Operator Determined Barring (ODB) subscription. It allows users to configure barring settings for outgoing, incoming, roaming, premium rate calls, and other call-related restrictions on a subscriber identified by their IMSI (International Mobile Subscriber Identity).

Common scenarios include telecom operators or service providers managing subscriber call barring policies dynamically via API, such as enabling or disabling certain types of calls or services for specific subscribers.

Practical example: A telecom operator wants to restrict premium rate calls and roaming calls for a particular subscriber. Using this node, they can specify the IMSI and set the appropriate barring options to enforce these restrictions programmatically.

Properties

Name Meaning
Imsi The International Mobile Subscriber Identity of the subscriber for whom the custom HLR ODB is being added.
Send Json Boolean flag indicating whether to send raw JSON data directly (true) or use structured additional fields (false).
Json Data Raw JSON data to send when Send Json is true. This allows full control over the request payload.
Additional Fields Collection of optional structured fields used when Send Json is false. These include:
  Id Numeric identifier for the subscription or operation.
  Barring Of Outgoing Calls String value specifying barring status for outgoing calls.
  Barring Of Incoming Calls String value specifying barring status for incoming calls.
  Barring Of Roaming Calls String value specifying barring status for roaming calls.
  Barring Of Premium Rates Calls Dto Multiple boolean flags grouped into categories like Information, Entertainment, and their roaming variants, allowing fine-grained control over premium rate call barring.
  Operator Specific Barring Dto Boolean flags for up to four operator-specific barring types, enabling customized barring rules defined by the operator.
  Barring Of Invocation Of Call Transfer Dto Collection of fields controlling call transfer barring, including whether both calls are charged to the served subscriber and handling of existing transferred calls in the same MSC or VLR.
  Supp Services Management Boolean flag to enable or disable supplementary services management.
  Barring Of Registration Of Call Forwarding String value to specify barring status for call forwarding registration.
  Barring Of Packet Oriented Services String value to specify barring status for packet-oriented services.

Output

The node outputs JSON data representing the response from the Summa API after attempting to add the custom HLR ODB subscription. This typically includes confirmation of the operation, any identifiers assigned, and status messages.

If the node supports binary data output (not indicated here), it would represent related binary content such as files or encoded data returned by the API.

Dependencies

  • Requires an API key credential for authenticating with the Summa API.
  • Uses an HTTP client internally to communicate with the Summa backend.
  • The node depends on the Summa API version specified in the bundled code (version referenced in the description).
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Invalid IMSI: If the IMSI parameter is missing or malformed, the API will likely reject the request. Ensure the IMSI is correctly formatted and provided.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly configured and tested.
  • Malformed JSON: When Send Json is true, ensure the JSON data is valid and matches the expected schema of the Summa API.
  • Missing required fields: If Send Json is false, ensure all necessary additional fields are provided according to your use case.
  • API errors: The Summa API may return error messages if the barring options conflict or are unsupported. Review the API documentation for valid values and constraints.

Links and References

Discussion