| Method | GET |
|---|---|
| Endpoint | https://{{host}}/agentassist/api/v1/public/{{streamId}}/conversations/{{conversationId}} |
| Content Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token |
| API Scope | SmartAssist Analytics |
Path Parameters
| Parameter | Description | Type |
|---|---|---|
host | The Environment URL. For example, https://platform.kore.ai | string, required |
streamId | botId or streamId. You can get it from the App Settings page. | string, required |
Query Parameters
| Parameter | Description | Type |
|---|---|---|
conversationId | A specific conversationId. This will fetch the records from that conversation. In case only the specific conversation is required, set the limit to 1. This field can’t be used in combination with dateFrom and dateTo. | string, required |
Sample Request
curl --location 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/conversations/{{conversationId}}' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'accountId: {{YOUR_accountId}}'
Header Parameters
| Header | Description | Optional/Required |
|---|---|---|
accountid | Unique account identifier. | Required |
auth | JWT authentication token. | Required |
Sample Response
{
"participants": [
{
"queueId": "qu-241a4d7-e5d0-45a9-8032-82384505xxxx",
"queueStartTime": "2023-05-22T04:55:05.350Z",
"queueName": "Default Queue",
"agentId": "u-b19cd89e-6533-59af-b491-eec9bf8fxxxx",
"name": "John Doe",
"status": "INACTIVE",
"assignedAt": "2023-05-22T04:55:05.452Z",
"startTimeStamp": "2023-05-22T04:55:07.718Z",
"endTimeStamp": "2023-05-22T05:29:14.043Z",
"isTransferred": false,
"onInterrupt": true
}
],
"transferDetails": [
{
"fromQueue": "qu-241a4d7-e5d0-45a9-8032-82384505xxxx",
"fromAgent": "u-b19cd89e-6533-59af-b491-eec9bf8fxxxx",
"transferredType": "QUEUE",
"transferredTo": [
{
"id": "qu-241a4d7-e5d0-45a9-8032-82384505xxxx",
"name": "Default Queue",
"type": "QUEUE"
}
],
"transferredBy": "u-b19cd89e-6533-59af-b491-eec9bf8fxxxx",
"priority": "HIGHEST",
"transferredAt": "2023-05-22T05:29:14.007Z",
"isManager": false
}
],
"waitTime": 3369,
"isProactiveAgentAssistEnabled": true,
"status": "CLOSED",
"callbackOpted": false,
"contactFlow": [],
"surveyRequired": "YES",
"isDeveloper": false,
"_id": "c-3c04346-e522-4c53-9e03-c9566d85xxxx",
"orgId": "o-ca23f4c5-cc3e-586d-90e6-8375bf2dxxxx",
"userId": "u-aa15c0f4-7f78-5912-8713-f5cd1c3exxxx",
"accountId": "637368b4a1d039e34ba6xxxx",
"botId": "st-3bf09bef-f979-5489-b337-f465bd5dxxxx",
"source": "rtm",
"botSessionId": "646af57bcc41e5bfbd5exxxx",
"language": "en",
"keyIntentName": "TalkToAgent",
"keyIntentUserInput": "I want to talk to an agent",
"conversationType": "messaging",
"priority": 5,
"startTime": "2023-05-22T04:55:05.351Z",
"endTime": "2023-05-22T05:29:14.086Z",
"skills": [],
"acceptedAt": "2023-05-22T04:55:07.718Z",
"notes": [],
"dispositions": {
"metaStatus": "SYSTEM_DROP_OFF",
"status": "DROP-OFF",
"remarks": "I'm sorry. It seems like there are no agents that can help you at this time. Reach out us a bit later.",
"dispositionSets": null
}
}
Response Body Parameters
| Parameter | Description | Type |
|---|---|---|
transferDetails | Transfer details of the conversation. | array |
waitTime | The wait time for the conversation in milliseconds. | integer |
isProactiveAgentAssistEnabled | Whether proactive AgentAI is enabled for the conversation. | boolean |
callbackOpted | Whether callback is opted for the conversation. | boolean |
contactFlow | Contact flow information for the conversation. | array |
surveyRequired | Whether a survey is required for the conversation. | boolean |
isDeveloper | Whether the user is a developer. | boolean |
id | The conversation Id. | integer |
userId | The ID of the user associated with the conversation. | string |
source | The source of the conversation. | string |
botSessionId | The ID of the bot session associated with the conversation. | string |
keyIntentName | The key intent for the conversation. | string |
keyIntentUserInput | The user input associated with the key intent for the conversation. | string |
agentDesktopMeta | Additional metadata related to the agent desktop. | object |
conversationType | The type of conversation (for example, messaging). | string |
priority | The priority level of the conversation. | string |
queues | Queue details for the conversation. | array |
startTime | The start time of the conversation. | string |
endTime | The end time of the conversation. | string |
formData | Form data associated with the conversation. | array |
timestampValue | The timestamp value of the conversation. | integer |
createdAt | The creation time of the conversation. | string |
updatedAt | Last updated time of the conversation. | string |
skills | The skills associated with the conversation. | array |
acceptedAt | The time when the conversation was accepted. | string |
notes | Notes associated with the conversation. | array |
dispositions | Disposition details for the conversation. | object |
userInfo | User information associated with the conversation. | object |