Check Processing Status

// // overview leveraging the unique interactionidentifier returned upon successfully declaring the declare an audio interaction , declare a chat interaction , or declare a transcript interaction enables you to instantly retrieve detailed updates on the check processing 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 get request successfully executes, an http status is returned to indicate the request was successful, along with a json response providing details around the check 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 with troubleshooting sample api response { "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 get phrase by phrase transcripts , the punctuated transcript , or the get cx ai insights 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 invoicing policy for more information // // request parameters & code example { "tab" "examples", "url" "https //api elevateai com/v1/interactions/{interactionidentifier}/status", "name" "retrieve processing status", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "interactionidentifier", "type" "string", "description" "interactionidentifier returned upon successfully declaring the interaction" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api token", "type" "string", "description" "valid api key associated with your account for authentication and usage tracking" }, { "kind" "optional", "name" "accept encoding", "type" "string", "description" "recommended for bandwidth optimization, will be 'gzip, deflate, br'" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "z4ojaichyk2u3vesn0hc ", "code" "{\n \\"identifier\\" \\"string\\",\n \\"status\\" \\"string\\",\n \\"declared\\" \\"string\\",\n \\"uploaded\\" \\"string\\",\n \\"downloaded\\" \\"string\\",\n \\"processed\\" \\"string\\",\n \\"errormessage\\" \\"string\\"\n}", "language" "200", "customlabel" "" }, { "id" "6qttbzwcfezjoynvekz7j", "code" "{\r\n \\"errormessage (string)\\"\r\n}", "language" "401", "customlabel" "" }, { "id" "ked3nzp5ycf niv5wbk6l", "code" "{\r\n \\"errormessage (string)\\"\r\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "z4ojaichyk2u3vesn0hc " }, "examples" { "languages" \[ { "id" " f8vjrve5qr1ehri7egt1", "code" "curl location g request get 'https //api elevateai com/v1/interactions/{interactionidentifier}/status' \\\\\r\n header 'accept encoding gzip, deflate, br' \\\\\r\n header 'x api token {your api token}'", "language" "curl", "customlabel" "" }, { "id" "deapx aaetiuwvokmpy11", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api elevateai com/v1/interactions/{interactionidentifier}/status',\n 'headers' {\n 'accept encoding' 'gzip, deflate, br',\n 'x api token' '{your api token}'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "eiktqefamywmexzs4shla", "code" "var myheaders = new headers();\nmyheaders append(\\"accept encoding\\", \\"gzip, deflate, br\\");\nmyheaders append(\\"x api token\\", \\"{your api token}\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "p xg2nohxjy2ndoio acd", "code" "import http client\n\nconn = http client httpsconnection(\\"api elevateai com\\")\npayload = ''\nheaders = {\n 'accept encoding' 'gzip, deflate, br',\n 'x api token' '{your api token}'\n}\nconn request(\\"get\\", \\"/v1/interactions/{interactionidentifier}/status\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "language" "python", "customlabel" "" }, { "id" "idp5imx79uq9r qrj2mq", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept encoding\\"] = \\"gzip, deflate, br\\"\nrequest\[\\"x api token\\"] = \\"{your api token}\\"\n\nresponse = https request(request)\nputs response read body", "language" "ruby", "customlabel" "" }, { "id" "2y5xmpju8g4wa6f7 5bfx", "code" "var client = new restclient(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\");\r\nclient timeout = 1;\r\nvar request = new restrequest(method get);\r\nrequest addheader(\\"accept encoding\\", \\"gzip, deflate, br\\");\r\nrequest addheader(\\"x api token\\", \\"{your api token}\\");\r\nirestresponse response = client execute(request);\r\nconsole writeline(response content);", "language" "csharp", "customlabel" "" }, { "id" "9yenfgm1ow7amvejkarpz", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api elevateai com/v1/interactions/%7binteractionidentifier%7d/status',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'accept encoding gzip, deflate, br',\r\n 'x api token {your api token}'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;", "language" "php", "customlabel" "" } ], "selectedlanguageid" "p xg2nohxjy2ndoio acd" }, "description" "", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } // // response schema schema element type description identifier string unique interactionidentifier associated with the request status string check processing 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 support\@elevateai com 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 check processing status indicates either processed or processingfailed status definitions status description declared an declare an audio interaction interaction has been successfully declared with a downloaduri and the file is waiting to be inserted into the download queue or a declare a chat interaction or declare a transcript interaction has been successfully declared and is waiting to be inserted in the processing queue filependingupload an declare an audio interaction interaction has been successfully declared without a downloaduri , and is waiting for the associated file to be upload an audio file fileuploading an declare an audio interaction 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 declare an audio interaction 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 declare an audio interaction file to the elevateai system – reference additional information returned in the errormessage element re upload the file for processing filependingdownload an declare an audio interaction interaction has been successfully declared with a downloaduri and the file is in queue to be downloaded filedownloading an declare an audio interaction interaction has been successfully declared with a downloaduri and the file is in the process of being download from the url provided filedownloaded an declare an audio interaction 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 declare an audio interaction 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 declare an audio interaction , declare a chat interaction or declare a transcript interaction is in queue for processing processing an declare an audio interaction , declare a chat interaction or declare a transcript interaction is actively being processed by the service processed an declare an audio interaction , declare a chat interaction or declare a transcript interaction has been successfully processed and you are now able to retrieve the get phrase by phrase transcripts , punctuated transcript , and/or get cx ai insights associated with the interaction processingfailed there was an error encountered while processing the declare an audio interaction , declare a chat interaction or declare a transcript 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 need more help? contact the elevateai support team