{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"325d57b3-210b-4428-ab3e-c36b10c959ba","name":"VFC Communications Analytics (Intelligent Voice) API","description":"This is the official documentation for the VFC Communications Analytics (Intelligent Voice) API\n\n© 2025 Verint. All rights reserved.\n\n<h1>Product Support</h1>\n\nFor all product enquiries and support including API support:  \n**Online Helpdesk:**\n\n[https://connect.verint.com/](https://connect.verint.com/)\n\n**Further information and sales:**\n\n[https://www.verint.com/compliance-solutions/verint-for-financial-compliance/communications-analytics/](https://www.verint.com/compliance-solutions/verint-for-financial-compliance/communications-analytics/)\n\n<h1>About the API</h1>\n\nThe VFC Communications Analytics (Intelligent Voice) API is a set of stateless service using the HTTPS Protocol based on the REST model.\n\n<h3>API accounts</h3>\n\nBy default, the installer will create one sample API user account. You can\n\n<a href=\"https://support.intelligentvoice.com/hc/en-us/articles/360051264033-Adding-new-API-users\">create additional accounts</a>\n\n<h3>Security</h3>\n\nRequests are transferred securely over HTTPS (TLS) and authenticated using **JWT Bearer tokens**.\n\nTLS can be disabled for development and testing but must be enabled in production use.\n\nThe Intelligent Voice system will automatically create self-signed certificates using a CA included in the installer (ca.intelligentvoice.com). You can choose to trust this included CA certificate in your API client application, or you can\n\n<a href=\"https://support.intelligentvoice.com/hc/en-us/articles/360050114574-HTTPS\">install a certificate</a>\n\non the IV server that you trust (e.g. issued by a public CA or internal corporate CA).  \n \n\n<h1>CA Core Concepts</h1>\n\n<h2>Data Groups</h2>\n\n<p>Groups are the key component of the security model in Communications Analytics. All data in the database is separated into tables by group ID. This allows backup, archiving, restore, and secure deletion on a per-group basis at a database level.<br><br>Group is the only level at which items are held. As such any import of items to process is done into a specified Group. A succession of imports can be made into the same Group.<br><br>A Group is also the lowest level at which items can be authorised for / allocated to a user.<br><br>Every web service method must be accompanied by one or more group IDs.</p>\n\n<h2>Data Structures</h2>\n\n<h3>Items</h3>\n\nItems are the highest level individual data item in Communications Analytics.  \nEach item belongs to one of the following types:\n\n<table><tbody><tr><td><div>Item Type</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Description</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>0</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Email</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Voice / Audio</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Instant Message transcript / Chat conversation</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>3</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Transaction / Trade</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Document</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>SMS or single chat message</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>6</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Video</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h3>Recording Streams</h3>\n\nEach recording in Communications Analytics represents a single audio stream. An item can have a number of recording streams, e.g.:\n\n<ul><li><div>Multiple simultaneously recorded channels, such as speaker separated multi-channel audio (common)</div></li><li><div>Multiple contiguous recordings, such as audio split into two-hour long files (experimental)</div></li></ul>\n\n<h3>Speakers Segment</h3>\n\nEach recording is split into segments by the Communications Analytics diarization process. A new segment starts every time the active speaker changes.\n\n<h3>Single Word SRTs</h3>\n\nEach SRT represents a single word, and consists of the word, it’s start time and length.  \n \n\n<h3>Tagged Words and Phrases</h3>\n\nTags are the key words and phrases for an item which are automatically extracted by the Communications Analytics tagging engine. Each tag has a position and score which enables them to be used for an overview of a single item, for navigation within a single item, or for navigation and tag clouds for a whole set of items, or even multiple groups.  \nTags are labelled Topics within the UI.\n\n<h3>Redaction</h3>\n\nWithin Communications Analytics a single redaction consists of a start and end timestamp pair which will be applied to an entire audio item, including multiple combined recordings if appropriate.  \nRedactions are visible within the system as highlighted sections, and when applied to an export will remove both audio and transcript for the redacted section.  \nRedactions can only be applied to audio and video item types.\n\n<h3>Person or Custodian</h3>\n\nWhen using the Communications Analytics system to review information associated with an identified person, the review target will be referred to as a Person or Custodian.\n\n<h3>User</h3>\n\nReviewers using the Communications Analytics system are referred to as Users. \n\n<h1>Getting Started</h1>\n\n<h3>Ingest Audio Items</h3>\n\nThe are two main methods for ingesting items:\n\n<ol><li><div>\"Import\" endpoint ingests many items and provides summary reporting through the Get Import Details method.</div></li><li><div>\"Create New Item\" endpoint adds items one at a time, with greater control over the data fields.</div></li></ol>\n\nNote - Unrecognised API options will be ignored and no warnings will be logged.\n\nIngest Other Items (email, documents, instant messages)\n\n<ul><li><div>The \"Import\" endpoint can only ingest audio, video and email files.</div></li><li><div>The \"Create New Item\" endpoint can ingest all file types.</div></li></ul>\n\nChecking Progress and Results of Ingested Items\n\n<ul><li><div>The \"Get Import Details\" endpoint has a ‘finished’ column which indicates the ImportFolders job is complete.</div></li><li><div>The \"Get Error List\" endpoint can be queried for errors encountered during processing.</div></li><li><div>The installer ships with scripts summary_csv.py and confidence.py which provide more detailed information directly from the database. These can be used as is, or as an example to query the database. This information will be added to the API in future.</div></li></ul>\n\n<h3>Exporting Results</h3>\n\nThere are several options for getting results:\n\n<ul><li><div>The \"Get Item Details\" endpoint returns all the metadata for an object such as the transcript, lattice and timestamped words with speaker allocation.</div></li><li><div>The \"Get Items By Date Range\"and \"Get Items By Item Id Range\" endpoint do the same as getDocument but for a range of items at once.</div></li><li><div>The \"Export Item As Html\" endpoint returns a self-contained SmartTranscript html file.</div></li><li><div>The \"Get Document As Message\" endpoint returns an item formatted as an email object with optional attachment of either WAV, MP3 or SmartTranscript html file.</div></li><li><div>The \"Export Group To Folder\" endpoint can export different formats to a folder.</div></li></ul>\n\n<h3>Billing Reconciliation / Hours Processed</h3>\n\nFor the purposes of billing, usage is tracked per Group within a Project for a particular Client. To calculate the number of hours processed through the Intelligent Voice system in a period, or for a specific group, use the getRecordingsDuration method.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2521588","collectionId":"325d57b3-210b-4428-ab3e-c36b10c959ba","publishedId":"SWE28zrH","public":true,"publicUrl":"https://api-docs.intelligentvoice.com","privateUrl":"https://go.postman.co/documentation/2521588-325d57b3-210b-4428-ab3e-c36b10c959ba","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"157EFB"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ebcfbb4d-4203-4db8-8a45-01eccba0db4c/ZmRiZWRkMWZlNGZjOTlmMDFjZWI2OGMyODRhNTU3MzJjZTcxMzE4NGQ0YWI5NGIwODc4NzFjOGFjMDQ1Zjk4My5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"A4CDFE"}},{"name":"light","logo":"https://content.pstmn.io/49f11609-2b8d-404e-b5c3-76e9357b1555/ZmRiZWRkMWZlNGZjOTlmMDFjZWI2OGMyODRhNTU3MzJjZTcxMzE4NGQ0YWI5NGIwODc4NzFjOGFjMDQ1Zjk4My5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"157EFB"}}]}},"version":"8.11.6","publishDate":"2024-01-16T12:42:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/49f11609-2b8d-404e-b5c3-76e9357b1555/ZmRiZWRkMWZlNGZjOTlmMDFjZWI2OGMyODRhNTU3MzJjZTcxMzE4NGQ0YWI5NGIwODc4NzFjOGFjMDQ1Zjk4My5wbmc=","logoDark":"https://content.pstmn.io/ebcfbb4d-4203-4db8-8a45-01eccba0db4c/ZmRiZWRkMWZlNGZjOTlmMDFjZWI2OGMyODRhNTU3MzJjZTcxMzE4NGQ0YWI5NGIwODc4NzFjOGFjMDQ1Zjk4My5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/fdbedd1fe4fc99f01ceb68c284a55732ce713184d4ab94b087871c8ac045f983","favicon":"https://intelligentvoice.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.intelligentvoice.com/view/metadata/SWE28zrH"}