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": "4f4f8171-7242-492f-b411-11465b6ae383",
"Success": true,
"ErrorMsg": "sample string 3"
},
"ConversationAnalysisModel": {
"ID": "da54e9d1-791f-4f53-a3fc-8f2899991354",
"ConversationSentenceEntities": [
{
"ID": "0d734def-c4e0-492c-bff8-461880631bf5",
"DictationID": "815dcbb6-bd3a-4e4f-b820-1d14d46224a9",
"SentenceID": "de6cb52a-5ccc-45a3-b59b-38fa5eaa06ff",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "0d734def-c4e0-492c-bff8-461880631bf5",
"DictationID": "815dcbb6-bd3a-4e4f-b820-1d14d46224a9",
"SentenceID": "de6cb52a-5ccc-45a3-b59b-38fa5eaa06ff",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceIntents": [
{
"ID": "01530230-e173-4829-98c3-f5f7d3cea56b",
"DictationID": "57327991-9e52-494d-b9c8-afcae1dd70d6",
"SentenceID": "e87d3b00-3e17-4690-8475-5375a3562d52",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "01530230-e173-4829-98c3-f5f7d3cea56b",
"DictationID": "57327991-9e52-494d-b9c8-afcae1dd70d6",
"SentenceID": "e87d3b00-3e17-4690-8475-5375a3562d52",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceKeywords": [
{
"ID": "df2f497d-e30f-4913-8710-624cbc5f41c6",
"DictationID": "25a6863f-8719-4c4a-be77-1abc72ecd0bb",
"SentenceID": "8cfff626-7b85-455c-bf0d-8a3b3a80fa7f",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "df2f497d-e30f-4913-8710-624cbc5f41c6",
"DictationID": "25a6863f-8719-4c4a-be77-1abc72ecd0bb",
"SentenceID": "8cfff626-7b85-455c-bf0d-8a3b3a80fa7f",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentences": [
{
"ID": "18c80a01-69bb-4932-b932-acf256545b73",
"AudioConversationID": "152b86dd-f033-4d8f-a33e-97dfb3fc6a89",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-02-13T02:37:04.4014234+00:00",
"ExtraInfo": "sample string 8"
},
{
"ID": "18c80a01-69bb-4932-b932-acf256545b73",
"AudioConversationID": "152b86dd-f033-4d8f-a33e-97dfb3fc6a89",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-02-13T02:37:04.4014234+00:00",
"ExtraInfo": "sample string 8"
}
],
"ConversationSentenceScoring": [
{
"ID": "cc3ff73d-7e57-4331-8c90-2d84c954bd0f",
"DictationID": "096dad19-8b70-4d1f-9a7f-49401ea09d11",
"SentenceID": "12f50e35-4349-464e-9bd3-6376c99e39a5",
"AgentID": "f4c17394-6104-4117-afd0-6d227bcdce8b",
"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-02-13T02:37:04.4014234+00:00",
"DateUpdated": "2026-02-13T02:37:04.4014234+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": "cc3ff73d-7e57-4331-8c90-2d84c954bd0f",
"DictationID": "096dad19-8b70-4d1f-9a7f-49401ea09d11",
"SentenceID": "12f50e35-4349-464e-9bd3-6376c99e39a5",
"AgentID": "f4c17394-6104-4117-afd0-6d227bcdce8b",
"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-02-13T02:37:04.4014234+00:00",
"DateUpdated": "2026-02-13T02:37:04.4014234+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": "05452c54-a488-4ff3-b3bf-5c57b3277d1e",
"DictationID": "8fe56347-0fcc-4316-b38d-a3aac9d23499",
"SentenceID": "84571168-b27d-4038-897a-ad858a58c18a",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-02-13T02:37:04.4014234+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
},
{
"ID": "05452c54-a488-4ff3-b3bf-5c57b3277d1e",
"DictationID": "8fe56347-0fcc-4316-b38d-a3aac9d23499",
"SentenceID": "84571168-b27d-4038-897a-ad858a58c18a",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-02-13T02:37:04.4014234+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
}
],
"ConversationText": "sample string 2",
"LanguageCode": "sample string 3",
"DateCreated": "2026-02-13T02:37:04.4014234+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>815dcbb6-bd3a-4e4f-b820-1d14d46224a9</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>0d734def-c4e0-492c-bff8-461880631bf5</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>de6cb52a-5ccc-45a3-b59b-38fa5eaa06ff</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>815dcbb6-bd3a-4e4f-b820-1d14d46224a9</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>0d734def-c4e0-492c-bff8-461880631bf5</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>de6cb52a-5ccc-45a3-b59b-38fa5eaa06ff</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>57327991-9e52-494d-b9c8-afcae1dd70d6</d2p1:DictationID>
<d2p1:ID>01530230-e173-4829-98c3-f5f7d3cea56b</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>e87d3b00-3e17-4690-8475-5375a3562d52</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>57327991-9e52-494d-b9c8-afcae1dd70d6</d2p1:DictationID>
<d2p1:ID>01530230-e173-4829-98c3-f5f7d3cea56b</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>e87d3b00-3e17-4690-8475-5375a3562d52</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>25a6863f-8719-4c4a-be77-1abc72ecd0bb</d2p1:DictationID>
<d2p1:ID>df2f497d-e30f-4913-8710-624cbc5f41c6</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>8cfff626-7b85-455c-bf0d-8a3b3a80fa7f</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>25a6863f-8719-4c4a-be77-1abc72ecd0bb</d2p1:DictationID>
<d2p1:ID>df2f497d-e30f-4913-8710-624cbc5f41c6</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>8cfff626-7b85-455c-bf0d-8a3b3a80fa7f</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
</d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>f4c17394-6104-4117-afd0-6d227bcdce8b</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-02-13T02:37:04.4014234+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-02-13T02:37:04.4014234+00:00</d2p1:DateUpdated>
<d2p1:DictationID>096dad19-8b70-4d1f-9a7f-49401ea09d11</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>cc3ff73d-7e57-4331-8c90-2d84c954bd0f</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>12f50e35-4349-464e-9bd3-6376c99e39a5</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>f4c17394-6104-4117-afd0-6d227bcdce8b</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-02-13T02:37:04.4014234+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-02-13T02:37:04.4014234+00:00</d2p1:DateUpdated>
<d2p1:DictationID>096dad19-8b70-4d1f-9a7f-49401ea09d11</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>cc3ff73d-7e57-4331-8c90-2d84c954bd0f</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>12f50e35-4349-464e-9bd3-6376c99e39a5</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>8fe56347-0fcc-4316-b38d-a3aac9d23499</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>05452c54-a488-4ff3-b3bf-5c57b3277d1e</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>84571168-b27d-4038-897a-ad858a58c18a</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-02-13T02:37:04.4014234+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>8fe56347-0fcc-4316-b38d-a3aac9d23499</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>05452c54-a488-4ff3-b3bf-5c57b3277d1e</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>84571168-b27d-4038-897a-ad858a58c18a</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-02-13T02:37:04.4014234+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
</d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentences>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>152b86dd-f033-4d8f-a33e-97dfb3fc6a89</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-02-13T02:37:04.4014234+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>18c80a01-69bb-4932-b932-acf256545b73</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>152b86dd-f033-4d8f-a33e-97dfb3fc6a89</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-02-13T02:37:04.4014234+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>18c80a01-69bb-4932-b932-acf256545b73</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-02-13T02:37:04.4014234+00:00</d2p1:DateCreated>
<d2p1:ID>da54e9d1-791f-4f53-a3fc-8f2899991354</d2p1:ID>
<d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
</ConversationAnalysisModel>
<JobStatus>
<ErrorMsg>sample string 3</ErrorMsg>
<JobID>4f4f8171-7242-492f-b411-11465b6ae383</JobID>
<Success>true</Success>
</JobStatus>
<Success>true</Success>
</PayLoadSample>