Get all Transcript Sentences by TranscriptSid

GET /v2/Transcripts/{TranscriptSid}/Sentences
Account sid auth token

Get all Transcript Sentences by TranscriptSid

Path parameters

  • TranscriptSid string Required

    The unique SID identifier of the Transcript.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GT[0-9a-fA-F]{32}$.

Query parameters

  • Redacted boolean

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

  • WordTimestamps boolean

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

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 1000.

  • Page integer

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

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sentences array[object]
      Hide sentences attributes Show sentences attributes object
      • media_channel integer

        The channel number.

        Default value is 0.

      • sentence_index integer

        The index of the sentence in the transcript.

        Default value is 0.

      • start_time number | null

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

      • end_time number | null

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

      • transcript string | null

        Transcript text.

      • sid string | null

        A 34 character string that uniquely identifies this Sentence.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GX[0-9a-fA-F]{32}$.

      • confidence number | null
      • words array | null

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

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v2/Transcripts/{TranscriptSid}/Sentences 
curl \
 --request GET 'https://intelligence.twilio.com/v2/Transcripts/{TranscriptSid}/Sentences' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "sentences",
    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "sentences": [
    {
      "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "words": [
        {
          "word": "test",
          "end_time": null,
          "start_time": null
        },
        {
          "word": "test",
          "end_time": null,
          "start_time": null
        }
      ],
      "end_time": null,
      "confidence": null,
      "start_time": null,
      "transcript": "test test",
      "media_channel": 1,
      "sentence_index": 0
    }
  ]
}
{
  "meta": {
    "key": "sentences",
    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=true&WordTimestamps=true&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=true&WordTimestamps=true&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "sentences": [
    {
      "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "words": [
        {
          "word": "test",
          "end_time": null,
          "start_time": null
        },
        {
          "word": "test",
          "end_time": null,
          "start_time": null
        }
      ],
      "end_time": null,
      "confidence": null,
      "start_time": null,
      "transcript": "test test",
      "media_channel": 1,
      "sentence_index": 0
    }
  ]
}