Check the Processing Status
// Overview
Leveraging the unique interactionIdentifier returned upon successfully declaring the audio, transcript, or chat interaction, this endpoint enables you to instantly retrieve detailed updates on the current status of your interaction analysis.
Pro tip: We recommend checking the status at most every 30 seconds for an audio file and every 5 seconds for a chat or transcript.
When this GET request successfully executes, an HTTP status is returned to indicate the request was successful, along with a JSON response providing details on the processing 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 in troubleshooting.
You are only able to retrieve the phrase-by-phrase transcript, punctuated transcript and/or CX AI results associated with the interaction once the status indicates the interaction has been processed.
Note: Only interactions that have been processed will result in applicable usage billing. See the ElevateAI Invoicing Policy for more information.
// Request Parameters & Code Example
// Response Schema
Schema
Element | Type | Description |
identifier | string | Unique interactionIdentifier associated with the request |
status | string | Current status of 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, 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 support@elevateai.com and include the message provided (Note: Typically, declaring the same call again will not resolve the issue). |
Note: All source data has been deleted once status indicates either processed or processingFailed.
Status Definitions
Status | Description |
declared | An audio interaction has been successfully declared with a downloadUri and the file is waiting to be inserted into the download queue OR a transcript or chat interaction has been successfully declared and is waiting to be inserted in the processing queue |
filePendingUpload | An audio interaction has been successfully declared without a downloadUri, and is waiting for the associated file to be uploaded directly to the API |
fileUploading | An audio 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 audio 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 audio file to the ElevateAI system - reference additional information returned in the errorMessage element re-upload the file for processing |
filePendingDownload | An audio interaction has been successfully declared with a downloadUri, and the file is in queue to be downloaded |
fileDownloading | An audio interaction has been successfully declared with a downloadUri and the file is in the process of being download from the URL provided |
fileDownloaded | An audio 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 audio 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 | The audio, transcript, or chat interaction is in queue for processing |
processing | The audio, transcript, or chat interaction is actively being processed by the Service |
processed | The audio, transcript, or chat interaction has been successfully processed and you are now able to retrieve the phrase-by-phrase transcript, punctuated transcript and/or CX AI results associated with the interaction |
processingFailed | There was an error encountered while processing the audio, transcript or chat interaction - reference additional information returned in the errorMessage element and contact us at support@elevateai.com with any additional questions (Note: Typically, declaring the same call again will not resolve the issue). |