Mapping a Summary Template and Version to a Conversation Using a Summary Builder API
This API allows a Flow Designer or Developer to change the Summary Template while a call is still active, based on logic defined in the Flow at design time. It enables the system to generate contextualized, AI-powered Summaries at the end of the call using the specified Summary Template.
Note
If an agent manually selects an intent during an ongoing call, any subsequent API calls will not override the Summary Template associated with the manually selected Intent, as the Agent’s selection always takes precedence.
Endpoint
Method: POST
URL: https://api.<region>.cloud.uniphore.com/summary/v1/conversations/{convId}/summary-template?environment=dev
<region> - Mention the name of the region, such as the United States, India, the United Kingdom, the Middle East, and so on, where Real-Time Guidance Agent is installed on the public cloud.
cURL Command using Bearer token
curl --location --request PATCH 'https://api.us.cloud.uniphorestaging.com/summary/v1/conversations/67767f93-a9c8-4b4b-a85f-0f793da2f763/summary-template?environment=dev' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsidV9hZG1pbmlzdHJhdG9yIiwiaW50ZXJhY3RfYWNjb3VudF9hZG1pbiIsImFkbWluIiwiQWNjb3VudCBBZG1pbmlzdHJhdG9yIl0sImh0dHBzOi8vYXBpLnbWFpbF9pZCI6InFhYWRtaW5rYUBxYXRlc3RlbnYxLmNvbSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9hdXRoMF9uYW1lIjoicWFhZG1pbmthQHFhdGVzdGVudjEuY29tIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfaWQiOiJhdXRoMHw2NjczZGZjMjBhYTAxZjQ0NGM1MjY2OWIiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXBkYXRlZF9hdCI6IjIwMjUtMDUtMDZUMTU6Mzg6MTEuNjQ5WiIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91c2VyX21ldGFkYXRhIjp7ImNsaWVudF9pZCI6InFhYWRtaW5rYUBxYXRlc3RlbnYxLmNvbSJ9LCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiM2UzNzYzMWMtNzhhYy00MTM3LTg0MTUtNzJkY2Q5MGIxOWZkIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3RlbmFudF9uYW1lIjoicWF0ZXN0ZW52MSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9jbHVzdGVyIjoidXMiLCJpc3MiOiJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NjY3M2RmYzIwYWEwMWY0NDRjNTI2NjliIiwiYXVkIjpbImFwaS51bmlwaG9yZS5jb20iLCJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNzQ2NTQ1ODk2LCJleHAiOjE3NDcxNTA2OTYsInNjb3BlIjoib3BlbmlkIiwib3JnX2lkIjoib3JnX1A2U0N1Rkh5bEVDUDU1NjAiLCJhenAiOiJEamNweG9JZGREZnVmSEZkUU41Qm40aVg2M1p4QWt1ZiIsInBlcm1pc3Npb25zIjpbImF1ZGl0LWxvZzp2aWV3OnVjYXB0dXJlIiwiY29uZmlndXJhdGlvbjpzeXN0ZW06dWNhcHR1cmUiLCJjcmVhdGU6dGVuYW50Omxvb2tlciIsImRlbGV0ZTp1c2VycyIsImRlc2lnbjpiaTpsb29rZXIiLCJwb2xpY3k6YWN0aXZhdGU6dWNhcHR1cmUiLCJwb2xpY3k6Y3JlYXRlOnVjYXB0dXJlIiwicG9saWN5OmRlYWN0aXZhdGU6dWNhcHR1cmUiLCJyZWFkOmV4cGVyaWVuY2VzIiwicmVhZDpvcmdIaWVyYXJjaHkiLCJyZWFkOnVhc3Npc3QiLCJyZWNvcmRpbmc6bG9jazp1Y2FwdHVyZSAiLCJyZWNvcmRpbmc6b24tZGVtYW5kOnVjYXB0dXJlIiwicmVjb3JkaW5nOnZpZXctbGl2ZTp1Y2FwdHVyZSIsInJlY29yZGluZzp2aWV3LW1ldGFkYXRhOnVjYXB0dXJlIiwicmVjb3JkaW5nOnZpZXctdHJhbnNjcmlwdDp1Y2FwdHVyZSIsInNlYXJjaDp2aWV3OnVjYXB0dXJlIiwidmlldzpiaTpsb29rZXIiLCJ2aWV3Om9yZy1oaWVyYXJjaHkiLCJ3cml0ZTpleHBlcmllbmNlcyIsIndyaXRlOnVhc3Npc3QiXX0.yJlqD8yXB5dqhxC0E22TOkdyjxKRfwbSlrAk0ilty-EUMXv4XonqikRPxZdkUGI1CvdDK7Em6RCZXZ1IaETYoOQH1Jx1qqRBWpSNyU4nWMGMJeDdRkBvnDe-DYP5-M54jq6VQEu31lIYdYCDs7kGYkkuLfoHyIx2bpOF5U3YvmfK3C1eWCADTv9pL9ptBOrLs4vBe87a26g7yGp698Sm2bUPY-tj34nDqyzUrVWlRgv1dEBSCcPRMmJGzd0l5azIS9mO3egxmXP4G8h_7YfNrfxutxCMg5GD6dju4QKEydMwL15gnkSUnTbdrNn1xzOHF93ogKl6RbM_UC71jk3sTg' \
--data '{
"summaryTemplateId": "67767f93-a9c8-4b4b-a85f-0f793da2f764",
"version": 1
}'Header Parameter
In the Header Parameter, mention the authorization token of the Admin or Agent user. For more information on how to obtain user authorization token, click here.
Authorization - Bearer <Token>
cURL Command using M2M token
curl --location --request PATCH 'https://api.us.cloud.uniphorestaging.com/summary/v1/conversations/67767f93-a9c8-4b4b-a85f-0f793da2f763/summary-template?environment=dev' \
--header 'X-Tenant-id: 3e37631c-78ac-4137-8415-72dcd90b19fd' \
--header 'X-Source: service' \
--header 'X-Username: auth0|678fbe66ad204c0eaa47f00a' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJpc3MiOiJodHRwczcy5hdXRoMC5jb20vIiwic3ViIjoiSlBFZTcwRTBPYXA3TVViUGdROWtYTmlrTVRqZVlqeDBAY2xpZW50cyIsImF1ZCI6ImFwaS51bmlwaG9yZS5jb20iLCJpYXQiOjE3NTAyNjk1NDgsImV4cCI6MTc1MDg3NDM0OCwic2NvcGUiOiJyZWFkOmV4cGVyaWVuY2VzIHdyaXRlOmV4cGVyaWVuY2VzIHdyaXRlOnVhc3Npc3QgcmVhZDp1YXNzaXN0IHJlYWQ6dXNlcnMiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJKUEVlNzBFME9hcDdNVWJQZ1E5a1hOaWtNVGplWWp4MCIsInBlcm1pc3Npb25zIjpbInJlYWQ6ZXhwZXJpZW5jZXMiLCJ3cml0ZTpleHBlcmllbmNlcyIsIndyaXRlOnVhc3Npc3QiLCJyZWFkOnVhc3Npc3QiLCJyZWFkOnVzZXJzIl19.wc_kdJRCgH7NSLFHO0XKv_LVQ-30SF4z9h6JfadQtJ8Mo1AFsOIO-QgDKfbnj79qaRKlJs4mOPaP2SCGVTyAMtcWoEaIqgnm0nrFijVGpjQv7g3jYzZSMg3kxoFnORj4JLecJ0W_OrrpPB1Phe0_ilSFnJEriy9YbdIX-znnrf7b_ec7binMBHbGQkXnUJ-yufijuWzygBAlE6AdOmzVdEwluByX2wn4fr0PVs4U2CX445Lr4EqoyJTpeJVNeE3TjhO-8DOb6sDnZoJDy55ah9HUb3lPoUj7Mcod8ww3rIrF7n0HIYQ5auh4EX5e5ce1kcn9R-mfosYykcVUhl5gaA' \
--data '{
"summaryTemplateId": "67767f93-a9c8-4b4b-a85f-0f793da2f763",
"version": 1
}'To generate access token, click here.
Header Parameters
Parameter Name | Data Type | Description |
|---|---|---|
X-Tenant-id | String | The unique identifier for your account. |
X-Source | String | Identifies which service is making the API request. |
X-Username | String | Logged-in username should be sent with all client requests. |
Content-Type | String | Indicates that the request body format is JSON. |
Authorization | String | 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. |
Path Parameter
Parameter Name | Date Type | Description | Required/Optional |
|---|---|---|---|
conversations | String | ID generated by the Conversation service. | Required |
Use the Interaction API to retrieve the Conversation IDs for a given Tenant ID.
Note
Please contact your Uniphore support representative to obtain the Tenant ID.
Query Parameter
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
environment | String | The name of the environment. Three out-of-the-box environments are provided for each account:
For more information on multi environment accounts, click here. | Required |
Sample Request
{
"summaryTemplateId": "67767f93-a9c8-4b4b-a85f-0f793da2f764",
"version": 1
}These parameters act as filters. The response is based on the provided filter values.
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
summaryTemplateId | String | The Summary Template ID is automatically generated after creating the template in the Administration Platform. For more information on creating a template, click here. | Required |
version | Number | Version number of the Summary Template. | Required |
Response and Error Codes
Code | Response |
|---|---|
200 | Ok - The request has succeeded. This response code will be shown when the Summary is successfully generated for the given request. |
400 | Summary generation failed. This response code will be shown with the valid messages if any of the following scenarios occur:
|
401 | Authentication failed. This response code will be shown if any of the following scenarios occur:
|
412 | Summary generation failed. This response code will be shown with the valid messages if any of the following scenarios occur:
|
500 | When the services are down, it shows an 'Internal Server Error'. |