PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Overview

This node allows you to update a Customer Extension in the PortaOne system via its API. It is designed for scenarios where you need to programmatically modify extension details, such as updating account associations, changing customer information, or altering extension settings. This is particularly useful for telecom service providers or administrators who manage large numbers of extensions and require automation for bulk updates or integration with other business processes.

Practical examples:

  • Automatically updating extension details when a customer's information changes.
  • Integrating with CRM systems to keep extension data synchronized.
  • Bulk-modifying extension properties based on operational needs.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Extension ID ID of the modified extension. (Required)
AdditionalFields Collection of optional fields to update:
- Account ID: The unique ID of the account record.
- CPE ID
- Customer ID: The unique ID of the customer record.
- ID: The subject's ID
- Name: The subject's name
- Port: The CPE device port that will be used by the defined or created account
- Primary ID C Group: The unique ID of a huntgroup to be assigned as the primary group for an extension (0 to unset)
- Prompt Action: The name of action to perform with the prompt
- Published: Indicates whether the extension is accessible via dial-by-name
Simplify Whether to simplify the output data. (true/false) (Required)
SimplifyPath Path to the property that should be returned if simplification is enabled.

Output

  • By default, the node returns the full JSON response from the PortaOne API after updating the extension.
  • If "Simplify" is enabled, only the property specified by "SimplifyPath" is returned.
  • The structure of the output depends on the API response but typically includes updated extension details.
  • Binary data: This node does not output binary data.

Dependencies

  • Requires access to the PortaOne API.
  • Needs either a Token or Basic Authentication credential configured in n8n:
    • portaOneTokenApi for Token Authentication
    • portaOneBasicApi for Basic Authentication

Troubleshooting

Common issues:

  • Invalid credentials: Ensure the correct authentication method and credentials are selected and valid.
  • Missing required fields: The "Extension ID" is mandatory; omitting it will result in errors.
  • API errors: Errors from the PortaOne API (such as invalid IDs or insufficient permissions) will be passed through.

Common error messages:

  • "Missing required parameter: Extension ID" – Make sure to provide the Extension ID.
  • "Authentication failed" – Check your credentials and authentication method.
  • "Resource not found" – Verify that the provided Extension ID exists in PortaOne.

Links and References

Discussion