Skip to main content

Uniphore Help Center Portal

Fetch Batch Conversation Processing Status

This API returns the overall batch status for a given batch ID and the processing status of each conversation available in the respective batch. With this API, users can track the cause of failure to debug and reprocess.

Endpoint

Method: GET

URL: https://<<hostname>>/uzng-gateway/v2/batch/processing/status/<batch-id>

curl --location 'https://<<hostname>>/uzng-gateway/v2/batch/processing/status/c8d30-47bf-9e0c-32374ca' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Bearer Token>'
Header Parameter
Authorization - Bearer <Token>

Note

To obtain an authorization token, click here.

Path Parameter

Parameter Name

Data Type

Description

Required/ Optional

batch-id

String

Unique ID generated while processing a batch conversation.

Enter the batch ID for which the status needs to be retrieved.

To get the batch ID, refer to Process Batch Conversation API

Required

Sample Response
{
    "code": 200,
    "message": "SUCCESS",
    "data": {
        "batchProcessingId": "c8d30-47bf-9e0c-32374ca",
        "overallBatchStatus": "COMPLETED",
        "processingType": "PROCESS",
        "tenantId": "31a0adeb-a829-4d63-a871-3519c445f124",
        "conversations": [
            {
                "conversationId": "182c814b-1b25-4a84-bf65-d4790372a5d7",
                "externalConversationId": "c935a1aa-b937-490f-82a6-9f373c5310c4",
                "overallProcessingStatus": "COMPLETED"
            },
            {
                "conversationId": "ccc88fbd-3195-49a6-b0fb-6635cbe830cd",
                "externalConversationId": "5b721a85-5823-4759-be20-953d64830417",
                "overallProcessingStatus": "FAILED",
                "failedStages": [
                    {
                        "stage": "FACTS_RESOLVER",
                        "errorMessage": "java.lang.IndexOutOfBoundsException: Index -1 out of bounds for length 25"
                    },
                    {
                        "stage": "VAD",
                        "errorMessage": "UNAVAILABLE: failed to connect to all addresses"
                    }
                ]
            },
            {
                "conversationId": "ccc88fbd-3195-49a6-b0fb-6635cbe830cd",
                "externalConversationId": "5b321a85-4759-ae20-953d65900417",
                "overallProcessingStatus": "FAILED",
                "failedStages": [
                    {
                        "stage": "BATCH_ASR_PROCESSOR",
                        "errorMessage": "FAILED (S3_DATA_VALIDATION)"
                    }
                ]
            }
        ]
    }
}
Response Parameter

Parameter Name

Description

batchProcessingId

Id of the processed batch for which the status was retrieved.

overallBatchStatus

Overall status of the given batch ID. The status can be:

  • INITIATED: The batch processing has been initiated.

  • IN_PROGRESS: The batch processing is ongoing.

  • COMPLETED: This status is shown when all conversations in a batch are either completed or failed.

processingType

Type of the batch process, which implies whether the batch is processed only once or more.

  • PROCESS: shows the status when the given batch has been processed only once.

  • REPROCESS: shows the status when the given batch has been processed more than once.

tenantId

ID of the tenant to which the batch belongs.

conversationId

Unique ID of the conversation generated by Conversation Insights Agent.

externalConversationId

Unique ID of the conversation provided by the Organization/Customer.

overallProcessingStatus

Shows the status of each conversation in the processed batch. The available statuses are:

CREATED: A conversation is created/uploaded.

INITIATED: The batch process is initiated.

IN PROGRESS: The batch processing is ongoing.

COMPLETED: All batch processing stages are successfully completed.

FAILED: The batch processing has failed at one or more stages. Returns the stages where batch processing failed and the reason for each failure.

failedStages:Stage

Shows the stage at which the batch conversation processing failed.

Example: FACTS_RESOLVER, VAD, TONAL, SCORE, BATCH_ASR_PROCESSOR, BATCH_CHAT_CONNECTOR

Note

BATCH_CHAT_CONNECTOR stage is applicable for Chat conversations only.

failedStages:errorManage

Shows the error message with the failure reason.

Response and Error Codes

Response Code

Condition

Description

200

OK

Conversations in the given Batch ID are processed successfully.

401

UnAuthorized

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

403

API disabled for tenant

Check whether the Correct tenant ID is provided.

404

Not Found

No Conversation Details found for the given Batch Processing ID.

500

Internal Server Error

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

In this section: