Skip to main content

Uniphore Help Center Portal

Process Batch Conversation

This API initiates batch processing for the given session IDs. Up to 100 calls can be processed per batch.

Endpoint

Method: POST

URL: https://<Host name>/uzng-gateway/v1/conversation/voice/batch

curl --location 'https://<Host name>/uzng-gateway/v1/conversation/voice/batch' \
--header 'Authorization: Bearer 
--data '{
    "sessionId": [
        "68e0c3be-75d2-4db2-bf5a-5f5c68634f58"
    ]
}'
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

An array of session IDs created by the customer.

Required

Sample Request
{
  "sessionIds": [
  "Claim-100947",
  "Claim-100948",
  "a7712c78cc9f3b90",
  "a7712c78cc9f3b91"
  ]
}
Sample Response
{
  batchId: "70b57378-2418-4c9f-8f9a-25f403493339"
}
Response and Error Codes

Response Code

Condition

Message

Description

201

OK

Batch successfully submitted.

This message appears when the batch processing request is submitted.

400

Bad Request

Invalid Request Body. Check the Request Body parameters.

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.

Retry after some time.