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.
| Panel |
|---|
| borderColor | #eeeeee |
|---|
| bgColor | white |
|---|
| titleColor | white |
|---|
| borderWidth | 1 |
|---|
| titleBGColor | #000000 |
|---|
| borderStyle | solid |
|---|
| title | In this page |
|---|
|
|
Request parameters
Path parameters
guid
| Type | Required | Example |
|---|
| String | True | 62414dc5-750e-4200-b125-7a11b61e3a28 |
The unique identifier for the recording’s call.
Query string parameter
transcript
| Type | Required | Example |
|---|
| Boolean | False | true |
A flag indicating whether you want to receive the transcript information for the recording. Default is false.
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 responses
Successful requests return a 200 Success code.
Example v1 response
| Code Block |
|---|
|
{
"categories": [
{
"category": "Politeness",
"subcategories": [
"Greeting",
"Closing"
]
},
{
"category": "Communication",
"subcategories": [
"Responsive"
]
}
],
"guid": "0164705c-c206-dce9-d61a-9899855326a0",
"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."
} |
Example v2 response
| Code Block |
|---|
|
{
"categories": [
{
"category": "Politeness",
"categories": [
{
"name": "Greeting",
"matches": "1"
},
{
"name": "Closing",
"matches": "3"
}
]
},
{
"category": "Communication",
"categories": [
{
"name": "Responsive",
"matches": "1"
}
]
}
],
"guid": "0164705c-c206-dce9-d61a-9899855326a0",
"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."
} |
Example v3 response
| Code Block |
|---|
|
{
"categories": [
{
"category": "Politeness",
"categories": [
{
"name": "Greeting",
"matches": "1"
},
{
"name": "Closing",
"matches": "3"
}
]
},
{
"category": "Communication",
"categories": [
{
"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 a call here. Thank you bye."
} |
where an interaction item contains the following parameters:
| Insert excerpt |
|---|
| _ExcerptAPIInteractionItemConversationAnalyzer |
|---|
| _ExcerptAPIInteractionItemConversationAnalyzer |
|---|
| nopanel | true |
|---|
|