Download OpenAPI specification:Download
Returns a paginated collection of analytics results, optionally filtered by a date range.
| Page | integer <int32> |
| Rows | integer <int32> [ 0 .. 100 ] |
| DateFrom | string |
| DateTo | string |
curl -X GET "https://api.example.com/api/v1/analytics?Page=123&Rows=123&DateFrom=sample&DateTo=sample"
Creates an analytics result from the supplied call analysis data.
object (CallMetadataViewModel) | |
object (ConversationSummaryViewModel) | |
object (CustomerSignalsViewModel) | |
object (AgentPerformanceViewModel) | |
object (SentimentTopicsEmotionViewModel) | |
object (BusinessInsightsViewModel) | |
object (ExtractedKeywordsEntitiesViewModel) | |
object (ScoringInsightsViewModel) | |
| Quick Insight Summary | string or null |
| callId | integer <int64> |
| summaryType | integer <int32> (SummaryType) Enum: "0 - Sales" "1 - CustomerSupport" |
{- "Call Metadata": {
- "agent": "string",
- "customer": "string",
- "Call Type": "string"
}, - "Conversation Summary": {
- "Main Topics Discussed": [
- "string"
], - "Resolution / Next Steps": "string"
}, - "Customer Signals": {
- "Positive Indicators": [
- "string"
], - "Potential Concerns": [
- "string"
], - "Buying Intent Level": "string",
- "Urgency Level": "string"
}, - "Agent Performance": {
- "strengths": [
- "string"
], - "Opportunities for Improvement": [
- "string"
]
}, - "Sentiment, Topics & Emotion": {
- "topics": [
- "string"
], - "Overall Sentiment": "string",
- "Customer Emotion": "string",
- "Agent Emotion": "string"
}, - "Business Insights": {
- "Sales Opportunity": "string",
- "Upsell / Cross-sell Opportunities": "string",
- "Issue Category": "string",
- "First Contact Resolution": "string",
- "Escalation Signals": "string",
- "Customer Retention Concerns": "string",
- "Follow-up Actions Required": "string",
- "Risk Level": "string",
- "Churn or Objection Signals": "string",
- "Next Steps (Critical)": "string"
}, - "Extracted Keywords & Entities": {
- "keywords": [
- "string"
], - "entities": {
- "names": [
- "string"
], - "companies": [
- "string"
], - "products": [
- "string"
], - "dates": [
- "string"
], - "Contact Info": [
- "string"
]
}
}, - "Scoring Insights": {
- "Customer Satisfaction": "string",
- "Agent Clarity": "string",
- "Professionalism & Tone": "string",
- "Resolution Effectiveness": "string",
- "Sales Opportunity Management": "string",
- "Issue Resolution Quality": "string",
- "Empathy & Active Listening": "string",
- "Sentiment & Relationship Building": "string",
- "Overall Call Score": "string"
}, - "Quick Insight Summary": "string",
- "callId": 0,
- "summaryType": "0 - Sales"
}Creates a sensitive-content analytics result from the supplied detection data.
| callId | integer <int64> |
| removeTags | boolean |
Array of objects or null (SensitiveContentSegment) |
{- "callId": 0,
- "removeTags": true,
- "segments": [
- {
- "id": 0,
- "content": "string"
}
]
}Creates analytics results for custom questions from the supplied result data.
| callId | integer <int64> |
object or null |
{- "callId": 0,
- "answers": {
- "property1": {
- "passed": true,
- "detected_name": "string",
- "evidence": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "passed": true,
- "detected_name": "string",
- "evidence": "string",
- "property1": null,
- "property2": null
}
}
}Authenticates the supplied credentials and returns an access token.
| username | string or null |
| password | string or null |
{- "username": "string",
- "password": "string"
}Returns the current processing status for the call identified by the path ID.
| id required | integer <int32> |
curl -X GET "https://api.example.com/api/v1/calls/123/status"
Returns live events for a call, with optional cursor-based filtering and a result limit.
| id required | integer <int64> |
| afterId | integer <int64> Default: 0 |
| limit | integer <int32> Default: 200 |
curl -X GET "https://api.example.com/api/v1/calls/123/live-events?afterId=123&limit=123"
Returns the live payload for a call, optionally starting at the specified byte offset.
| id required | integer <int32> |
| fromByte | integer <int32> Default: 0 |
curl -X GET "https://api.example.com/api/v1/calls/123/live-payload?fromByte=123"
Returns a paginated collection of calls matching the supplied date, file, topic, sentiment, tag, content, and cluster filters.
| Page | integer <int32> |
| Rows | integer <int32> [ 0 .. 100 ] |
| DateFrom | string |
| DateTo | string |
| FileName | string |
| Topic | string |
| Sentiment | string |
| Tag | string |
| Content | string |
| Cluster | string |
curl -X GET "https://api.example.com/api/v1/calls?Page=123&Rows=123&DateFrom=sample&DateTo=sample&FileName=sample&Topic=sample&Sentiment=sample&Tag=sample&Content=sample&Cluster=sample"
Returns a paginated collection of intelligence records matching the supplied date and identity filters.
| Page | integer <int32> |
| Rows | integer <int32> |
| DateFrom | string |
| DateTo | string |
| Name | string |
| Username | string |
| Phone | string |
| AccountId | string |
curl -X GET "https://api.example.com/api/v1/intelligence?Page=123&Rows=123&DateFrom=sample&DateTo=sample&Name=sample&Username=sample&Phone=sample&AccountId=sample"
Returns intelligence data for the supplied ID, optionally constrained to a date range.
| id | integer <int64> |
| from | string |
| to | string |
curl -X GET "https://api.example.com/api/v1/intelligence/id?id=123&from=sample&to=sample"
Starts a live speech transcription session using the supplied configuration.
| name | string or null |
| numberOfChannels | integer <int32> |
| language | integer <int32> (Language) Enum: "0 - Auto" "1 - ENGLISH" "2 - CHINESE" "3 - GERMAN" "4 - SPANISH" "5 - RUSSIAN" "6 - KOREAN" "7 - FRENCH" "8 - JAPANESE" "9 - PORTUGUESE" "10 - TURKISH" "11 - POLISH" "12 - DUTCH" "13 - ARABIC" "14 - SWEDISH" "15 - ITALIAN" "16 - INDONESIAN" "17 - HINDI" "18 - FINNISH" "19 - VIETNAMESE" "20 - HEBREW" "21 - UKRAINIAN" "22 - GREEK" "23 - CZECH" "24 - ROMANIAN" "25 - DANISH" "26 - HUNGARIAN" "27 - NORWEGIAN" "28 - CROATIAN" "29 - BULGARIAN" "30 - LITHUANIAN" "31 - LATIN" "32 - SLOVAK" "33 - LATVIAN" "34 - SERBIAN" "35 - SLOVENIAN" "36 - KANNADA" "37 - ESTONIAN" "38 - MACEDONIAN" "39 - ICELANDIC" "40 - ARMENIAN" "41 - BOSNIAN" "42 - ALBANIAN" "43 - BELARUSIAN" "44 - LUXEMBOURGISH" "45 - TAMIL" "46 - CATALAN" "47 - MALAY" "48 - THAI" "49 - URDU" "50 - MAORI" "51 - MALAYALAM" "52 - WELSH" "53 - TELUGU" "54 - PERSIAN" "55 - BENGALI" "56 - AZERBAIJANI" "57 - BRETON" "58 - BASQUE" "59 - NEPALI" "60 - MONGOLIAN" "61 - KAZAKH" "62 - SWAHILI" "63 - GALICIAN" "64 - MARATHI" "65 - PUNJABI" "66 - SINHALA" "67 - KHMER" "68 - SHONA" "69 - YORUBA" "70 - SOMALI" "71 - AFRIKAANS" "72 - OCCITAN" "73 - GEORGIAN" "74 - TAJIK" "75 - SINDHI" "76 - GUJARATI" "77 - AMHARIC" "78 - YIDDISH" "79 - LAO" "80 - UZBEK" "81 - FAROESE" "82 - HAITIANCREOLE" "83 - PASHTO" "84 - TURKMEN" "85 - NYNORSK" "86 - MALTESE" "87 - SANSKRIT" "88 - MYANMAR" "89 - TIBETAN" "90 - TAGALOG" "91 - MALAGASY" "92 - ASSAMESE" "93 - TATAR" "94 - HAWAIIAN" "95 - LINGALA" "96 - HAUSA" "97 - BASHKIR" "98 - JAVANESE" "99 - SUNDANESE" "100 - CANTONESE" |
| translationLanguage | integer <int32> (Language) Enum: "0 - Auto" "1 - ENGLISH" "2 - CHINESE" "3 - GERMAN" "4 - SPANISH" "5 - RUSSIAN" "6 - KOREAN" "7 - FRENCH" "8 - JAPANESE" "9 - PORTUGUESE" "10 - TURKISH" "11 - POLISH" "12 - DUTCH" "13 - ARABIC" "14 - SWEDISH" "15 - ITALIAN" "16 - INDONESIAN" "17 - HINDI" "18 - FINNISH" "19 - VIETNAMESE" "20 - HEBREW" "21 - UKRAINIAN" "22 - GREEK" "23 - CZECH" "24 - ROMANIAN" "25 - DANISH" "26 - HUNGARIAN" "27 - NORWEGIAN" "28 - CROATIAN" "29 - BULGARIAN" "30 - LITHUANIAN" "31 - LATIN" "32 - SLOVAK" "33 - LATVIAN" "34 - SERBIAN" "35 - SLOVENIAN" "36 - KANNADA" "37 - ESTONIAN" "38 - MACEDONIAN" "39 - ICELANDIC" "40 - ARMENIAN" "41 - BOSNIAN" "42 - ALBANIAN" "43 - BELARUSIAN" "44 - LUXEMBOURGISH" "45 - TAMIL" "46 - CATALAN" "47 - MALAY" "48 - THAI" "49 - URDU" "50 - MAORI" "51 - MALAYALAM" "52 - WELSH" "53 - TELUGU" "54 - PERSIAN" "55 - BENGALI" "56 - AZERBAIJANI" "57 - BRETON" "58 - BASQUE" "59 - NEPALI" "60 - MONGOLIAN" "61 - KAZAKH" "62 - SWAHILI" "63 - GALICIAN" "64 - MARATHI" "65 - PUNJABI" "66 - SINHALA" "67 - KHMER" "68 - SHONA" "69 - YORUBA" "70 - SOMALI" "71 - AFRIKAANS" "72 - OCCITAN" "73 - GEORGIAN" "74 - TAJIK" "75 - SINDHI" "76 - GUJARATI" "77 - AMHARIC" "78 - YIDDISH" "79 - LAO" "80 - UZBEK" "81 - FAROESE" "82 - HAITIANCREOLE" "83 - PASHTO" "84 - TURKMEN" "85 - NYNORSK" "86 - MALTESE" "87 - SANSKRIT" "88 - MYANMAR" "89 - TIBETAN" "90 - TAGALOG" "91 - MALAGASY" "92 - ASSAMESE" "93 - TATAR" "94 - HAWAIIAN" "95 - LINGALA" "96 - HAUSA" "97 - BASHKIR" "98 - JAVANESE" "99 - SUNDANESE" "100 - CANTONESE" |
| username | string or null |
| local | string or null |
| remote | string or null |
| sampleRate | integer <int32> |
| multilingualDetection | boolean |
| autoTranslationDirection | boolean |
{- "name": "string",
- "numberOfChannels": 0,
- "language": "0 - Auto",
- "translationLanguage": "0 - Auto",
- "username": "string",
- "local": "string",
- "remote": "string",
- "sampleRate": 0,
- "multilingualDetection": true,
- "autoTranslationDirection": true
}Submits speech audio and its processing options for transcription and analysis.
| dataBase64 | string or null |
| filename | string or null |
| language | integer <int32> (Language) Enum: "0 - Auto" "1 - ENGLISH" "2 - CHINESE" "3 - GERMAN" "4 - SPANISH" "5 - RUSSIAN" "6 - KOREAN" "7 - FRENCH" "8 - JAPANESE" "9 - PORTUGUESE" "10 - TURKISH" "11 - POLISH" "12 - DUTCH" "13 - ARABIC" "14 - SWEDISH" "15 - ITALIAN" "16 - INDONESIAN" "17 - HINDI" "18 - FINNISH" "19 - VIETNAMESE" "20 - HEBREW" "21 - UKRAINIAN" "22 - GREEK" "23 - CZECH" "24 - ROMANIAN" "25 - DANISH" "26 - HUNGARIAN" "27 - NORWEGIAN" "28 - CROATIAN" "29 - BULGARIAN" "30 - LITHUANIAN" "31 - LATIN" "32 - SLOVAK" "33 - LATVIAN" "34 - SERBIAN" "35 - SLOVENIAN" "36 - KANNADA" "37 - ESTONIAN" "38 - MACEDONIAN" "39 - ICELANDIC" "40 - ARMENIAN" "41 - BOSNIAN" "42 - ALBANIAN" "43 - BELARUSIAN" "44 - LUXEMBOURGISH" "45 - TAMIL" "46 - CATALAN" "47 - MALAY" "48 - THAI" "49 - URDU" "50 - MAORI" "51 - MALAYALAM" "52 - WELSH" "53 - TELUGU" "54 - PERSIAN" "55 - BENGALI" "56 - AZERBAIJANI" "57 - BRETON" "58 - BASQUE" "59 - NEPALI" "60 - MONGOLIAN" "61 - KAZAKH" "62 - SWAHILI" "63 - GALICIAN" "64 - MARATHI" "65 - PUNJABI" "66 - SINHALA" "67 - KHMER" "68 - SHONA" "69 - YORUBA" "70 - SOMALI" "71 - AFRIKAANS" "72 - OCCITAN" "73 - GEORGIAN" "74 - TAJIK" "75 - SINDHI" "76 - GUJARATI" "77 - AMHARIC" "78 - YIDDISH" "79 - LAO" "80 - UZBEK" "81 - FAROESE" "82 - HAITIANCREOLE" "83 - PASHTO" "84 - TURKMEN" "85 - NYNORSK" "86 - MALTESE" "87 - SANSKRIT" "88 - MYANMAR" "89 - TIBETAN" "90 - TAGALOG" "91 - MALAGASY" "92 - ASSAMESE" "93 - TATAR" "94 - HAWAIIAN" "95 - LINGALA" "96 - HAUSA" "97 - BASHKIR" "98 - JAVANESE" "99 - SUNDANESE" "100 - CANTONESE" |
| metadata | string or null |
| hasPriority | boolean |
| url | string or null |
| checkFilenameExistence | boolean |
{- "dataBase64": "string",
- "filename": "string",
- "language": "0 - Auto",
- "metadata": "string",
- "hasPriority": true,
- "url": "string",
- "checkFilenameExistence": true
}