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": "f848df59-c75b-4a2b-8798-867de380b393",
"Success": true,
"ErrorMsg": "sample string 3"
},
"ConversationAnalysisModel": {
"ID": "c655c2ed-9abb-49e0-a8ce-399a897ca5d3",
"ConversationSentenceEntities": [
{
"ID": "2667302b-dcd3-423e-be74-27230de01f4b",
"DictationID": "6850f618-8347-4064-bc16-a559a9aab31b",
"SentenceID": "96256973-4792-43da-89ba-2b6d8fb61077",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "2667302b-dcd3-423e-be74-27230de01f4b",
"DictationID": "6850f618-8347-4064-bc16-a559a9aab31b",
"SentenceID": "96256973-4792-43da-89ba-2b6d8fb61077",
"EntityName": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceIntents": [
{
"ID": "c7a9bfc5-5bd8-47d1-9a3d-90b6e60c3a9a",
"DictationID": "f71632e2-7841-49b5-bad7-1685e18f7391",
"SentenceID": "bf84a61c-4885-4120-b664-df16e7323738",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "c7a9bfc5-5bd8-47d1-9a3d-90b6e60c3a9a",
"DictationID": "f71632e2-7841-49b5-bad7-1685e18f7391",
"SentenceID": "bf84a61c-4885-4120-b664-df16e7323738",
"Intent": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentenceKeywords": [
{
"ID": "14a3b3bc-412b-47aa-8e1b-792f260a98a7",
"DictationID": "f2c52e17-4c29-4fd8-8ace-560e8247e9d6",
"SentenceID": "9692eb3b-d231-480f-9d2c-a1a6cd939f07",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
},
{
"ID": "14a3b3bc-412b-47aa-8e1b-792f260a98a7",
"DictationID": "f2c52e17-4c29-4fd8-8ace-560e8247e9d6",
"SentenceID": "9692eb3b-d231-480f-9d2c-a1a6cd939f07",
"Keyword": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true
}
],
"ConversationSentences": [
{
"ID": "5fddb6f6-9319-4ee8-b054-28b1574fe5ed",
"AudioConversationID": "7a7c858d-0c3f-4584-9de7-92c770589e8c",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2025-12-06T05:17:57.308584+00:00",
"ExtraInfo": "sample string 8"
},
{
"ID": "5fddb6f6-9319-4ee8-b054-28b1574fe5ed",
"AudioConversationID": "7a7c858d-0c3f-4584-9de7-92c770589e8c",
"Sentence": "sample string 3",
"SpeakerLabel": "sample string 4",
"SpeakerTypeID": 5,
"IsAgent": true,
"DateCreated": "2025-12-06T05:17:57.308584+00:00",
"ExtraInfo": "sample string 8"
}
],
"ConversationSentenceScoring": [
{
"ID": "445fd322-1721-4adf-b538-dbab14ab736e",
"DictationID": "29a284f1-1617-4075-aac9-bfcda7e0a6c7",
"SentenceID": "8cc66f56-4ef1-467d-b225-fb62ae7f9eee",
"AgentID": "823ed4aa-7b08-4e5f-8ad1-2e3eb381d1b0",
"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": "2025-12-06T05:17:57.308584+00:00",
"DateUpdated": "2025-12-06T05:17:57.308584+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": "445fd322-1721-4adf-b538-dbab14ab736e",
"DictationID": "29a284f1-1617-4075-aac9-bfcda7e0a6c7",
"SentenceID": "8cc66f56-4ef1-467d-b225-fb62ae7f9eee",
"AgentID": "823ed4aa-7b08-4e5f-8ad1-2e3eb381d1b0",
"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": "2025-12-06T05:17:57.308584+00:00",
"DateUpdated": "2025-12-06T05:17:57.308584+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": "a0f20d25-5e2b-4809-a751-83e35a8ff5d6",
"DictationID": "73396f03-1b41-4243-858b-58768e2c0429",
"SentenceID": "d15c99cd-7e78-4fd7-b2c4-92bc55fb79e8",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2025-12-06T05:17:57.308584+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
},
{
"ID": "a0f20d25-5e2b-4809-a751-83e35a8ff5d6",
"DictationID": "73396f03-1b41-4243-858b-58768e2c0429",
"SentenceID": "d15c99cd-7e78-4fd7-b2c4-92bc55fb79e8",
"Topic": "sample string 4",
"Confidence": 5.1,
"SpeakerLabel": "sample string 6",
"IsAgent": true,
"Rank": 8.1,
"Duration": 9.1,
"TimeStamp": "2025-12-06T05:17:57.308584+00:00",
"StartSeconds": 11.1,
"EndSeconds": 12.1
}
],
"ConversationText": "sample string 2",
"LanguageCode": "sample string 3",
"DateCreated": "2025-12-06T05:17:57.308584+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>6850f618-8347-4064-bc16-a559a9aab31b</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>2667302b-dcd3-423e-be74-27230de01f4b</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>96256973-4792-43da-89ba-2b6d8fb61077</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceEntityModel>
<d2p1:ConversationSentenceEntityModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>6850f618-8347-4064-bc16-a559a9aab31b</d2p1:DictationID>
<d2p1:EntityName>sample string 4</d2p1:EntityName>
<d2p1:ID>2667302b-dcd3-423e-be74-27230de01f4b</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>96256973-4792-43da-89ba-2b6d8fb61077</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>f71632e2-7841-49b5-bad7-1685e18f7391</d2p1:DictationID>
<d2p1:ID>c7a9bfc5-5bd8-47d1-9a3d-90b6e60c3a9a</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>bf84a61c-4885-4120-b664-df16e7323738</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceIntentModel>
<d2p1:ConversationSentenceIntentModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>f71632e2-7841-49b5-bad7-1685e18f7391</d2p1:DictationID>
<d2p1:ID>c7a9bfc5-5bd8-47d1-9a3d-90b6e60c3a9a</d2p1:ID>
<d2p1:Intent>sample string 4</d2p1:Intent>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:SentenceID>bf84a61c-4885-4120-b664-df16e7323738</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>f2c52e17-4c29-4fd8-8ace-560e8247e9d6</d2p1:DictationID>
<d2p1:ID>14a3b3bc-412b-47aa-8e1b-792f260a98a7</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>9692eb3b-d231-480f-9d2c-a1a6cd939f07</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
<d2p1:ConversationSentenceKeywordModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>f2c52e17-4c29-4fd8-8ace-560e8247e9d6</d2p1:DictationID>
<d2p1:ID>14a3b3bc-412b-47aa-8e1b-792f260a98a7</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Keyword>sample string 4</d2p1:Keyword>
<d2p1:SentenceID>9692eb3b-d231-480f-9d2c-a1a6cd939f07</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
</d2p1:ConversationSentenceKeywordModel>
</d2p1:ConversationSentenceKeywords>
<d2p1:ConversationSentenceScoring>
<d2p1:ConversationSentenceScoringModel>
<d2p1:AgentID>823ed4aa-7b08-4e5f-8ad1-2e3eb381d1b0</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>2025-12-06T05:17:57.308584+00:00</d2p1:Date>
<d2p1:DateUpdated>2025-12-06T05:17:57.308584+00:00</d2p1:DateUpdated>
<d2p1:DictationID>29a284f1-1617-4075-aac9-bfcda7e0a6c7</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>445fd322-1721-4adf-b538-dbab14ab736e</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>8cc66f56-4ef1-467d-b225-fb62ae7f9eee</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>823ed4aa-7b08-4e5f-8ad1-2e3eb381d1b0</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>2025-12-06T05:17:57.308584+00:00</d2p1:Date>
<d2p1:DateUpdated>2025-12-06T05:17:57.308584+00:00</d2p1:DateUpdated>
<d2p1:DictationID>29a284f1-1617-4075-aac9-bfcda7e0a6c7</d2p1:DictationID>
<d2p1:Disgust>26.1</d2p1:Disgust>
<d2p1:Fear>27.1</d2p1:Fear>
<d2p1:ID>445fd322-1721-4adf-b538-dbab14ab736e</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>8cc66f56-4ef1-467d-b225-fb62ae7f9eee</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>73396f03-1b41-4243-858b-58768e2c0429</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>a0f20d25-5e2b-4809-a751-83e35a8ff5d6</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>d15c99cd-7e78-4fd7-b2c4-92bc55fb79e8</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2025-12-06T05:17:57.308584+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
<d2p1:ConversationSentenceTopicModel>
<d2p1:Confidence>5.1</d2p1:Confidence>
<d2p1:DictationID>73396f03-1b41-4243-858b-58768e2c0429</d2p1:DictationID>
<d2p1:Duration>9.1</d2p1:Duration>
<d2p1:EndSeconds>12.1</d2p1:EndSeconds>
<d2p1:ID>a0f20d25-5e2b-4809-a751-83e35a8ff5d6</d2p1:ID>
<d2p1:IsAgent>true</d2p1:IsAgent>
<d2p1:Rank>8.1</d2p1:Rank>
<d2p1:SentenceID>d15c99cd-7e78-4fd7-b2c4-92bc55fb79e8</d2p1:SentenceID>
<d2p1:SpeakerLabel>sample string 6</d2p1:SpeakerLabel>
<d2p1:StartSeconds>11.1</d2p1:StartSeconds>
<d2p1:TimeStamp>2025-12-06T05:17:57.308584+00:00</d2p1:TimeStamp>
<d2p1:Topic>sample string 4</d2p1:Topic>
</d2p1:ConversationSentenceTopicModel>
</d2p1:ConversationSentenceTopics>
<d2p1:ConversationSentences>
<d2p1:ConversationSentenceModel>
<d2p1:AudioConversationID>7a7c858d-0c3f-4584-9de7-92c770589e8c</d2p1:AudioConversationID>
<d2p1:DateCreated>2025-12-06T05:17:57.308584+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>5fddb6f6-9319-4ee8-b054-28b1574fe5ed</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>7a7c858d-0c3f-4584-9de7-92c770589e8c</d2p1:AudioConversationID>
<d2p1:DateCreated>2025-12-06T05:17:57.308584+00:00</d2p1:DateCreated>
<d2p1:ExtraInfo>sample string 8</d2p1:ExtraInfo>
<d2p1:ID>5fddb6f6-9319-4ee8-b054-28b1574fe5ed</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>2025-12-06T05:17:57.308584+00:00</d2p1:DateCreated>
<d2p1:ID>c655c2ed-9abb-49e0-a8ce-399a897ca5d3</d2p1:ID>
<d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
</ConversationAnalysisModel>
<JobStatus>
<ErrorMsg>sample string 3</ErrorMsg>
<JobID>f848df59-c75b-4a2b-8798-867de380b393</JobID>
<Success>true</Success>
</JobStatus>
<Success>true</Success>
</PayLoadSample>