Skip to main content

Uniphore Help Center Portal

Fetch Processing Status

This API fetches the processing status of a conversation based on the session ID. When conversations are reprocessed, the API retrieves the status of the latest processing.

Endpoint

Method: GET

URL: https://<<Host name>>/uzng-gateway/v2/processing/status

curl --location 'https://<<Host name>>/uzng-gateway/v2/processing/status' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cC6IkxYejBQCJhdWQiOiJhcGkudW5pcGhvcmUuY29tIiwiaWF0IjoxNzIxMjEyMDExLCJleHAiOjE3MjEyOTg0MTEsInNjb3BlIjoicmVhZDp0ZW5hbnRzIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwiYXpwIjoidEphdlBSVzJhaU1xUFh2WW41eFUzdW40aHhCOFVOVVIiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOnRlbmFudHMiXX0.HyixVzRNAkG7TWMr2BUSwdDMt-yNBLn4D1JmidL7lisjD6_8qZQ1VgPrTSY_1t3qyoWQ8FroyQvervGcyfsHXYP56d-xhLwoRut9KAsFGoKlPoCL4NQ_749749dgwnPy4wDm1w6HTV_xJk5TCfr65oGIithOPSJGfgs57wegRb8FrT5iDTj6f1c8mnXuWEUfjqnyhal8U_SHH6UAop0nyEsP1KEcUKA2JbkarhRZtROtXKD8h60QfUd9ShJpZrIJEygEX1miVJfk5WyLlBv6w37B03qmoYFEom5bGBfRGcvbsqAwcnrEwpi1pi6CEsDhg4ojQuQEZJOkkuYD1HMyFA' \
     --data '{
              "sessionIds": [
              "pov896756-1244-4424-87a9-628f2d37cc40123",
              "b0cd7ec9-9186-443b-8d8b-1ca1767d8895",
              "73c4f7f0-0bdf-42e8-9864-6d7941dae4a7",
               "0dc88702-ceb4-4bd3-bee0-e9a3b573b28f",
               "9d0b172a-a214-4c89-9db3-9c112fa53e8b",
               "12345" 
                    ]
              }'
Header Parameter
Header Parameter
Authorization - Bearer <Token>

Note

To obtain an authorization token, click here.

Request Parameter

Parameter Name

Data Type

Description

Required/ Optional

sessionIds

String

Unique ID of the conversation provided by the organization/customer for which the status needs to be retrieved.

Pass the IDs as an array. Up to 10 IDs can be included in a request.

Required

Sample Request
{
  "sessionIds": [
  "Claim-100947",
  "Claim-100948",
  "a7712c78cc9f3b90",
  "a7712c78cc9f3b91"
  ]
}
Sample Response
{
    "code": 200,
    "message": "SUCCESS",
    "data": {
        "processingStatuses": [
            {
                "sessionId": "96d2651f-7635-47ad-9b64-100e1265a1e0",
                "overallStatus": "COMPLETED",
                "stagesStatus": [
                    {
                        "stage": "BATCH_ASR_PROCESSOR",
                        "status": "COMPLETED",
                        "remarks": "TEXT_NORMALIZATION_FAILURE"
                    },
                    {
                        "stage": "DISPOSITION_HIERARCHY",
                        "status": "COMPLETED"
                    },
                    {
                        "stage": "FACTS_RESOLVER",
                        "status": "COMPLETED"
                    },
                    {
                        "stage": "SCORE",
                        "status": "COMPLETED"
                    },
                    {
                        "stage": "TONAL",
                        "status": "COMPLETED"
                    },
                    {
                        "stage": "VAD",
                        "status": "COMPLETED"
                    }
                ]
            }
        ]
    }
}
Response Parameter

Parameter Name

Description

processingStatuses

This contains the session ID, overall status, sub-stages and their statuses, and any error messages from the sub-stages and the entire process.

sessionId

Unique ID of the conversation provided by the organization/customer for which the conversation status is retrieved.

overallStatus

Shows the status of the conversation for the provided session IDs. The available statuses are:

Created: When a conversation is created.

Initiated: When a batch process is initiated.

Completed: All processing stages are completed.

Failed: Processing failed at any stage.

In Progress: Processing is ongoing.

message

Shows the corresponding message for the overall status.

stagesStatus

Details of the sub-stages and their statuses.

stage

Name of the sub-stage. Conversation processing goes through the following sub-stages:

  • BATCH_ASR_PROCESSOR

  • DISPOSITION_HIERARCHY

  • VAD

  • FACT RESOLVER

  • TONAL

  • SCORE

status

Shows the Status for each sub-stage, which can be either Completed or Failed.

remarks

Shows the ITN failure message in the BATCH_ASR_PROCESSOR stage.

errorMsg

An error message is displayed when the processing fails at a sub-stage.

error

An error message is displayed when one or more conversations fail.

Response and Error Codes

Response Code

Condition

Message

Description

201

Created

Conversation created.

This message appears when the audio file is successfully uploaded.

400

Bad Request

sessionId object is required in the request.

Ensure the Request Body parameters are correct and in the right format.

401

UnAuthorized

Invalid token or invalid signature received for JSON Web Token validation.

Ensure the correct token is input.

429

Too Many Requests

The user has sent too many requests in a given amount of time (“rate limiting”).

Check the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.

Retry after some time.

500

Internal Server Error

Internal Server Error.

The server encountered an unexpected error that prevented it from fulfilling the request. Retry after some time.

In this section: