RCX | API for Workflow Custom Fields Retrieval
Problem Statement:
Currently, custom data collected during call workflows—such as DTMF survey responses configured with "Save Input for Reporting" or custom key-value pairs written via ivr.putReportField()—are only visible inside RingCX Historical Analytics (e.g., Workflow Detail with Custom Fields) and manual/scheduled CSV exports.
There is no supported public REST API endpoint (including interaction-metadata or recording/WFM APIs) that exposes these custom workflow report fields programmatically after an interaction completes.
For customers who need to feed IVR survey results or custom workflow variables (e.g., note_reco, AgentName, customer ratings) into external CRMs, BI tools, or internal databases via API, the current manual export processes create operational friction.
Proposed Solution / Feature Request:
Provide a public REST API capability to query and extract custom workflow reporting fields. Specifically:
API Endpoint Expansion: Add an endpoint (or expand the existing Integration/Interaction Metadata API) that accepts a UII (Unique Interaction Identifier) or date range and returns all captured Custom Field Name / Custom Field Value pairs associated with that call.
Standard Response Payload: Ensure the response JSON schema includes standard call metadata along with all values saved via "Save Input for Reporting" and ivr.putReportField().
Use Case & Business Value:
Automated Survey Data Sync: Allows businesses running CSAT/NPS surveys in RingCX Workflow Studio to automatically ingest customer scores into CRMs (like Salesforce or Zendesk) or data warehouses without requiring manual CSV exports or inline HTTP nodes during the call.
Streamlined Reporting: Enables developers to build custom reporting dashboards outside of RingCX using official, supported public APIs.