Genex

Interact with Genex API

Actions18

Overview

This node allows you to disconnect a carrier connection for a specific customer and service in the Genex system, specifying a disconnection reason. It is useful in telecom or billing automation scenarios where you need to programmatically terminate a customer's carrier service, such as when a customer cancels their subscription, moves to another provider, or requests a temporary suspension.

Practical examples:

  • Automating the process of disconnecting a mobile or internet service when a customer submits a cancellation request.
  • Scheduling future disconnections (e.g., at the end of a billing cycle).
  • Ensuring compliance by recording the reason for each disconnection.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer whose carrier connection will be disconnected.
Service Number Genex service number associated with the customer. The service must exist in Genex and should not be released.
Carrier Name or ID Select from a list of carriers or specify an ID using an expression. Determines which carrier connection to disconnect.
Disconnection Date The date from which the service should be disconnected. Can be set to a past or future date.
Send Disconnection Request Boolean value indicating whether Genex should send a disconnection request in the provisioning file.
Disconnection Reason Name or ID Select from a list of disconnection reasons or specify an ID using an expression. This records why the disconnection is being performed.

Output

The output will typically include a JSON object reflecting the result of the disconnection operation. While the exact structure depends on the Genex API response, it generally contains:

  • Confirmation of the disconnection request.
  • Details about the affected customer, service, carrier, and disconnection reason.
  • Any error messages if the operation failed.

Example output (structure may vary):

{
  "status": "success",
  "customerNumber": 12345,
  "serviceNumber": "SVC001234",
  "carrier": "CarrierX",
  "disconnectionDate": "2024-07-01T00:00:00Z",
  "disconnectionReason": "Customer Request",
  "provisioningRequestSent": true
}

If the node supports binary data output, it would likely relate to provisioning files or logs, but this is not explicitly indicated here.

Dependencies

  • External Service: Requires access to the Genex API.
  • API Credentials: You must configure n8n with valid genexApi credentials.
  • n8n Configuration: No special environment variables are mentioned, but network access to the Genex API endpoint is required.

Troubleshooting

Common issues:

  • Invalid Customer or Service Number: If the provided numbers do not exist or have already been released, the operation will fail.
  • Missing Required Fields: All fields are required; omitting any will result in errors.
  • Permission Errors: Invalid or missing API credentials will prevent the node from connecting to Genex.
  • Date Format Issues: Ensure the disconnection date is in a valid format.

Error messages:

  • "Must be a valid Genex customer number": Check that the customer exists in Genex.
  • "Service must exist in Genex and should not be released": Verify the service number is correct and active.
  • "Choose from the list, or specify an ID using an expression": Make sure the carrier and disconnection reason are correctly selected or specified.

Links and References

Discussion