PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n allows you to interact with the PortaOne Call Control API. Specifically, the "Disable Api Notifications" operation under the "Call Control" resource is used to clear or disable API notifications when closing a session. This is particularly useful in telephony or call center automation scenarios where you need to ensure that no lingering notifications remain after an agent's session ends.

Practical Example:
When an agent finishes handling calls and logs out of their system, this node can be used to programmatically notify the backend (via the API) to clear any session-specific data or notifications, ensuring clean state management.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
In case XML (SOAP) or JSON API is used, the agent must call this method to clear the data when closing the session. Note: only one parameter is required, if more than one is specified, the parameter selection will be prioritized in the following order: i_ivr_an, i_account, i_main_office, i_customer, i_c_group. Instructional notice explaining the importance and usage priority of parameters for clearing session data.
AdditionalFields Collection of optional fields to specify which session or entity to clear. Only one is required; if multiple are provided, they are prioritized as follows: I Ivr An, I Account, I Main Office, I Customer, I C Group.
- I Account Numeric identifier for the account whose notifications should be disabled.
- I C Group Numeric identifier for the customer group.
- I Customer Numeric identifier for the customer.
- I Ivr An Numeric identifier for the IVR access number.
- I Main Office Numeric identifier for the main office.

Output

  • The node outputs a json object containing the result of the API call to disable notifications.
  • The structure typically includes status information and may echo back identifiers or confirmation messages from the API.
  • No binary output is produced by this operation.

Dependencies

  • External Services: Requires access to the PortaOne Call Control API endpoint.
  • API Credentials:
    • For Token Authentication: portaOneCallControlTokenApi credentials.
    • For Basic Authentication: portaOneCallControlBasicApi credentials.
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n for the selected authentication method.

Troubleshooting

  • Missing Required Parameter: If none of the additional fields (I Ivr An, I Account, etc.) are provided, the API may return an error indicating insufficient data to identify the session to clear.
  • Authentication Errors: Invalid or missing credentials will result in authentication failures. Double-check that the correct credential type is selected and configured.
  • Parameter Priority Confusion: If multiple identifiers are provided, only the highest-priority one (as per the notice) will be used. Ensure you provide only the most relevant identifier to avoid confusion.

Links and References

Discussion