Compatibility REST APIRecording Transcriptions

List all Transcriptions

View as Markdown

List all transcriptions. Results are returned as a paginated list ordered by creation date (newest first).

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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

The request has succeeded.
uristring
The URI of the current page.
first_page_uristring
The URI of the first page.
next_page_uristring or null
The URI of the next page. Null if there are no more pages.
previous_page_uristring or null
The URI of the previous page. Null if this is the first page.
pageinteger

The current page number (zero-indexed).

page_sizeinteger
The number of items per page.
transcriptionslist of objects
List of transcriptions.

Errors