Genex

Interact with Genex API

Actions18

Overview

The "Add Carrier Connection" operation for the "Connection" resource in this custom n8n node allows users to add a new carrier connection to an existing Genex service. This is typically used in telecom or billing automation scenarios where you need to programmatically associate a carrier with a customer's service in the Genex system. For example, when onboarding a new customer or updating service details, this node can automate the process of linking carriers and managing service dates.

Practical Example:
A telecom provider automates the provisioning of new services for customers. When a new service is created in Genex, this node can be used to declare which carrier is associated with that service, along with relevant dates, ensuring accurate record-keeping and workflow automation.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer to whom the service belongs.
Service Number Genex service number (from the Service Details section of the Services screen) associated with the customer. The service must exist in Genex and should not be released.
Carrier Name or ID Choose from the list of available carriers, or specify a carrier ID using an expression. Options are dynamically loaded via the getCarriers method.
Declared Date The date from which the service should be declared. Can be set to a past or future date.
Provisioned Date The date on which the service was provisioned.

Output

The node outputs a JSON object containing the result of the Add Carrier Connection operation as returned by the Genex API. The exact structure depends on the API response, but typically includes status information and any data related to the newly added connection.

Example output:

{
  "status": "Success",
  "connectionId": "12345",
  "message": "Carrier connection added successfully"
}

Note: The actual fields may vary based on the Genex API's response.

Dependencies

  • External Service: Requires access to the Genex API.
  • Credentials: A valid genexApi credential must be configured in n8n.
  • Environment: No special environment variables are required beyond standard n8n configuration.

Troubleshooting

  • Invalid Customer or Service Number: If the provided customer or service number does not exist in Genex, the API will return an error. Double-check these values.
  • Missing Required Fields: All properties are required. Omitting any will result in validation errors.
  • API Authentication Errors: Ensure that the genexApi credentials are correctly set up in n8n.
  • Date Format Issues: Make sure that the Declared Date and Provisioned Date are in a valid datetime format accepted by Genex.

Common Error Messages:

  • "Customer not found": Check the Customer Number.
  • "Service not found or already released": Verify the Service Number and its status in Genex.
  • "Authentication failed": Review your Genex API credentials.

Links and References

Discussion