Retrieve a list of Transcripts for a given service.

GET /v2/Transcripts

Retrieve a list of Transcripts for a given service.

Query parameters

  • ServiceSid string

    The unique SID identifier of the Service.

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

  • BeforeStartTime string

    Filter by before StartTime.

  • AfterStartTime string

    Filter by after StartTime.

  • BeforeDateCreated string

    Filter by before DateCreated.

  • AfterDateCreated string

    Filter by after DateCreated.

  • Status string

    Filter by status.

  • LanguageCode string

    Filter by Language Code.

  • SourceSid string

    Filter by SourceSid.

  • 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
    • transcripts array[object]
      Hide transcripts attributes Show transcripts attributes object
      • account_sid string | null

        The unique SID identifier of the Account.

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

      • service_sid string | null

        The unique SID identifier of the Service.

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

      • sid string | null

        A 34 character string that uniquely identifies this Transcript.

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

      • date_created string(date-time) | null

        The date that this Transcript was created, given in ISO 8601 format.

      • date_updated string(date-time) | null

        The date that this Transcript was updated, given in ISO 8601 format.

      • status string

        The Status of this Transcript. One of queued, in-progress, completed, failed or canceled.

        Values are queued, in-progress, completed, failed, or canceled.

      • channel

        Media Channel describing Transcript Source and Participant Mapping

      • data_logging boolean | null

        Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

      • language_code string | null

        The default language code of the audio.

      • customer_key string | null
      • media_start_time string(date-time) | null

        The date that this Transcript's media was started, given in ISO 8601 format.

      • duration integer

        The duration of this Transcript's source

        Default value is 0.

      • url string(uri) | null

        The URL of this resource.

      • redaction boolean | null

        If the transcript has been redacted, a redacted alternative of the transcript will be available.

    • 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
curl \
 --request GET 'https://intelligence.twilio.com/v2/Transcripts' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "transcripts",
    "url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "transcripts": [
    {
      "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media",
        "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences",
        "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults"
      },
      "status": "queued",
      "channel": {},
      "duration": 0,
      "redaction": true,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "customer_key": null,
      "data_logging": false,
      "date_created": "2010-08-31T20:36:28Z",
      "date_updated": "2010-08-31T20:36:28Z",
      "language_code": "en-US",
      "media_start_time": null
    }
  ]
}
{
  "meta": {
    "key": "transcripts",
    "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "transcripts": []
}
{
  "meta": {
    "key": "transcripts",
    "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "transcripts": [
    {
      "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media",
        "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences",
        "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults"
      },
      "status": "queued",
      "channel": {},
      "duration": 0,
      "redaction": true,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "customer_key": null,
      "data_logging": false,
      "date_created": "2010-08-31T20:36:28Z",
      "date_updated": "2010-08-31T20:36:28Z",
      "language_code": "en-US",
      "media_start_time": null
    }
  ]
}