Actions23
- Call Control Actions
- Answer Call
- Convert To On Spot Conference
- Delete On Spot Conference Participant
- Disable Api Notifications
- Enable Api Notifications
- Get On Spot Conference List
- Get On Spot Conference Participant List
- Get Sip Calls List
- Hold Call
- Join Calls
- Join On Spot Conference
- Join To Active Call
- Originate Advanced Call
- Play Prompt
- Progress Call
- Ring Call
- Start DTMF Detect
- Stop DTMF Detect
- Stop Play Prompt
- Terminate Call
- Transfer Call
- Unhold Call
- Update On Spot Conference Participant
Overview
The PortaOneCallControl node for n8n enables users to interact with the PortaOne Call Control API, specifically to enable API notifications for call state changes. This is useful in scenarios where real-time updates about call states are required, such as monitoring active calls or integrating telephony events into business workflows. For example, a call center might use this node to receive live notifications about ongoing calls and trigger automated actions based on call status.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. Determines which credentials are required for API access. |
| The method is accessible via WebSockets, XML (SOAP) and JSON API. To receive call state notifications, the agent must subscribe via WebSockets. In case XML (SOAP) or JSON API is used, the agent can only call the get_sip_calls_list method to receive calls in progress. The agent must call the disable_api_notifications 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. | Informational notice describing how to use the notification system and parameter prioritization. No input required. |
| AdditionalFields | Collection of optional parameters to specify the target for notifications. Only one is required; if multiple are provided, priority is: I Ivr An, I Account, I Main Office, I Customer, I C Group. Options: - I Account - I C Group - I Customer - I Ivr An - I Main Office |
Output
- The node outputs a
jsonobject containing the result of enabling API notifications. - The exact structure depends on the API response, but typically includes confirmation of subscription and possibly details about the monitored entity (e.g., account, group, customer).
- If binary data is returned (unlikely for this operation), it would represent raw API responses or logs.
Dependencies
- External Services: Requires access to the PortaOne Call Control API.
- API Credentials:
- For Token Authentication:
portaOneCallControlTokenApicredentials. - For Basic Authentication:
portaOneCallControlBasicApicredentials.
- For Token Authentication:
- n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential types.
Troubleshooting
- Common Issues:
- Invalid Credentials: If incorrect credentials are provided, authentication errors will occur. Ensure the correct authentication method and credentials are selected.
- Missing Required Parameter: At least one of the additional fields (I Account, I C Group, etc.) must be specified. If none are provided, the API may return an error.
- WebSocket Subscription Not Established: If using WebSockets, ensure the agent subscribes properly; otherwise, no notifications will be received.
- Error Messages:
- "Authentication failed" – Check your credentials and authentication method.
- "No valid parameter specified" – Provide at least one of the required additional fields.
- "Unable to connect to API endpoint" – Verify network connectivity and API URL.