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": "8fbff821-33ee-46bb-9de9-0cf8aba60a1a",
"Success": true,
"ErrorMsg": "sample string 3"
},
"ConversationAnalysisModel": {
"ID": "d7486193-e850-439f-9502-0593233a95f8",
"ConversationSentenceEntities": [
{
"ID": "ee7fd893-ccb4-4175-a086-90276d78efd8",
"DictationID": "6eedf335-0935-49af-8d8b-c22283f63aa5",
"SentenceID": "a03b7e77-54a9-4bb0-b045-184a8964678d",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "ee7fd893-ccb4-4175-a086-90276d78efd8",
"DictationID": "6eedf335-0935-49af-8d8b-c22283f63aa5",
"SentenceID": "a03b7e77-54a9-4bb0-b045-184a8964678d",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceIntents": [
{
"ID": "2b7f5e75-3d4a-4c28-b16f-c13b6ca47369",
"DictationID": "fc3eddd2-97b8-443c-a19f-6bcee9f6297d",
"SentenceID": "15d4b476-d650-4e55-af20-1f271f3e0c6e",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "2b7f5e75-3d4a-4c28-b16f-c13b6ca47369",
"DictationID": "fc3eddd2-97b8-443c-a19f-6bcee9f6297d",
"SentenceID": "15d4b476-d650-4e55-af20-1f271f3e0c6e",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceKeywords": [
{
"ID": "282bc0f1-bc48-4231-a190-9993f18e57f4",
"DictationID": "3209d1d8-7886-4304-974f-5c19c24a1332",
"SentenceID": "2e165b06-6c6c-4f8f-8cf7-9bbda6a46f91",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "282bc0f1-bc48-4231-a190-9993f18e57f4",
"DictationID": "3209d1d8-7886-4304-974f-5c19c24a1332",
"SentenceID": "2e165b06-6c6c-4f8f-8cf7-9bbda6a46f91",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentences": [
{
"ID": "a332d67d-5ad0-48db-8d81-7448120b55b9",
"AudioConversationID": "99d3a368-6676-467e-83dd-cc206348bdf6",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-04-14T03:28:36.8269917+00:00",
"ExtraInfo": "sample string 8"
},
{
"ID": "a332d67d-5ad0-48db-8d81-7448120b55b9",
"AudioConversationID": "99d3a368-6676-467e-83dd-cc206348bdf6",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2026-04-14T03:28:36.8269917+00:00",
"ExtraInfo": "sample string 8"
}
],
"ConversationSentenceScoring": [
{
"ID": "0a5aafcd-3cf4-4aff-bbac-107d318de1e4",
"DictationID": "2db1ad1e-b903-471d-98ac-5f918db4dc33",
"SentenceID": "9dcc5897-5f03-408b-bda0-fa2975359a3f",
"AgentID": "a4a80f90-1a05-4519-85a1-ce8680da73ed",
"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-04-14T03:28:36.8269917+00:00",
"DateUpdated": "2026-04-14T03:28:36.8269917+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": "0a5aafcd-3cf4-4aff-bbac-107d318de1e4",
"DictationID": "2db1ad1e-b903-471d-98ac-5f918db4dc33",
"SentenceID": "9dcc5897-5f03-408b-bda0-fa2975359a3f",
"AgentID": "a4a80f90-1a05-4519-85a1-ce8680da73ed",
"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-04-14T03:28:36.8269917+00:00",
"DateUpdated": "2026-04-14T03:28:36.8269917+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": "876d73c5-5d48-4471-90bc-f2ffaf7158b0",
"DictationID": "01cabe62-4092-4231-a8db-96396b91f3b6",
"SentenceID": "78a1bdbe-6180-4faa-800f-1807b2b4b9e4",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-04-14T03:28:36.8269917+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
},
{
"ID": "876d73c5-5d48-4471-90bc-f2ffaf7158b0",
"DictationID": "01cabe62-4092-4231-a8db-96396b91f3b6",
"SentenceID": "78a1bdbe-6180-4faa-800f-1807b2b4b9e4",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2026-04-14T03:28:36.8269917+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
}
],
"ConversationText": "sample string 2",
"LanguageCode": "sample string 3",
"DateCreated": "2026-04-14T03:28:36.8269917+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>6eedf335-0935-49af-8d8b-c22283f63aa5</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>ee7fd893-ccb4-4175-a086-90276d78efd8</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>a03b7e77-54a9-4bb0-b045-184a8964678d</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>6eedf335-0935-49af-8d8b-c22283f63aa5</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>ee7fd893-ccb4-4175-a086-90276d78efd8</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>a03b7e77-54a9-4bb0-b045-184a8964678d</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>fc3eddd2-97b8-443c-a19f-6bcee9f6297d</d2p1:DictationID>
<d2p1:ID>2b7f5e75-3d4a-4c28-b16f-c13b6ca47369</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>15d4b476-d650-4e55-af20-1f271f3e0c6e</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>fc3eddd2-97b8-443c-a19f-6bcee9f6297d</d2p1:DictationID>
<d2p1:ID>2b7f5e75-3d4a-4c28-b16f-c13b6ca47369</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>15d4b476-d650-4e55-af20-1f271f3e0c6e</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>3209d1d8-7886-4304-974f-5c19c24a1332</d2p1:DictationID>
<d2p1:ID>282bc0f1-bc48-4231-a190-9993f18e57f4</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>2e165b06-6c6c-4f8f-8cf7-9bbda6a46f91</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>3209d1d8-7886-4304-974f-5c19c24a1332</d2p1:DictationID>
<d2p1:ID>282bc0f1-bc48-4231-a190-9993f18e57f4</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>2e165b06-6c6c-4f8f-8cf7-9bbda6a46f91</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
</d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>a4a80f90-1a05-4519-85a1-ce8680da73ed</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-04-14T03:28:36.8269917+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-04-14T03:28:36.8269917+00:00</d2p1:DateUpdated>
<d2p1:DictationID>2db1ad1e-b903-471d-98ac-5f918db4dc33</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>0a5aafcd-3cf4-4aff-bbac-107d318de1e4</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>9dcc5897-5f03-408b-bda0-fa2975359a3f</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>a4a80f90-1a05-4519-85a1-ce8680da73ed</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-04-14T03:28:36.8269917+00:00</d2p1:Date>
<d2p1:DateUpdated>2026-04-14T03:28:36.8269917+00:00</d2p1:DateUpdated>
<d2p1:DictationID>2db1ad1e-b903-471d-98ac-5f918db4dc33</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>0a5aafcd-3cf4-4aff-bbac-107d318de1e4</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>9dcc5897-5f03-408b-bda0-fa2975359a3f</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>01cabe62-4092-4231-a8db-96396b91f3b6</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>876d73c5-5d48-4471-90bc-f2ffaf7158b0</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>78a1bdbe-6180-4faa-800f-1807b2b4b9e4</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-04-14T03:28:36.8269917+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>01cabe62-4092-4231-a8db-96396b91f3b6</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>876d73c5-5d48-4471-90bc-f2ffaf7158b0</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>78a1bdbe-6180-4faa-800f-1807b2b4b9e4</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2026-04-14T03:28:36.8269917+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
</d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentences>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>99d3a368-6676-467e-83dd-cc206348bdf6</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-04-14T03:28:36.8269917+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>a332d67d-5ad0-48db-8d81-7448120b55b9</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>99d3a368-6676-467e-83dd-cc206348bdf6</d2p1:AudioConversationID>
<d2p1:DateCreated>2026-04-14T03:28:36.8269917+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>a332d67d-5ad0-48db-8d81-7448120b55b9</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-04-14T03:28:36.8269917+00:00</d2p1:DateCreated>
<d2p1:ID>d7486193-e850-439f-9502-0593233a95f8</d2p1:ID>
<d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
</ConversationAnalysisModel>
<JobStatus>
<ErrorMsg>sample string 3</ErrorMsg>
<JobID>8fbff821-33ee-46bb-9de9-0cf8aba60a1a</JobID>
<Success>true</Success>
</JobStatus>
<Success>true</Success>
</PayLoadSample>