Get a single interaction (Conversation Analyzer API)
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.
Most URLs in the example code use the following values:Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com
Headers
Header parameters in Requests (Conversation Analyzer API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
| Entire endpoint |
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.
Requests
Request the transcript, categorization and call time breakdown data for a single call
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 responses
Successful requests return a 200 Success
code.
{ "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:
categories
. Categories represent groups of defined phrases that an agent or customer uses during a call.category
. A single category represents a defined phrase type that an agent or customer uses during a call.categories
. (v2 and v3 only)name
.matches
.subcategories
. (v1 only)name
.guid
. Unique identifier of the recording’s call. guid
will match the unique identifier specified in the request.language
. The ISO code for the language used when transcribing the call. (v3 only)status
. The state of the end-to-end processing of the call recording. status
is one of the following values:confidence
. The level of confidence in the transcript. confidence
is one of the following values:callTimeBreakdown
. The time, in seconds, that the recording included one of the following:transcript
. If the transcript
request parameter was true, then transcript contains a transcript of the recording; otherwise, transcript
is null.
For information, see Trying out Vonage Contact Center APIs.