Receive Legacy ACW Summary for a Call ID/Session ID
This API allows you to retrieve ACW configured summary details for any given Call ID/Session ID.
Endpoint
Method: GET
URL: https://api.us.cloud.uniphore.com/api/v1/summaries/{sessionId}?environment=prod
Request
curl --request GET \ --url https://api.us.cloud.uniphore.com/api/v1/summaries/{sessionId}?environment=prod \ --header 'authorization: Bearer ACCESS_TOKEN' \ --header 'content-type: application/json'To generate access token, click here.
Header Parameters
Parameter Name | Description | Type | Example |
|---|---|---|---|
Authorization | Access token should be sent with all client requests. The access token with all client request helps the platform services to get the user information from auth0. You should pass user authorization token generated from auth0 for an Agent user. | String | Bearer <Token> |
Content-Type | Indicates that the request body format is JSON. | String | application/json |
Path Parameter
Parameter Name | Mandatory / Optional | Type | Description |
|---|---|---|---|
sessionId | Mandatory | String | Session ID/Call ID for which the summary is requested. |
Query Parameter
Parameter Name | Description | Data Type | Required / Optional |
|---|---|---|---|
| Operating environment type. Three out-of-the-box environments are provided for each account:
| String | Optional |
Query Parameter
Parameter Name | Description | Data Type | Required / Optional |
|---|---|---|---|
environment | Operating environment type. Set the value to 'prod'. | String | Required |
Example Response
Given below is the sample response of Summary in bullet format:
{
"requestId": "6481a763e6082c436e7ea143",
"sessionId": "1686218381048fpuzerb3v",
"lang": "en-us",
"startTime": 1686218618427,
"intent": "",
"summaryResponse": {
"format": "bulletPoint",
"templateId": 725,
"bullet": [
"Name"
],
"paragraph": null
},
"text": "{\"format\":\"bulletPoint\",\"templateId\":725,\"bullet\":[\"Name\"],\"paragraph\":null}",
"templateId": "725",
"isReviewed": false,
"metadata": {
"agentId": "16",
"customerId": "8090909099",
"agentClientId": "eran@yopmail.com",
"customerClientId": "8090909099",
"contactType": "voice",
"journeyId": "1686218381048fpuzerb3v",
"tenantId": "6e35e133-36f8-451b-b70e-c581f4c76c22",
"environment": "dev",
"organizationId": "18610217120267438991680072742993",
"categoryId": "68984041484339574711680072753578",
"type": "live",
"contactDuration": 0,
"requestType": "onDemand",
"sequenceNumber": 0,
"language": "en-us",
"startOffset": 0,
"startTime": 0,
"transcriptionStartTime": 0,
"transcriptionEndTime": 0,
"requestTime": 0,
"lastChunk": false,
"live": false,
"isDiarized": false
}
} Response and Error Codes
Code | Description |
|---|---|
200 | Ok - The request has succeeded. |
401 | Authorization failed. |
404 | Summary not found. |
500 | Internal server error. |