website logo
System StatusChange LogLog In / Sign Up
Reference
Tutorials
Navigate through spaces
Reference
Tutorials
⌘K
Overview
Transcription Features
CX AI Features
Getting Started
ElevateAI Dashboards
Submit an Interaction
Declare an Audio Interaction
Declare a Transcript
Declare a Chat Interaction
Check the Status
Check the Processing Status
Retrieve Declared Parameters
Retrieve Results
Get Phrase-by-Phrase Transcript
Get Punctuated Transcript
Get CX AI
Delete Data
Python SDK
.Net SDK
Docs powered by archbee 

Retrieve Declared Parameters

// Overview

Leveraging the unique interactionIdentifier provided upon successfully declaring the audio, transcript, or chat interaction, this endpoint enables you to instantly retrieve the parameters declared when submitting the interaction for processing.

When this GET request successfully executes, an HTTP status will be returned to indicate the request was successful, along with a JSON response outlining the declared parameters for the given interactionIdentifier.

Sample API Response
|


If an error occurs when requesting to declare the interaction, a standard HTTP response code is retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in troubleshooting.



// Request Parameters & Code Example

GET
Params
Path Params
interactionIdentifier
required
String
interactionIdentifier returned upon successfully declaring the interaction
Header Parameters
X-API-Token
required
String
Valid API key associated with your account for authentication and usage tracking
Accept-Encoding
optional
String
Recommended for bandwidth optimization, will be 'gzip, deflate, br'
Curl
Node.js
JS
Python
Ruby
C#
PHP
|
RESPONSES
200
401
404
|



// Response Schema

Schema

Element

Type

Description

identifier

string

Unique interactionIdentifier associated with the request

type

string

Type of interaction, will be "audio", "transcript", or "chat"

languageTag

string

Primary language of the file, will be "en-us" (for North American English), "en" (for International English), or "es-419" (for North American Spanish)

vertical

string

Vertical associated with interaction, will be "default"

audioTranscriptionMode

string or null

If applicable, desired transcription prioritization, will be "highSpeed" or "highAccuracy"

transcript

null

Uploaded transcripts are deleted upon processing

chat

null

Uploaded chats are deleted upon processing

downloadUri

string or null

URL of audio file, if applicable

includeAiResults

string

Include AI results, will be true or false



UP NEXT
Get Phrase-by-Phrase Transcript
Docs powered by archbee 
Retrieve Declared Parameters
TABLE OF CONTENTS
// Overview
// Request Parameters & Code Example
GET
Retrieve Declared Parameters
// Response Schema
Schema