Call Processing Summary API

The call processing summary API returns tenant-specific aggregated call processing data based on the given Start and End dates. Up to three days of data can be retrieved.

Endpoint

Method: GET

URL: https://<<hostname>>/uzng-gateway/v1/get-processing-summary

curl --location 'https://api.us.cloud.uniphorestaging.com/uzng-gateway/v1/get-processing-summary' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiQWNjb3VudCBBZG1pbmlzdHJhdG9yIiwiYWRtaW4iLCJ1X2FkbWluaXN0cmF0b3IiLCJpbnRlcmFjdF9hY2NvdW50X2FkbWluIl0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9lbWFpbF9pZCI6ImxvYWQyX2FjY291bnRfYWRtaW5AdW5pLmNvbSIsInByZWZlcnJlZF91c2VybmFtZSI6ImxvYWQyX2FjY291bnRfYWRtaW5AdW5pLmNvbSIsImZhbWlseV9uYW1lIjoiQWJpIFRob21hcyIsImVtYWlsIjoibG9hZDJfYWNjb3VudF9hZG1pbkB1bmkuY29tIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2F1dGgwX25hbWUiOiJBYmkgVGhvbWFzIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfaWQiOiJhdXRoMHw2NjY2YTA3MTJlMDFlMTM4YjczNmYzYjMiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXBkYXRlZF9hdCI6IjIwMjUtMDUtMTRUMTI6MzA6NTguMzAwWiIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91c2VyX21ldGFkYXRhIjp7fSwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3RlbmFudCI6IjQwOGNmZjU3LTZiYjEtNDlmYi04NWJiLTEyNmRiZjM2MTNhYyIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS90ZW5hbnRfbmFtZSI6Im5nLWxvYWQtcWEyIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2NsdXN0ZXIiOiJ1cyIsImlzcyI6Imh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw2NjY2YTA3MTJlMDFlMTM4YjczNmYzYjMiLCJhdWQiOlsiYXBpLnVuaXBob3JlLmNvbSIsImh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3NDcyMjU4NjAsImV4cCI6MTc0NzgzMDY2MCwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCBvZmZsaW5lX2FjY2VzcyIsIm9yZ19pZCI6Im9yZ193QU93MHJ1cVpKRDhESjliIiwiYXpwIjoidnB1bURCMTFJRm45WENnT1JCc0JSdElUd1NxczZDOFYiLCJwZXJtaXNzaW9ucyI6WyJhdWRpdC1sb2c6dmlldzp1Y2FwdHVyZSIsImNvbmZpZ3VyYXRpb246c3lzdGVtOnVjYXB0dXJlIiwiY3JlYXRlOnRlbmFudDpsb29rZXIiLCJkZWxldGU6dXNlcnMiLCJkZXNpZ246Ymk6bG9va2VyIiwicG9saWN5OmFjdGl2YXRlOnVjYXB0dXJlIiwicG9saWN5OmNyZWF0ZTp1Y2FwdHVyZSIsInBvbGljeTpkZWFjdGl2YXRlOnVjYXB0dXJlIiwicmVhZDpleHBlcmllbmNlcyIsInJlYWQ6b3JnSGllcmFyY2h5IiwicmVhZDp1YXNzaXN0IiwicmVjb3JkaW5nOmxvY2s6dWNhcHR1cmUgIiwicmVjb3JkaW5nOm9uLWRlbWFuZDp1Y2FwdHVyZSIsInJlY29yZGluZzp2aWV3LWxpdmU6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy1tZXRhZGF0YTp1Y2FwdHVyZSIsInJlY29yZGluZzp2aWV3LXRyYW5zY3JpcHQ6dWNhcHR1cmUiLCJzZWFyY2g6dmlldzp1Y2FwdHVyZSIsInZpZXc6Ymk6bG9va2VyIiwidmlldzpvcmctaGllcmFyY2h5Iiwid3JpdGU6ZXhwZXJpZW5jZXMiLCJ3cml0ZTp1YXNzaXN0Il19.xDY61gGoRVzEBBvqM-gJ8Kqw27QEUmoU0_gX2G2YhJgR_mepzzP7SrWlRw4xW1aXDP8DO1VN-M_1MuPMdS2UACvlNX37UzCp1Rpm-lyX_1fD5Wz7YTX1HsKFLfWabD_lFqq2iy_mPM4ja6U0yDCMPU8IEAJGIJmNGf0AIjbBEyDT7_awmsGozNgS7jUL8JATpz9SUEzZqMat_lDIQC5-M6BzrDgoePOacC1-EjNHAOnod2HAVCLz6SUO3ZFd2b36jtHaAK3vAFiwszAyREAL29gZ3TgkMf88dFumBrjzJ-0Y_57W-qu9t--5hLJgnP94f_ULNZ7rUnye3jkg_Y6rUQ' \
--header 'Content-Type: application/json' \
--data '{   
    "processingType": "PROCESS",
    "startTime": "2025-04-22 18:30:00",
    "endTime": "2025-04-25 18:29:59"
}'

Header Parameter

Authorization - Bearer <Token>

Note

To obtain an authorization token, click here.

Sample Request

{   
    "processingType": "PROCESS",
    "startTime": "2025-04-22 18:30:00",
    "endTime": "2025-04-25 18:29:59"
}'

Request Parameter

Parameter Name	Data type	Description	Required/ Optional
processingType	Enum	Enter either PROCESS or RE_PROCESS based on the processing type.	Required
startTime	Date	Fetch call processing summary starting from this date. Format: yyyy-MM-dd HH:mm:ss in UTC	Required
endTime	Date	Fetch call processing summary ending till this date. Format: yyyy-MM-dd HH:mm:ss in UTC	Required

Caution

The difference between the startTime and endTime should be less than 3 days.

Sample Response

{
    "inputFilters": {
	"startTime": "2025-04-16 12:00:00",
	"endTime": "2025-04-17 23:59:59"
	},
    "summary": [
    {
      "date": "2025-04-22",
      "batch_count": "2",
      "total_conversations": 100,
      "batches": [
        {
          "batch_id": "batch-1",
          "count": 40,
          "status": {
            "COMPLETED": 30,
            "INITIATED": 2,
            "IN_PROGRESS": 8,
            "FAILED": 0
          }
        },
        {
          "batch_id": "batch-2",
          "count": 60,
          "status": {
            "COMPLETED": 54,
            "INITIATED": 2,
            "IN_PROGRESS": 4,
            "FAILED": 0
          }
        }
      ]
    },
    {
      "date": "2025-04-2",
      "batch_count": "2",
      "total_conversations": 100,
      "batches": [
        {
          "batch_id": "batch-11",
          "count": 55,
          "status": {
            "COMPLETED": 50,
            "INITIATED": 2,
            "IN_PROGRESS": 1,
            "FAILED": 2
          }
        },
        {
          "batch_id": "batch-12",
          "count": 45,
          "status": {
            "COMPLETED": 41,
            "INITIATED": 1,
            "IN_PROGRESS": 2,
            "FAILED": 1
          }
        }
      ]
    }
  ]
}

Response Parameter

Parameter Name	Description
startTime	The start time given in the request body.
endTime	The end time given in the request body.
date	The date when the batch was processed.
batch_count	The number of batches processed on that date.
total_conversations	The total number of conversations sent for processing across all batches.
batch_id	The ID of the batch.
count	The number of conversations sent for processing in that batch.
status: COMPLETED	The number of conversations for which the processing has been completed.
status: INITIATED	The number of conversations for which the processing has started.
status: IN_PROGRESS	The number of conversations for which the processing is ongoing.
status: FAILED	The number of conversations for which the processing has failed.

Response and Error Codes

Code	Condition	Message	Description
200	OK	Success	The API was executed successfully.
400	Bad Request	Invalid date range: Date range shouldn't exceed 3 days. Invalid date range: endTime should be greater than startTime & shouldn't be in future.	Ensure the correct date range is provided.
500	Internal Server Error	Couldn't fetch summary, try again later.	Please try again later.

In this section:

Uniphore Help Center Portal