Skip to main content

Uniphore Customer Portal

Fetch Summaries

The Fetch Summaries API returns the summary generated for the given contact.

Endpoint

Method: GET

URL: summaries/{contactId}

Header Parameter

Authorization - Bearer <Token>

Path Parameter

Parameter name

Mandatory/

Optional

Type

Description

contactId

Mandatory

String

Id of the contact whose summary needs to be fetched

Example Request
curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET http://host:port/summaries/{contactId}
Example Response
{
  "sessionId": "c4nq0x0o",
  "startTime": 1595385702431,
  "lang": "en-us",
  "intent": "Hotel/Booking/Inquery/Accepted",
  "metadata": {
    "agentId": "Agent",
    "customerId": "customer",
    "contactType": "voice",
    "journeyId": "c4nq0x0o",
    "tenantId": "1",
    "organizationId": "2",
    "categoryId": "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”}