SmartOLT icon

SmartOLT

Consume SmartOLT API (v0.2.17)

Overview

This node operation enables a VoIP port on an ONU (Optical Network Unit) identified by its unique external ID. It is useful in telecommunications management where VoIP services need to be activated on specific ONU devices. For example, a network administrator can use this operation to activate a VoIP port for a subscriber's ONU by providing the ONU's external ID, the VoIP port number, phone number, and password, along with optional SIP user ID and VoIP profile name.

Use Case Examples

  1. Enabling VoIP service on an ONU for a new subscriber by specifying the ONU's unique external ID and VoIP port details.
  2. Activating a VoIP port on an ONU to restore phone service after maintenance or configuration changes.

Properties

Name Meaning
ONU External ID The unique external identifier of the ONU device. It must contain only alphanumeric characters and is required to specify which ONU to configure.
VoIP Port The specific VoIP port on the ONU to enable. This is a required string input.
Phone Number The phone number to assign to the VoIP port. It can contain only digits and the '+' character, with a maximum length of 25 characters. This is required.
Password The password for the VoIP port. It must be alphanumeric and up to 25 characters long. This is required.
Additional Fields Optional additional parameters for the operation, including SIP User ID (digits and '+' character, max 25 characters) and VoIP Profile Name (string).

Output

JSON

  • result - The response from the SmartOLT API after enabling the ONU VoIP port, typically indicating success or failure and any relevant details.

Dependencies

  • Requires an API key credential for the SmartOLT API to authenticate requests.

Troubleshooting

  • Common issues include invalid ONU External ID format (must be alphanumeric), invalid phone number format (only digits and '+' allowed), and password format errors (alphanumeric only).
  • API errors may occur if the ONU External ID does not exist or the VoIP port is already enabled.
  • Ensure the SmartOLT API credentials are correctly configured and have the necessary permissions.

Links

  • SmartOLT API Documentation - Official API documentation for SmartOLT, detailing endpoints and parameters including enabling ONU VoIP ports.

Discussion