REST Client MethodsRecording Transcriptions

List

View as Markdown

Use this endpoint for the Recording Transcriptions method to read all of the recording transcriptions that are associated with your account. This will be returned as a list of transcriptions.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this transcription.

Query parameters

DateCreatedstringOptional
Filter by transcriptions created on this exact date (RFC 2822 format).
DateCreated<stringOptional
Filter by transcriptions created before this date (RFC 2822 format).
DateCreated>stringOptional
Filter by transcriptions created after this date (RFC 2822 format).
PageintegerOptional>=0Defaults to 0
The page number to retrieve (zero-indexed).
PageSizeintegerOptional1-1000Defaults to 50
The number of results per page. Default is 50, maximum is 1000.
PageTokenstringOptional
Token for cursor-based pagination. Required when navigating to pages beyond the first.

Response

uristringRequired
The URI of the current page.
first_page_uristringRequired
The URI of the first page.
next_page_uristring or nullRequired
The URI of the next page. Null if there are no more pages.
previous_page_uristring or nullRequired
The URI of the previous page. Null if this is the first page.
pageintegerRequired
The current page number (zero-indexed).
page_sizeintegerRequired
The number of items per page.
transcriptionslist of objectsRequired
List of transcriptions.
Response
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions?Page=0&PageSize=50",
3  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions",
4  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions?Page=1&PageSize=50&PageToken=PAb3877c40-da60-4998-90ad-b792e98472tr",
5  "previous_page_uri": "string",
6  "page": 0,
7  "page_size": 50,
8  "transcriptions": [
9    {
10      "sid": "b3877c40-da60-4998-90ad-b792e98472tr",
11      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
12      "api_version": "2010-04-01",
13      "recording_sid": "b3877c40-da60-4998-90ad-b792e98472re",
14      "date_created": "Thu, 27 Sep 2018 02:00:00 +0000",
15      "date_updated": "Fri, 28 Sep 2018 03:00:00 +0000",
16      "duration": 60,
17      "price": "-0.00025",
18      "price_unit": "USD",
19      "status": "completed",
20      "transcription_text": "Hello, this is a test transcription.",
21      "type": "",
22      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions/b3877c40-da60-4998-90ad-b792e98472tr.json"
23    }
24  ]
25}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.transcriptions.each(transcriptions => console.log(transcriptions.sid));

Request: list all transcriptions from a recording

List all of the transcriptions that were generated from a single recording.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.transcriptions.each({RecordingSid: 'b3877c40-da60-4998-90ad-b792e98472re'}, transcriptions => console.log(transcriptions.sid));