Conversation Intelligence (classic) - Transcript Sentence Subresource

A Transcript Sentence subresource represents a transcribed sentence from a given Conversation Intelligence (classic) Transcript.

Transcript Sentence properties

Property nameTypeRequiredPIIDescriptionChild properties

mediaChannelinteger

Optional

Not PII

The channel number.

Default: 0

sentenceIndexinteger

Optional

Not PII

The index of the sentence in the transcript.

Default: 0

startTimestring

Optional

Not PII

Offset from the beginning of the transcript when this sentence starts.

endTimestring

Optional

Not PII

Offset from the beginning of the transcript when this sentence ends.

transcriptstring

Optional

PII MTL: 30 days

Transcript text.

sidSID<GX>

Optional

Not PII

A 34 character string that uniquely identifies this Sentence.

Pattern: ^GX[0-9a-fA-F]{32}$Min length: 34Max length: 34

confidencestring

Optional

Not PII

wordsarray

Optional

Not PII

Detailed information for each of the words of the given Sentence.

Retrieve all Transcript Sentences for a given Transcript

GET https://intelligence.twilio.com/v2/Transcripts/{TranscriptSid}/Sentences

Path parameters

Property nameTypeRequiredPIIDescription

transcriptSidSID<GT>

required

Not PII

The unique SID identifier of the Transcript.

Pattern: ^GT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

redactedboolean

Optional

Not PII

Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is true to access redacted sentences.

wordTimestampsboolean

Optional

Not PII

Returns word level timestamps information, if word_timestamps is enabled. The default is false.

pageSizeinteger<int64>

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 5000.

Minimum: 1Maximum: 5000

pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

The GET request shown below returns a list of Transcript Sentences for a given Transcript, with the WordTimestamps query parameter set to true.

Retrieve all Transcript Sentences for a Transcript

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listSentence() {
14  const sentences = await client.intelligence.v2
15    .transcripts("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .sentences.list({ limit: 20 });
17
18  sentences.forEach((s) => console.log(s.mediaChannel));
19}
20
21listSentence();

Response

1{
2  "sentences": [
3    {
4      "media_channel": 1,
5      "sentence_index": 0,
6      "start_time": null,
7      "end_time": null,
8      "transcript": "test test",
9      "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10      "confidence": null,
11      "words": [
12        {
13          "word": "test",
14          "start_time": null,
15          "end_time": null
16        },
17        {
18          "word": "test",
19          "start_time": null,
20          "end_time": null
21        }
22      ]
23    }
24  ],
25  "meta": {
26    "key": "sentences",
27    "page": 0,
28    "page_size": 50,
29    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
30    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
31    "next_page_url": null,
32    "previous_page_url": null
33  }
34}

Show redacted Transcript Sentences

If PII redaction was enabled at the time the associated Transcript was created, you can retrieve the redacted or unredacted Sentences.

If Redacted is true (the default value), the redacted Sentences are returned.

If Redacted is false , the original, unredacted Sentences are returned.

Retrieve unredacted Sentences for a Transcript

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listSentence() {
14  const sentences = await client.intelligence.v2
15    .transcripts("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .sentences.list({
17      redacted: false,
18      limit: 20,
19    });
20
21  sentences.forEach((s) => console.log(s.mediaChannel));
22}
23
24listSentence();

Response

1{
2  "sentences": [
3    {
4      "media_channel": 1,
5      "sentence_index": 0,
6      "start_time": null,
7      "end_time": null,
8      "transcript": "test test",
9      "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10      "confidence": null,
11      "words": [
12        {
13          "word": "test",
14          "start_time": null,
15          "end_time": null
16        },
17        {
18          "word": "test",
19          "start_time": null,
20          "end_time": null
21        }
22      ]
23    }
24  ],
25  "meta": {
26    "key": "sentences",
27    "page": 0,
28    "page_size": 50,
29    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
30    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
31    "next_page_url": null,
32    "previous_page_url": null
33  }
34}

Retrieve Encrypted Transcript Sentences

Get the encrypted data of the Transcript Sentences by fetching the /Encrypted subresource.

Get Encrypted Sentences

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function fetchEncryptedSentences() {
14  const encryptedSentence = await client.intelligence.v2
15    .transcripts("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .encryptedSentences()
17    .fetch();
18
19  console.log(encryptedSentence.location);
20}
21
22fetchEncryptedSentences();

Response

1{
2  "location": "https://com.twilio.us1.sentences.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted"
5}