Update Notice – June 2025
With the release of Mpower Flows in NICE CXone and the retirement of legacy skill assignment, this method may no longer be supported in new tenants. For the current Flow Designer integration method, see the updated article: "Implementing Aegis in NICE CXone Flow Designer."
Purpose
This guide outlines how to integrate Pure CallerID’s Aegis API to dynamically override the outbound Caller ID (ANI) in NICE CXone using a Studio script.
Prerequisites
- Access to NICE CXone Studio scripting interface
- A valid Aegis API key and workflow ID
- A pre-call suppression flow (Phone Flow type)
- Ability to assign scripts to outbound skills (legacy tenants only)
Step-by-Step Integration
-
Create or Open a Studio Script
In CXone Studio, create a new Phone Flow or edit an existing one. -
Add a Rest Api Action Block
Set Verb to GET.
Use this URL (replacing with your actual IDs and keys):
https://aegis.purecallerid.app/api/public/aegis?workflow-id=YOUR_WORKFLOW_ID&to=$(call.to)&from=$(ani)&zip=$(call.zip)&format=json&X-API-KEY=YOUR_API_KEY
Leave Headers and Parameters blank.
Set Result Set to: resultSet -
Add an If Block (Optional)
Use a condition like: resultSet.pcidFromNumber != ""
This ensures you only override ANI if Aegis returned a value. -
Add an Assign Block
Set: ani = resultSet.pcidFromNumber
This overrides the outbound Caller ID with the Aegis-assigned number. -
Complete the Flow
Add a PermitCall or SuppressCall depending on your suppression logic. -
Assign Script to Skill
Legacy-only: Use ACD Admin to assign this script to an outbound skill.
Example Flow Logic
Start
→ Rest Api Action (GET Aegis)
→ If resultSet.pcidFromNumber != ""
→ Assign ani = resultSet.pcidFromNumber
→ PermitCall
Limitations
- Cannot be tested using Studio’s Trace tool (inbound-only)
- Requires legacy skill access (deprecated in Mpower tenants)
- ANI override depends on your dialer honoring the updated ANI
Next Step
If your tenant uses Mpower Flows, see the updated guide for Flow Designer integration.