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 allows users to interact with the PortaOne Call Control API, specifically to retrieve a list of SIP calls. This is useful in scenarios where you need to monitor, audit, or process active or historical SIP call data from your PortaOne system within automated workflows. For example, you might use this node to:
- Fetch current SIP call sessions for reporting or alerting.
- Integrate call data into CRM or ticketing systems.
- Automate actions based on call activity (e.g., trigger notifications when certain accounts are involved).
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| AckFor this, subscribe to API notifications using the "enable_api_notifications" method. In case XML (SOAP) or REST JSON API is used, make sure to 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 about subscribing to and clearing API notifications. Also explains parameter prioritization if multiple are provided. |
| AdditionalFields | Optional filters for the SIP calls list. Only one should be specified; if multiple are set, 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 output is a JSON object (or array of objects) representing the list of SIP calls retrieved from the PortaOne Call Control API.
- Each item typically contains details about an individual SIP call, such as identifiers, account information, status, and other call metadata.
- The exact structure depends on the API response but generally includes fields relevant to SIP call tracking.
Dependencies
- External Service: Requires access to a PortaOne instance with the Call Control API enabled.
- Authentication: You must provide valid credentials for either Token Authentication or Basic Authentication.
- n8n Credentials: Set up credentials named
portaOneCallControlTokenApiorportaOneCallControlBasicApiin n8n, depending on your chosen authentication method.
Troubleshooting
- Invalid Credentials: If authentication fails, ensure that the correct credentials are configured in n8n and have sufficient permissions.
- Parameter Priority: If multiple filter parameters are set in "AdditionalFields," only one will be used according to the documented priority. Unexpected results may occur if this is not understood.
- API Notifications: If you do not properly enable or disable API notifications as described in the notice, you may receive incomplete or stale data.
- Common Error Messages:
- "Authentication failed" – Check your credentials and authentication method.
- "Missing required parameter" – Ensure at least one filter parameter is provided if required by your API setup.
- "API notifications not enabled/disabled" – Follow the instructions in the notice property to manage notifications correctly.