Fetch Conversation Details for a Given Conversation ID
This API retrieves conversation details such as entities, flows, variables, transcripts, alerts, experience ID, summary, agent note, sentiment, and so on for a given conversation ID, tenant ID and environment.
Endpoint
Method: GET
URL: https://api.<region>.cloud.uniphore.com/diana/v2/conversations/<tenantId>/<conversationId>
<region> - Mention the name of the region, such as the United States, India, the United Kingdom, the Middle East, and so on, where the U-Assist application is deployed on the public cloud.
Sample Request
curl --location 'https://api.us.cloud.uniphorestaging.com/diana/v2/conversations/3e38931c-78ac-4137-8415-72dcd78b19fd/a3c52ccd-2ea1-45b2-b59e-5a95ff860e0b?environment=dev' \ --header 'X-Source: service' \ --header 'Authorization: Bearer eyJhbGciOiMSUzI1NiInInR5cCI4ImpXBNIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsidV9hZ2VudCIsImludGVyYWN0X2FnZW50Il0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9lbWFpbF9pZCI6InFhYWdlbnRAcWF0ZXN0ZW52MS5jb20iLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vYXV0aDBfbmFtZSI6InFhYWdlbnQiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9pZCI6ImF1dGgwfDY0NzU4OWY2ODUyZjExZTJkM2ViOTQ4MyIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91c2VyX21ldGFkYXRhIjp7ImNsaWVudF9pZCI6InFhYWdlbnRAcWF0ZXN0ZW52MS5jb20ifSwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3RlbmFudCI6IjNlMzc2MzFjLTc4YWMtNDEzNy04NDE1LTcyZGNkOTBiMTlmZCIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS90ZW5hbnRfbmFtZSI6InFhdGVzdGVudjEiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vY2x1c3RlciI6InVzIiwiaXNzIjoiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDY0NzU4OWY2ODUyZjExZTJkM2ViOTQ4MyIsImF1ZCI6WyJ1YXNzaXN0LnVuaXBob3JlLmNvbSIsImh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3MTg5NTY1MTIsImV4cCI6MTcxOTA0MjkxMiwic2NvcGUiOiJvcGVuaWQiLCJvcmdfaWQiOiJvcmdfUDZTQ3VGSHlsRUNQNTU2MCIsImF6cCI6IkRqY3B4b0lkZERmdWZIRmRRTjVCbjRpWDYzWnhBa3VmIiwicGVybWlzc2lvbnMiOlsicmVhZDpleHBlcmllbmNlcyIsIndyaXRlOmV4cGVyaWVuY2VzIl19.RR7r7ZXC170oLfJAh6aAkUduDB3WYzqxMZZwnUp_cadTxHHTPpPCwE9_e0AkLCIMqTg1Ul2GZ3GkufgOfzFA6Oj2XhAJRiH-NSydDI4KKfGdQR3yp1Ml3Tgj_KiX-75xobpwU9OEydE0KxFwlu6kgFRU8fPlGCgSz5phbnl2zDqjIVGW06HrHncmIM84gUVn5us8AsA_xHBvb7DFZ8Vtdd3NiOVuNIdF_cl-FkEhA8AQCKaZfTk8IrX3xDk5R3PhmUf-hKKUkmTM1nc43i-Eewr_Y2m12U4Yyc96uzZWthtpL0o15xHE-VLmNAdtvrGR3z7GogGPoxmpiRKLLmtbNQ'
In the Header Parameter, mention the authorization token of the Admin user. For more information on how to obtain user authorization token, click here.
Authorization - Bearer <Token>
Parameter Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
tenantId | Mandatory | String | The unique identifier for your account. |
conversationId | Mandatory | String | ID generated by the conversation service. |
Parameter Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
environment | Mandatory | 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. |
Sample Response
For a complete Fetch Conversation Details API sample response, click here.
Response and Error Codes
Code | Response |
|---|---|
200 | Ok - The request has succeeded. This response code will be shown when the conversation details for the given conversation ID are successfully retrieved. |
400 | Bad Request. The request was unacceptable, often due to missing a required parameter. |
401 | Authentication failed. This response code will be shown if any of the following scenarios occur:
|
403 | Forbidden. If you use the access token of other roles (Analyst or Supervisor), this response code will be shown. |
500 | When the services down, it shows an 'Internal Server Error'. |