The GET /interactions/{guid} endpoint returns categorization and call time breakdown data for a single call recording. Optionally, it can also return the transcript of the recording, if requested, and sentiment summary if enabled for the account.
| Panel |
|---|
| borderColor | #eeeeee |
|---|
| bgColor | white |
|---|
| titleColor | white |
|---|
| borderWidth | 1 |
|---|
| titleBGColor | #000000 |
|---|
| borderStyle | solid |
|---|
| title | In this page |
|---|
|
|
| Insert excerpt |
|---|
| _ExcerptAPICloudNextGen |
|---|
| _ExcerptAPICloudNextGen |
|---|
| nopanel | true |
|---|
|
Header parameters in Requests (Conversation Analyzer API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|
interaction-content:read
| Entire endpoint |
Request parameters
Path parameters
guid
| Type | Required | Example |
|---|
| String | True | 62414dc5-750e-4200-b125-7a11b61e3a28 |
...
A flag indicating whether you want to receive the transcript information for the recording. Default is false.
Requests
Request the transcript, categorization, call time breakdown, and sentiment summary data for a single call
| Code Block |
|---|
| language | powershell |
|---|
| theme | Midnight |
|---|
|
curl -L -X GET "https://***.api.newvoicemedia.com/conversation-analyzer/interactions/0164705c-c206-dce9-d61a-9899855326a0?transcript=true"
-H "Accept: application/vnd.newvoicemedia.v3+json"
-H "Authorization: <ACCESS_TOKEN>" |
Responses
A response to a valid GET /interactions/{guid} request contains a single interaction item with information about the recording for a single call.
...
Successful requests return a 200 Success code.
...
| Code Block |
|---|
|
{
"categories": [
{
"category": "Politeness",
"subcategoriescategories": [
{
"name": "Greeting",
"matches": "1"
},
{
"name": "Closing",
"matches": "3"
}
]
},
{
"category": "Communication",
"subcategoriescategories": [
{
"name": "Responsive",
"matches": "1"
}
]
}
],
"guid": "0164705c-c206-dce9-d61a-9899855326a0",
"language": "en-us",
"status": "processed",
"confidence": "Low",
"callTimeBreakDown": {
"agent": 5,
"customer": 1,
"silence": 4,
"crossTalk": 0
},
"transcript": "Case.\nHi, and yeah, just just a call here. Thank you bye."
"sentimentSummary"
} |
Example v2 response
| Code Block |
|---|
|
{: {
"categoriesoverallSentiment": [-0.05,
"categories": {
"categoryveryNegative": 20,
"Politenessnegative": 20,
"categoriesneutral": 20,
[ "positive": 20,
{ "veryPositive": 20
},
"namedistributionOverTime": [
{
"Greetingscore": 0.61,
"span": {
"matchesstart": 0,
"1end": 10
},
},
{ {
"namescore": 0.61,
"Closing", "span": {
"matchesstart": "3"10,
} "end": 20
] },
},
{ {
"category": "Communication", "categoriesscore": -0.61,
[ "span": {
"namestart": "Responsive"20,
"matchesend": "1"30
}
},
] {
} ], "guidscore": "0164705c-c206-dce9-d61a-9899855326a0"-0.61,
"status": "processed", "confidence": "Low", "callTimeBreakDownspan": {
"agentstart": 5,30,
"customer": 1,end": 40
}
},
{
"silencescore": 4,-0.61,
"crossTalk": 0 "span": {
}, "transcriptstart": "Case.\nHi, and yeah, just just a call here. Thank you bye."
} |
Example v3 response
| Code Block |
|---|
|
{40,
"categoriesend": 50
[ { }
"category": "Politeness", },
{
"categoriesscore": [-0.48,
"span": {
"namestart": "Greeting"50,
"matchesend": "1"60
},
},
{ {
"namescore": 0.05,
"Closingspan",: {
"matchesstart": "3"60,
} "end": 70
] },
},
{ {
"category": "Communication", "categoriesscore": 0.57,
[ "span": {
"namestart": "Responsive"70,
"matchesend": "1"80
}
},
] {
} ], "guidscore": "0164705c-c206-dce9-d61a-9899855326a0",0,
"languagespan": "en-us", {
"statusstart": "processed",80,
"confidence": "Low",end": 90
}
},
"callTimeBreakDown": {
"agentscore": 50,
"customerspan": 1, {
"silencestart": 4,90,
"crossTalkend": 0 100
}
},
"transcript": "Case.\nHi, and yeah, just]
a call here. Thank you}
bye."
} |
where an interaction item contains the following parameters:
| Insert excerpt |
|---|
| _ExcerptAPIInteractionItemConversationAnalyzer |
|---|
| _ExcerptAPIInteractionItemConversationAnalyzer |
|---|
| nopanel | true |
|---|
|
| Insert excerpt |
|---|
| _ExcerptRunInPostman |
|---|
| _ExcerptRunInPostman |
|---|
| nopanel | true |
|---|
|