POST api/ConversationAnalysis/InitializeWebHook?callbackURL={callbackURL}
initialize WebHook which will be invoked by Flowscribe once audio anaylsis is done
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| callbackURL |
Call back URL |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Pay Load Sample schema
PayLoadSample| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| JobStatus | JobStatus |
None. |
|
| ConversationAnalysisModel | ConversationAnalysisModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"JobStatus": {
"JobID": "5dcca627-92ed-4f7e-b10f-e40f13bad5f0",
"Success": true,
"ErrorMsg": "sample string 3"
},
"ConversationAnalysisModel": {
"ID": "061b77b5-c2e5-45e5-858d-0fe6a3d8109b",
"ConversationSentenceEntities": [
{
"ID": "2a3873b8-59fa-4e78-98a1-4ebba4537674",
"DictationID": "7b22c11b-7b98-4b4e-8359-5f7d6386f51a",
"SentenceID": "6b2f48dc-e5c0-4bab-9e5d-eb81e2a66008",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "2a3873b8-59fa-4e78-98a1-4ebba4537674",
"DictationID": "7b22c11b-7b98-4b4e-8359-5f7d6386f51a",
"SentenceID": "6b2f48dc-e5c0-4bab-9e5d-eb81e2a66008",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceIntents": [
{
"ID": "50244b25-7f73-442d-8304-cf2a5a392878",
"DictationID": "d97b2fe3-b182-403a-95d1-613834d2da61",
"SentenceID": "f48a5129-e3df-4710-af37-9d309508b52d",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "50244b25-7f73-442d-8304-cf2a5a392878",
"DictationID": "d97b2fe3-b182-403a-95d1-613834d2da61",
"SentenceID": "f48a5129-e3df-4710-af37-9d309508b52d",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceKeywords": [
{
"ID": "70bd543f-0485-4b88-9277-9e4820f4c854",
"DictationID": "3a408b00-3772-4101-b807-10a2f8383842",
"SentenceID": "207f7290-6f5a-4b9e-a616-b4b1874c53c6",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "70bd543f-0485-4b88-9277-9e4820f4c854",
"DictationID": "3a408b00-3772-4101-b807-10a2f8383842",
"SentenceID": "207f7290-6f5a-4b9e-a616-b4b1874c53c6",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentences": [
{
"ID": "a4d8bbbd-d16a-4d62-bbb9-4ab17f6a2e65",
"AudioConversationID": "f21ca670-2ed3-4b2d-b546-4ee9f3ff8f1c",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-10-11T00:41:19.0941294+00:00",
"ExtraInfo": "sample string 8"
},
{
"ID": "a4d8bbbd-d16a-4d62-bbb9-4ab17f6a2e65",
"AudioConversationID": "f21ca670-2ed3-4b2d-b546-4ee9f3ff8f1c",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-10-11T00:41:19.0941294+00:00",
"ExtraInfo": "sample string 8"
}
],
"ConversationSentenceScoring": [
{
"ID": "f7cbfcd6-219c-4080-ba25-adc2bbc9d74d",
"DictationID": "5b2aaa51-abd0-495d-9299-fca724d7500d",
"SentenceID": "6aa11e0d-145a-4bf8-9ecf-02270322b7f5",
"AgentID": "e0523d70-8569-4199-93d8-1976b646e71d",
"Score_Performance": 5.1,
"Score_Empathy": 6.1,
"Score_Quality": 7.1,
"Score_Ownership": 8.1,
"Score_Compliments": 9.1,
"Score_Summary": 10.1,
"CustomerSatisfactionPercentage": 11.1,
"SilencePercentage": 12.1,
"ProblemResolutionPercentage": 13.1,
"CustomerEffortPercentage": 14.1,
"CustomerAverageRating": 15.1,
"WaitingTime": 16.1,
"CustomerQuestionsTime": 17.1,
"AgentTime": 18.1,
"StayingAtHome": true,
"TestedPositive": true,
"TestedNegative": true,
"LivingWithEldery": true,
"CustomersDissatisfiedPercentage": 19.1,
"Date": "2026-10-11T00:41:19.0941294+00:00",
"DateUpdated": "2026-10-11T00:41:19.0941294+00:00",
"CrossTalking": 21.1,
"Joy": 22.1,
"Negativity": 23.1,
"Anger": 24.1,
"Shouting": 25.1,
"Disgust": 26.1,
"Fear": 27.1,
"Sadness": 28.1,
"Relevance": 29.1,
"SentimentScore": 30.1
},
{
"ID": "f7cbfcd6-219c-4080-ba25-adc2bbc9d74d",
"DictationID": "5b2aaa51-abd0-495d-9299-fca724d7500d",
"SentenceID": "6aa11e0d-145a-4bf8-9ecf-02270322b7f5",
"AgentID": "e0523d70-8569-4199-93d8-1976b646e71d",
"Score_Performance": 5.1,
"Score_Empathy": 6.1,
"Score_Quality": 7.1,
"Score_Ownership": 8.1,
"Score_Compliments": 9.1,
"Score_Summary": 10.1,
"CustomerSatisfactionPercentage": 11.1,
"SilencePercentage": 12.1,
"ProblemResolutionPercentage": 13.1,
"CustomerEffortPercentage": 14.1,
"CustomerAverageRating": 15.1,
"WaitingTime": 16.1,
"CustomerQuestionsTime": 17.1,
"AgentTime": 18.1,
"StayingAtHome": true,
"TestedPositive": true,
"TestedNegative": true,
"LivingWithEldery": true,
"CustomersDissatisfiedPercentage": 19.1,
"Date": "2026-10-11T00:41:19.0941294+00:00",
"DateUpdated": "2026-10-11T00:41:19.0941294+00:00",
"CrossTalking": 21.1,
"Joy": 22.1,
"Negativity": 23.1,
"Anger": 24.1,
"Shouting": 25.1,
"Disgust": 26.1,
"Fear": 27.1,
"Sadness": 28.1,
"Relevance": 29.1,
"SentimentScore": 30.1
}
],
"ConversationSentenceTopics": [
{
"ID": "6f065067-bdad-47a5-9bf8-53c06860bfc0",
"DictationID": "5684100b-84b0-4ebf-b625-70e9cd017193",
"SentenceID": "1d0be330-3c7a-433b-a0e9-82b926299f33",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-10-11T00:41:19.0941294+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
},
{
"ID": "6f065067-bdad-47a5-9bf8-53c06860bfc0",
"DictationID": "5684100b-84b0-4ebf-b625-70e9cd017193",
"SentenceID": "1d0be330-3c7a-433b-a0e9-82b926299f33",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-10-11T00:41:19.0941294+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
}
],
"ConversationText": "sample string 2",
"LanguageCode": "sample string 3",
"DateCreated": "2026-10-11T00:41:19.0941294+00:00"
}
}
application/xml, text/xml
Sample:
<PayLoadSample xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.AI.Portal.Models">
<ConversationAnalysisModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSP.AI.Portal.DataLayer.Common">
<d2p1:ConversationSentenceEntities>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>7b22c11b-7b98-4b4e-8359-5f7d6386f51a</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>2a3873b8-59fa-4e78-98a1-4ebba4537674</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>6b2f48dc-e5c0-4bab-9e5d-eb81e2a66008</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>7b22c11b-7b98-4b4e-8359-5f7d6386f51a</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>2a3873b8-59fa-4e78-98a1-4ebba4537674</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>6b2f48dc-e5c0-4bab-9e5d-eb81e2a66008</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
</d2p1:ConversationSentenceEntities>
<d2p1:ConversationSentenceIntents>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>d97b2fe3-b182-403a-95d1-613834d2da61</d2p1:DictationID>
<d2p1:ID>50244b25-7f73-442d-8304-cf2a5a392878</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>f48a5129-e3df-4710-af37-9d309508b52d</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>d97b2fe3-b182-403a-95d1-613834d2da61</d2p1:DictationID>
<d2p1:ID>50244b25-7f73-442d-8304-cf2a5a392878</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>f48a5129-e3df-4710-af37-9d309508b52d</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
</d2p1:ConversationSentenceIntents>
<d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>3a408b00-3772-4101-b807-10a2f8383842</d2p1:DictationID>
<d2p1:ID>70bd543f-0485-4b88-9277-9e4820f4c854</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>207f7290-6f5a-4b9e-a616-b4b1874c53c6</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>3a408b00-3772-4101-b807-10a2f8383842</d2p1:DictationID>
<d2p1:ID>70bd543f-0485-4b88-9277-9e4820f4c854</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>207f7290-6f5a-4b9e-a616-b4b1874c53c6</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
</d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>e0523d70-8569-4199-93d8-1976b646e71d</d2p1:AgentID>
<d2p1:AgentTime>18.1</d2p1:AgentTime>
<d2p1:Anger>24.1</d2p1:Anger>
<d2p1:CrossTalking>21.1</d2p1:CrossTalking>
<d2p1:CustomerAverageRating>15.1</d2p1:CustomerAverageRating>
<d2p1:CustomerEffortPercentage>14.1</d2p1:CustomerEffortPercentage>
<d2p1:CustomerQuestionsTime>17.1</d2p1:CustomerQuestionsTime>
<d2p1:CustomerSatisfactionPercentage>11.1</d2p1:CustomerSatisfactionPercentage>
<d2p1:CustomersDissatisfiedPercentage>19.1</d2p1:CustomersDissatisfiedPercentage>
<d2p1:Date>2026-10-11T00:41:19.0941294+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-10-11T00:41:19.0941294+00:00</d2p1:DateUpdated>
<d2p1:DictationID>5b2aaa51-abd0-495d-9299-fca724d7500d</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>f7cbfcd6-219c-4080-ba25-adc2bbc9d74d</d2p1:ID>
<d2p1:Joy>22.1</d2p1:Joy>
<d2p1:LivingWithEldery>true</d2p1:LivingWithEldery>
<d2p1:Negativity>23.1</d2p1:Negativity>
<d2p1:ProblemResolutionPercentage>13.1</d2p1:ProblemResolutionPercentage>
<d2p1:Relevance>29.1</d2p1:Relevance>
<d2p1:Sadness>28.1</d2p1:Sadness>
<d2p1:Score_Compliments>9.1</d2p1:Score_Compliments>
<d2p1:Score_Empathy>6.1</d2p1:Score_Empathy>
<d2p1:Score_Ownership>8.1</d2p1:Score_Ownership>
<d2p1:Score_Performance>5.1</d2p1:Score_Performance>
<d2p1:Score_Quality>7.1</d2p1:Score_Quality>
<d2p1:Score_Summary>10.1</d2p1:Score_Summary>
<d2p1:SentenceID>6aa11e0d-145a-4bf8-9ecf-02270322b7f5</d2p1:SentenceID>
<d2p1:SentimentScore>30.1</d2p1:SentimentScore>
<d2p1:Shouting>25.1</d2p1:Shouting>
<d2p1:SilencePercentage>12.1</d2p1:SilencePercentage>
<d2p1:StayingAtHome>true</d2p1:StayingAtHome>
<d2p1:TestedNegative>true</d2p1:TestedNegative>
<d2p1:TestedPositive>true</d2p1:TestedPositive>
<d2p1:WaitingTime>16.1</d2p1:WaitingTime>
</d2p1:ConversationSentenceScoringModel>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>e0523d70-8569-4199-93d8-1976b646e71d</d2p1:AgentID>
<d2p1:AgentTime>18.1</d2p1:AgentTime>
<d2p1:Anger>24.1</d2p1:Anger>
<d2p1:CrossTalking>21.1</d2p1:CrossTalking>
<d2p1:CustomerAverageRating>15.1</d2p1:CustomerAverageRating>
<d2p1:CustomerEffortPercentage>14.1</d2p1:CustomerEffortPercentage>
<d2p1:CustomerQuestionsTime>17.1</d2p1:CustomerQuestionsTime>
<d2p1:CustomerSatisfactionPercentage>11.1</d2p1:CustomerSatisfactionPercentage>
<d2p1:CustomersDissatisfiedPercentage>19.1</d2p1:CustomersDissatisfiedPercentage>
<d2p1:Date>2026-10-11T00:41:19.0941294+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-10-11T00:41:19.0941294+00:00</d2p1:DateUpdated>
<d2p1:DictationID>5b2aaa51-abd0-495d-9299-fca724d7500d</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>f7cbfcd6-219c-4080-ba25-adc2bbc9d74d</d2p1:ID>
<d2p1:Joy>22.1</d2p1:Joy>
<d2p1:LivingWithEldery>true</d2p1:LivingWithEldery>
<d2p1:Negativity>23.1</d2p1:Negativity>
<d2p1:ProblemResolutionPercentage>13.1</d2p1:ProblemResolutionPercentage>
<d2p1:Relevance>29.1</d2p1:Relevance>
<d2p1:Sadness>28.1</d2p1:Sadness>
<d2p1:Score_Compliments>9.1</d2p1:Score_Compliments>
<d2p1:Score_Empathy>6.1</d2p1:Score_Empathy>
<d2p1:Score_Ownership>8.1</d2p1:Score_Ownership>
<d2p1:Score_Performance>5.1</d2p1:Score_Performance>
<d2p1:Score_Quality>7.1</d2p1:Score_Quality>
<d2p1:Score_Summary>10.1</d2p1:Score_Summary>
<d2p1:SentenceID>6aa11e0d-145a-4bf8-9ecf-02270322b7f5</d2p1:SentenceID>
<d2p1:SentimentScore>30.1</d2p1:SentimentScore>
<d2p1:Shouting>25.1</d2p1:Shouting>
<d2p1:SilencePercentage>12.1</d2p1:SilencePercentage>
<d2p1:StayingAtHome>true</d2p1:StayingAtHome>
<d2p1:TestedNegative>true</d2p1:TestedNegative>
<d2p1:TestedPositive>true</d2p1:TestedPositive>
<d2p1:WaitingTime>16.1</d2p1:WaitingTime>
</d2p1:ConversationSentenceScoringModel>
</d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>5684100b-84b0-4ebf-b625-70e9cd017193</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>6f065067-bdad-47a5-9bf8-53c06860bfc0</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>1d0be330-3c7a-433b-a0e9-82b926299f33</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-10-11T00:41:19.0941294+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>5684100b-84b0-4ebf-b625-70e9cd017193</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>6f065067-bdad-47a5-9bf8-53c06860bfc0</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>1d0be330-3c7a-433b-a0e9-82b926299f33</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-10-11T00:41:19.0941294+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
</d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentences>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>f21ca670-2ed3-4b2d-b546-4ee9f3ff8f1c</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-10-11T00:41:19.0941294+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>a4d8bbbd-d16a-4d62-bbb9-4ab17f6a2e65</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Sentence>sample string 3</d2p1:Sentence>
<d2p1:SpeakerLabel>sample string 4</d2p1:SpeakerLabel>
<d2p1:SpeakerTypeID>5</d2p1:SpeakerTypeID>
</d2p1:ConversationSentenceModel>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>f21ca670-2ed3-4b2d-b546-4ee9f3ff8f1c</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-10-11T00:41:19.0941294+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>a4d8bbbd-d16a-4d62-bbb9-4ab17f6a2e65</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Sentence>sample string 3</d2p1:Sentence>
<d2p1:SpeakerLabel>sample string 4</d2p1:SpeakerLabel>
<d2p1:SpeakerTypeID>5</d2p1:SpeakerTypeID>
</d2p1:ConversationSentenceModel>
</d2p1:ConversationSentences>
<d2p1:ConversationText>sample string 2</d2p1:ConversationText>
<d2p1:DateCreated>2026-10-11T00:41:19.0941294+00:00</d2p1:DateCreated>
<d2p1:ID>061b77b5-c2e5-45e5-858d-0fe6a3d8109b</d2p1:ID>
<d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
</ConversationAnalysisModel>
<JobStatus>
<ErrorMsg>sample string 3</ErrorMsg>
<JobID>5dcca627-92ed-4f7e-b10f-e40f13bad5f0</JobID>
<Success>true</Success>
</JobStatus>
<Success>true</Success>
</PayLoadSample>