Actions3
- Provisioning Actions
Overview
This node interacts with the Ribbon API to retrieve the status of specific fraud groups within a provisioning context. It is particularly useful for telecom operators or service providers who need to monitor and manage fraud detection groups related to outgoing calls and premium/international call categories.
Typical use cases include:
- Checking the status of all outgoing calls fraud group (Group 1) by specifying a domain name.
- Retrieving statuses for fraud groups 2 to 5, which cover national premium marketing, adult content, anti-money laundering, and international fraud groups, by specifying a SIP PBX identifier.
This enables proactive fraud management and helps maintain service integrity by monitoring suspicious activity groups.
Properties
| Name | Meaning |
|---|---|
| Service Type | The Ribbon service type to connect to. Options: "OPI (Provisioning Manager)" |
| Fraud Group | Select which fraud group status to retrieve. Options: - Group 1 - All Outgoing Calls - Groups 2-5 - National Premium & International |
| Domain Name | (Required if Fraud Group = Group 1) The domain name for fraud group 1 operations. Can use expressions. |
| SIP PBX Name | (Required if Fraud Group = Groups 2-5) The SIP PBX identifier for fraud groups 2-5 operations. |
Output
The node outputs JSON data representing the status information of the selected fraud group(s). The exact structure depends on the Ribbon API response but generally includes details about the fraud group's current state, alerts, or configuration status.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Ribbon API.
- Needs the Ribbon API host URL configured in credentials.
- The node sends SOAP requests with XML content type to the Ribbon API endpoint.
- SSL certificate validation can be optionally skipped based on credential settings.
Troubleshooting
- Missing or invalid credentials: Ensure that the API key and host URL are correctly set up in the node credentials.
- Incorrect property values: For Group 1, the domain name must be provided; for Groups 2-5, the SIP PBX name is required. Omitting these will cause errors.
- Network or SSL issues: If connecting fails due to SSL errors, verify the "allow unauthorized certificates" setting in credentials.
- API errors: The Ribbon API may return faults if the request is malformed or parameters are invalid. Check the input properties carefully.
Links and References
- Ribbon Communications official API documentation (not included here, please refer to your internal or vendor-provided docs)
- n8n documentation on creating and using custom nodes with SOAP APIs