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": "250dc39d-d9f6-485d-a824-72e388e11f41",
"Success": true,
"ErrorMsg": "sample string 3"
},
"ConversationAnalysisModel": {
"ID": "6d1879b4-d079-4f3c-a876-7e06ddae1ce7",
"ConversationSentenceEntities": [
{
"ID": "3058a873-8bf1-44af-b789-c627f853d57a",
"DictationID": "9d0de237-07aa-4180-9476-e6d577ee459e",
"SentenceID": "c12b8f30-ee83-480c-b607-9a2c559168d3",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "3058a873-8bf1-44af-b789-c627f853d57a",
"DictationID": "9d0de237-07aa-4180-9476-e6d577ee459e",
"SentenceID": "c12b8f30-ee83-480c-b607-9a2c559168d3",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceIntents": [
{
"ID": "46403da5-f58d-4d8c-8785-effaf0f70630",
"DictationID": "acdb0241-def5-48f4-99b3-c3b1422aba1a",
"SentenceID": "ce3931b9-4694-423d-a522-3a941ebfbeb4",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "46403da5-f58d-4d8c-8785-effaf0f70630",
"DictationID": "acdb0241-def5-48f4-99b3-c3b1422aba1a",
"SentenceID": "ce3931b9-4694-423d-a522-3a941ebfbeb4",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceKeywords": [
{
"ID": "8c995bb0-8436-4bc1-b41f-f146b6ab9879",
"DictationID": "d4decd42-251e-434b-a544-c00dec0ceb3a",
"SentenceID": "97e24fce-e33b-47d0-9408-2444ae543b48",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "8c995bb0-8436-4bc1-b41f-f146b6ab9879",
"DictationID": "d4decd42-251e-434b-a544-c00dec0ceb3a",
"SentenceID": "97e24fce-e33b-47d0-9408-2444ae543b48",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentences": [
{
"ID": "690a3ac8-ab4d-446d-b77a-4332a7479d39",
"AudioConversationID": "8d2e51fd-0278-4631-8677-f6665c66fcff",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-06-13T02:37:49.8478939+00:00",
"ExtraInfo": "sample string 8"
},
{
"ID": "690a3ac8-ab4d-446d-b77a-4332a7479d39",
"AudioConversationID": "8d2e51fd-0278-4631-8677-f6665c66fcff",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-06-13T02:37:49.8478939+00:00",
"ExtraInfo": "sample string 8"
}
],
"ConversationSentenceScoring": [
{
"ID": "a52a4ae0-4707-4500-bbd3-9846c2d7b932",
"DictationID": "5ff60282-2287-4e9e-8fc6-2aa009ab9912",
"SentenceID": "4dc4bd30-c90c-4fa3-a3d8-021093f5583b",
"AgentID": "e3324ee7-9ce5-4e55-9430-2924a858e906",
"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-06-13T02:37:49.8478939+00:00",
"DateUpdated": "2026-06-13T02:37:49.8478939+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": "a52a4ae0-4707-4500-bbd3-9846c2d7b932",
"DictationID": "5ff60282-2287-4e9e-8fc6-2aa009ab9912",
"SentenceID": "4dc4bd30-c90c-4fa3-a3d8-021093f5583b",
"AgentID": "e3324ee7-9ce5-4e55-9430-2924a858e906",
"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-06-13T02:37:49.8478939+00:00",
"DateUpdated": "2026-06-13T02:37:49.8478939+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": "acf9d979-dbac-4db4-bf9b-a7d8a886ad5b",
"DictationID": "4881fe96-ef44-48ed-a248-90ddc214c711",
"SentenceID": "2b2d5ab0-0ff8-4eba-b498-49a87ae89373",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-06-13T02:37:49.8478939+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
},
{
"ID": "acf9d979-dbac-4db4-bf9b-a7d8a886ad5b",
"DictationID": "4881fe96-ef44-48ed-a248-90ddc214c711",
"SentenceID": "2b2d5ab0-0ff8-4eba-b498-49a87ae89373",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-06-13T02:37:49.8478939+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
}
],
"ConversationText": "sample string 2",
"LanguageCode": "sample string 3",
"DateCreated": "2026-06-13T02:37:49.8478939+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>9d0de237-07aa-4180-9476-e6d577ee459e</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>3058a873-8bf1-44af-b789-c627f853d57a</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>c12b8f30-ee83-480c-b607-9a2c559168d3</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>9d0de237-07aa-4180-9476-e6d577ee459e</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>3058a873-8bf1-44af-b789-c627f853d57a</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>c12b8f30-ee83-480c-b607-9a2c559168d3</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>acdb0241-def5-48f4-99b3-c3b1422aba1a</d2p1:DictationID>
<d2p1:ID>46403da5-f58d-4d8c-8785-effaf0f70630</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>ce3931b9-4694-423d-a522-3a941ebfbeb4</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>acdb0241-def5-48f4-99b3-c3b1422aba1a</d2p1:DictationID>
<d2p1:ID>46403da5-f58d-4d8c-8785-effaf0f70630</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>ce3931b9-4694-423d-a522-3a941ebfbeb4</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>d4decd42-251e-434b-a544-c00dec0ceb3a</d2p1:DictationID>
<d2p1:ID>8c995bb0-8436-4bc1-b41f-f146b6ab9879</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>97e24fce-e33b-47d0-9408-2444ae543b48</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>d4decd42-251e-434b-a544-c00dec0ceb3a</d2p1:DictationID>
<d2p1:ID>8c995bb0-8436-4bc1-b41f-f146b6ab9879</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>97e24fce-e33b-47d0-9408-2444ae543b48</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
</d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>e3324ee7-9ce5-4e55-9430-2924a858e906</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-06-13T02:37:49.8478939+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-06-13T02:37:49.8478939+00:00</d2p1:DateUpdated>
<d2p1:DictationID>5ff60282-2287-4e9e-8fc6-2aa009ab9912</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>a52a4ae0-4707-4500-bbd3-9846c2d7b932</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>4dc4bd30-c90c-4fa3-a3d8-021093f5583b</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>e3324ee7-9ce5-4e55-9430-2924a858e906</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-06-13T02:37:49.8478939+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-06-13T02:37:49.8478939+00:00</d2p1:DateUpdated>
<d2p1:DictationID>5ff60282-2287-4e9e-8fc6-2aa009ab9912</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>a52a4ae0-4707-4500-bbd3-9846c2d7b932</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>4dc4bd30-c90c-4fa3-a3d8-021093f5583b</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>4881fe96-ef44-48ed-a248-90ddc214c711</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>acf9d979-dbac-4db4-bf9b-a7d8a886ad5b</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>2b2d5ab0-0ff8-4eba-b498-49a87ae89373</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-06-13T02:37:49.8478939+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>4881fe96-ef44-48ed-a248-90ddc214c711</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>acf9d979-dbac-4db4-bf9b-a7d8a886ad5b</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>2b2d5ab0-0ff8-4eba-b498-49a87ae89373</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-06-13T02:37:49.8478939+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
</d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentences>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>8d2e51fd-0278-4631-8677-f6665c66fcff</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-06-13T02:37:49.8478939+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>690a3ac8-ab4d-446d-b77a-4332a7479d39</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>8d2e51fd-0278-4631-8677-f6665c66fcff</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-06-13T02:37:49.8478939+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>690a3ac8-ab4d-446d-b77a-4332a7479d39</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-06-13T02:37:49.8478939+00:00</d2p1:DateCreated>
<d2p1:ID>6d1879b4-d079-4f3c-a876-7e06ddae1ce7</d2p1:ID>
<d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
</ConversationAnalysisModel>
<JobStatus>
<ErrorMsg>sample string 3</ErrorMsg>
<JobID>250dc39d-d9f6-485d-a824-72e388e11f41</JobID>
<Success>true</Success>
</JobStatus>
<Success>true</Success>
</PayLoadSample>