Actions3
- Provisioning Actions
Overview
This node interacts with the Ribbon API to manage fraud group blocking in a telephony provisioning context. Specifically, the "Block Fraud Groups" operation allows users to block certain categories of calls that are prone to fraud, such as all outgoing calls or premium and international calls. This is useful for telecom operators or service providers who want to prevent fraudulent usage patterns by selectively blocking call types.
Practical examples include:
- Blocking all outgoing calls from a specific domain to prevent unauthorized use.
- Blocking premium and international calls on a SIP PBX to reduce fraud risk while allowing local calls.
- Dynamically enabling or disabling blocks based on business rules or detected fraud patterns.
Properties
| Name | Meaning |
|---|---|
| Service Type | The Ribbon service type to connect to. Currently supports "OPI (Provisioning Manager)". |
| Fraud Group Type | Choose the fraud group type to block: - Group 1 - All Outgoing Calls (uses a different API endpoint) - Groups 2-5 - Premium & International (multiple selections allowed) |
| International | (Only for Groups 2-5) Whether international calls are enabled (true/false). Can be set dynamically using expressions. |
| International Excluding HC | (Only for Groups 2-5) Whether international calls excluding HC are enabled (true/false). Can be set dynamically. |
| Local | (Only for Groups 2-5) Whether local calls are enabled (true/false). Can be set dynamically. |
| Long Distance | (Only for Groups 2-5) Whether long distance calls are enabled (true/false). Can be set dynamically. |
| Long Distance Inter Rate Area | (Only for Groups 2-5) Whether long distance inter rate area calls are enabled (true/false). Can be set dynamically. |
| Long Distance Intra Rate Area | (Only for Groups 2-5) Whether long distance intra rate area calls are enabled (true/false). Can be set dynamically. |
| Premium | (Only for Groups 2-5) Whether premium calls are enabled (true/false). Can be set dynamically. |
| Domain Name | (Only for Group 1) The domain name for fraud group 1 operations. Required string input, can use expressions. Example: "xxxxx.xxxxx.xxxx.xx". |
| SIP PBX Name | (Only for Groups 2-5) The SIP PBX identifier for fraud groups 2-5 operations. Required string input, e.g., "50500_50000_x". |
Output
The node outputs JSON data representing the result of the block operation. This typically includes confirmation of the action taken or any error messages returned by the Ribbon API. The exact structure depends on the API response but generally confirms success or failure of the block request.
No binary data output is indicated.
Dependencies
- Requires connection to the Ribbon API via an API key credential configured in n8n.
- Needs the base URL and authentication details for the Ribbon Provisioning Manager service.
- The node sends XML-based SOAP requests to the Ribbon API endpoints.
- Proper network access and permissions to the Ribbon provisioning system are necessary.
Troubleshooting
Common issues:
- Incorrect or missing domain name or SIP PBX identifier will cause the API call to fail.
- Network connectivity problems or invalid credentials will prevent successful communication with the Ribbon API.
- Misconfiguration of fraud group types or boolean flags may lead to unexpected blocking behavior.
Error messages:
- Authentication errors indicate invalid or missing API credentials; verify and update credentials in n8n.
- Validation errors from the API often point to missing required fields like domain name or SIP PBX name; ensure these are correctly provided.
- SOAP faults or malformed XML errors suggest issues in request formatting; check property values and their types.
Links and References
- Ribbon Communications official documentation (for API details and provisioning manager): [Ribbon Communications website]
- n8n documentation on creating custom nodes and handling SOAP APIs: https://docs.n8n.io/
(Note: Specific Ribbon API docs are not included here due to lack of direct source references.)