Fetch ACW Summary by ID
summaries API returns the ACW summary generated for the given conversation ID.
Endpoint
Method: GET
URL: https://api.<region>.cloud.uniphore.com/data-collector/summaries/{conversationId}?tenantId=<tenantId>&environment=<environment-name>
Request
curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET https://api.<region>.cloud.uniphore.com/data-collector/summaries/{conversationId}?tenantId=<tenantId>&environment=<environment><slug-name> denotes the tenant name.
Header Parameter
Authorization - Bearer <Token>
Path Parameter
Parameter ame | Mandatory / Optional | Type | Description |
|---|---|---|---|
| Mandatory | string | Id of the conversation whose ACW summary needs to be fetched |
Query Parameters
Parameter Name | Mandatory / Optional | Data Type | Description |
|---|---|---|---|
| Mandatory | String | The unique identifier for your account. |
| Optional | String | Operating environment type. Three out-of-the-box environments are provided for each account:
|
Example Response
{
"conversationId": "c4nq0x0o",
"startTime": 1595385702431,
"lang": "en-us",
"intent": "Hotel/Booking/Inquery/Accepted",
"metadata": {
"agentId": "Agent",
"customerId": "customer",
"conversationType": "voice",
"journeyId": "c4nq0x0o",
"tenantId": "1",
"organizationId": "2",
"businessProcessId": "76"
},
"isReviewed": true,
"text": "{\"format\":\"bulletPoint\",\"bullet\":[\"Customer name is Sarah\"],\"paragraph\": \"null\"}",
"manualEdits": {
"userId": "1",
"ts": 1598356053000,
"text": "{\"format\":\"bulletPoint\",\"bullet\":[\"Customer name is Sarah\"],\"paragraph\": \"null\"}"
}
}
Response and Error Codes
Code | Response |
|---|---|
200 | OK |
401 | {“reason”:”Authentication failed”} |
404 | Record Not Found |
500 | {“error”: “Internal server error”} |