Check Processing Status

7 min

// Overview

Leveraging the unique interactionIdentifier returned upon successfully declaring the audioaudio, chatchat, or transcriptiontranscript interaction enables you to instantly retrieve detailed updates on the current statuscurrent status of your interaction analysis.

PRO TIP: For best results, we recommend checking the processing status – at most – every thirty (30) seconds for an audio file and every five (5) seconds for a chat or transcription file.

When this GET request successfully executes, an HTTP status is returned to indicate the request was successful, along with a JSON response providing details around the processing statusprocessing status of your interaction.

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

{
  "identifier": "bd5c92f3-c228-44a6-91bf-b52672569878",
  "status": "processed",
  "declared": "2022-06-17T21:23:06.137087Z",
  "uploaded": null,
  "downloaded": "2022-06-17T21:24:53.639208Z",
  "processed": "2022-06-17T21:29:05.071Z",
  "errorMessage": null
}

You are only able to retrieve the phrase-by-phrase transcriptphrase-by-phrase transcript, the punctuated transcriptpunctuated transcript, or the CX AI resultsCX AI results associated with the interaction once the status indicates the interaction has been processed.

NOTE: Only processed interactions will generate applicable usage billing.

Please refer to the ElevateAI Invoicing PolicyElevateAI Invoicing Policy for more information.

// Request Parameters & Code Example

Retrieve Processing Status

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/status

import http.client

conn = http.client.HTTPSConnection("api.elevateai.com")
payload = ''
headers = {
  'Accept-Encoding': 'gzip, deflate, br',
  'X-API-Token': '{Your API Token}'
}
conn.request("GET", "/v1/interactions/{InteractionIdentifier}/status", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// Response Schema

Schema

Element	Type	Description
identifier	string	Unique interactionIdentifier associated with the request
status	string	Current statusCurrent status of the interaction
declared	string	Date/Time – formatted according to ISO 8601 (UTC) – that the interaction was successfully declared
uploaded	string or null	If applicable – Date/Time formatted according to ISO 8601 (UTC) – that an interaction provided directly to the API was successfully uploaded to ElevateAI and ready to be entered into the processing queue
downloaded	string or null	If applicable – Date/Time formatted according to ISO 8601 (UTC) – that an interaction provided via downloadUri was successfully downloaded and ready to be entered into the processing queue
processed	string or null	If applicable – Date/Time formatted according to ISO 8601 (UTC) – that processing was complete and results available to be retrieved
errorMessage	string or null	If applicable, a human-readable description of errors encountered when uploading, downloading, or processing the interaction that must be addressed prior to re-declaring an interaction. If you need additional support, please contact us at [email protected] and include the error message you've received. NOTE: Typically, declaring the same call again will not resolve the issue.

NOTE: All source data has been deleted once processing statusstatus indicates either processed or processingFailed

Status Definitions

Status	Description
declared	An audioaudio interaction has been successfully declared with a downloadUri and the file is waiting to be inserted into the download queue OR a chatchat or transcriptiontranscript interaction has been successfully declared and is waiting to be inserted in the processing queue
filePendingUpload	An audioaudio interaction has been successfully declared without a downloadUri, and is waiting for the associated file to be uploaded directly to the APIuploaded directly to the API
fileUploading	An audioaudio file associated with this interaction has been provided directly to the API and is in the process of being uploaded by the service
fileUploaded	An audioaudio file associated with this interaction has been successfully uploaded and is waiting to be inserted into the processing queue
fileUploadFailed	There was an error encountered when uploading an audioaudio file to the ElevateAI system – reference additional information returned in the errorMessage element re-upload the file for processing
filePendingDownload	An audioaudio interaction has been successfully declared with a downloadUriand the file is in queue to be downloaded
fileDownloading	An audioaudio interaction has been successfully declared with a downloadUri and the file is in the process of being download from the URL provided
fileDownloaded	An audioaudio interaction has been successfully downloaded from the provided downloadUri URL, and is waiting to be inserted into the processing queue
fileDownloadFailed	There was an error encountered when downloading an audioaudio file to the ElevateAI system from the downloadUri URL – reference additional information returned in the errorMessage element and confirm you have provided a valid file format prior to re-declaring
pendingProcessing	An audioaudio , chatchat or transcripttranscript interaction is in queue for processing
processing	An audioaudio , chatchat or transcripttranscript interaction is actively being processed by the Service
processed	An audioaudio , chatchat or transcripttranscript interaction has been successfully processed and you are now able to retrieve the phrase-by-phrase transcriptphrase-by-phrase transcript, punctuated transcriptpunctuated transcript, and/or CX AI resultsCX AI results associated with the interaction
processingFailed	There was an error encountered while processing the audioaudio , chatchat or transcripttranscript interaction - reference additional information returned in the errorMessage element and contact us at [email protected] with any additional questions NOTE: Typically, declaring the same call again will not resolve the issue.

Need more help? Contact the ElevateAI Support team.