Transcript Analysis (v2)¶

URL¶

The API follows REST conventions. Perform an HTTPS GET to the URL in order to retrieve Transcript Analysis.

Unlike v1, the v2 endpoint always returns an explicit, per-analysis status for both the transcript summary and sentiment, so clients never have to interpret a missing field. Each analysis has its own independent lifecycle (sentiment can be available while the summary is still pending, and vice versa).

The following response formats are supported, where CUID-33 is the call record id.

Format	Description and URL
json (default)	Returns a JSON object of the transcript analysis. https://mynetwork.invoca.net/call/v2/transcript_analysis/CUID-33

Authentication¶

The API uses OAuth to validate access. The OAuth Token can be passed in two ways. The first way is to pass the OAuth Token in the header of the request. The second is to pass the OAuth Token like any other query parameter. Please note that the OAuth Token is a required parameter. OAuth Tokens may be generated from the Manage API Credentials page.

Status values¶

transcript_summary.status:

Status	Meaning
`available`	The summary has been generated; `text` is present.
`pending`	The summary is enabled and is being (or will be) generated; `text` is absent.
`transcript_too_short`	The transcript was too short to summarize; no summary will be produced.
`no_transcript`	The call has no transcript; no summary will be produced.
`not_applicable`	Transcript summaries are not enabled for this network.

sentiment.status:

Status	Meaning
`available`	Sentiment has been computed; `overall`, `agent`, and `caller` scores are present.
`pending`	Sentiment is enabled and is being (or will be) computed; scores are absent.
`not_applicable`	Sentiment analysis is not enabled for this network.

Response¶

GET

/call/v2/transcript_analysis/<call_record_id>

Get a transcript analysis (summary and sentiment available)

Examples

Get transcript analysis for the given call record CUID-33 where both the summary and sentiment are available

Endpoint:

https://mynetwork.invoca.net/call/v2/transcript_analysis/CUID-33

Format: application/json

Response Code: 200

Response Body:

{
   "call_record_id": "CUID-33",
   "transcript_summary": {
      "status": "available",
      "text": "The customer was looking to purchase a new vehicle."
   },
   "sentiment": {
      "status": "available",
      "overall": { "score": 0.42, "label": "positive" },
      "agent":   { "score": 0.55, "label": "positive" },
      "caller":  { "score": 0.31, "label": "neutral" }
   }
}

GET

/call/v2/transcript_analysis/<call_record_id>

Get a transcript analysis (summary pending, sentiment not enabled)

Examples

Get transcript analysis for the given call record CUID-33 where the summary is still pending and sentiment analysis is not enabled

Endpoint:

https://mynetwork.invoca.net/call/v2/transcript_analysis/CUID-33

Format: application/json

Response Code: 200

Response Body:

{
   "call_record_id": "CUID-33",
   "transcript_summary": {
      "status": "pending"
   },
   "sentiment": {
      "status": "not_applicable"
   }
}

Endpoint:

https://mynetwork.invoca.net/call/v2/transcript_analysis/<call_record_id>