Skip to main content
Back to API List

Get All Conversations Data - Call Details-v2

To retrieve the raw data for all conversations in a detailed view. The days’ range can’t be more than seven days.
MethodPOST
Endpointhttps://{{host}}/agentassist/api/public/analytics/account/{{accountId}}/v2/interactionDetails?offset=0&limit=100, https://{{host}}/agentassist/api/public/analytics/account/{{accountId}}/v2/calldetails?offset=0&limit=100
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token
API ScopeSmartAssist Analytics

Path Parameters

ParameterDescriptionType
hostEnvironment URL, for example, https://platform.kore.aistring, required
accountIdThe Account Idstring, required

Query Parameters

ParameterDescriptionType
limitSpecifies the number of conversation records to retrieve, with a maximum limit of 100. For example, 50integer, optional
offsetDefines the number of pages to skip or retrieve. Defaults to 0 if unspecified, with a maximum value of 10. For example, 10integer, optional

Sample Request (Interaction Details)

Sample Request (Call Details)

Header Parameters

HeaderDescriptionOptional/Required
acceptDesired response format (for example, application/json)Optional
accept-languagePreferred response language (for example, en-US)Optional
accountIdUnique account identifierRequired
app-languageApplication display language (for example, en)Optional
content-typeRequest body format (application/json;charset=UTF-8)Required
refererSource application name (for example, smartassist)Optional
authJWT authentication tokenRequired
IIdStream or application idRequired

Request Body Parameters

ParameterDescriptionType
startDateThe start date from which records are considered. Format: yyyy-mm-dd HH24:mm:ss. Example: 2022-08-25 07:20:15DateTime, required
endDateThe end date up to which records are considered. Format: yyyy-mm-dd HH24:mm:ss. Example: 2022-08-25 18:20:15DateTime, required
timeZoneOffsetThe time zone offset. Examples: -330, 630, -500. Note: For US/New York, the offset is 300. Use a minus sign for time zones east of GMT; no sign for time zones west of GMT.number, required
selectedFieldsSpecifies which data fields to include in the API response. skills - Returns the agent’s areas of expertise or capabilities. customerinfo - Includes key customer details such as email, first name, last name, phone number, and other details. userleveltags - Returns tags assigned at the individual user level for categorization or filtering. sessionleveltags - Returns tags associated with a specific session or conversation instance. campaigninfo- Returns campaign details associated with a specific session or conversation.array[string], optional
channelsThe channels to include. Example: ['rtm', 'voice']
snoozeinfoIndicates the number of times and duration of a customer who is to be placed on snooze.array[string], optional
directionSpecifies the interaction direction to filter conversation data. Valid values typically include Inbound, Outbound, or Both.string, optional
queuesThe list of queue IDs in the instance bots.array[string], optional

Sample Response (Interaction Details)

Sample Response (Call Details)

Response Parameters

Parameter NameType and FormatDescriptionExample
conversationIdtype-prefixed-guidAn ID generated by SmartAssist for this conversation.c-7b08889-539d-408d-a3e6-9e6ae059xxxx
sessionIdinternal valueA bot-generated ID for this conversation.63bd199c197b3646dadexxxx
channelcharacter stringName of the channel. Values - Web/Mobile Client, System Mail, or VoiceWeb / Mobile Client
sessionStartTimeYYYY-MM-DDTHH SSStart time of the session.2023-01-10 2:25:54
sessionEndTimeYYYY-MM-DDTHH SSEnd time of the session.2023-01-10 2:25:54
botIdtype-prefixed-guidIdentifier of the bot involved.st-ae8470ab-8ecb-51fb-8e13-c87dc66fxxxx
userIdtype-prefixed-guidSmartAssist’s own generated user ID.u-8413fd99-4ded-5f6d-8c1a-176dc66xxxx
channelSpecificUserIdno known formatUser ID passed by the channel.john.doe@example.com
orgIdtype-prefixed-guidThe organization ID.o-5a0da1e4-2df3-5cec-9ee4-af0b2efdxxxx
smartStatusStringThe summarised live status of the session.CLOSED
Reasoncharacter stringThe reason for the status.NO AGENTS AVAILABLE
snoozeinfoYYYY-MM-DDTHH SSIndicates the number of times and duration of a customer who is to be placed on snooze.2023-01-10 2:25:54
disconnectingEventcharacter stringThe final event leading to the conversation ending.System Hangup
errorDetailsStringDetails of any error that occurred.
finalStatuscharacter stringCompletion status of the conversationCLOSED or BotResolved
automationBotIDsArrayList of automation bots involved in the session.”st-e5c6ae6b-c388-5acd-93b7-badaxxxx”
isVoicemailBooleanIndicates if the session was a voicemail.NO
agentChoseTranslateBooleanIndicates whether an Agent requires translation during his segment of the conversation.True
DirectionStringDirection of the call. Values: Inbound, Outbound.Inbound
finalStatusStringFinal status of the session.CLOSED
dispositionsarray of stringsDisposition assigned to the conversation.[Requires Supervisor Attention.
dispositionRemarksarray of stringsRemarks or notes related to the disposition from the agent.CUSTOMER needs help with Products and Sales. AGENT will connect her with an agent.
metaInfoobjectContains custom information, set by the automation.
metaInfo.callerstringPhone number of the caller.+112345xxxxx
metaInfo.calleestringPhone number of the person receiving the call.+112345xxxxx
metaInfo.callerHoststringIP address of the caller.12.xxx.67.8
metaInfo.userIdstringUnique identifier of the user.u-4245d01e-6124-587a-85b2-939fe3cfxxxx
metaInfo.dialedNumberstringNumber dialed by the caller.+112345xxxxx
metaInfo.agentTransferConfigobjectContains configuration for agent transfer including skills, bot, and last intent.
metaInfo.agentTransferConfig.skillsIdsarrayID of each skill of the agent handling this conversation.”6834045b2e9b90fa31c8xxxx”, “6834045b2e9b90fa31c8xxxx”
metaInfo.agentTransferConfig.overrideAgentsbooleanIndicates whether the default agent selection logic is overridden.false
metaInfo.agentTransferConfig.overrideValuesarrayList of override parameters applied when agent selection logic is overridden.
metaInfo.agentTransferConfig.assistEventsobjectContains configuration for assist-related events.
metaInfo.agentTransferConfig.assistEvents.startEventobjectContains configuration details for the assist start event.
metaInfo.agentTransferConfig.assistEvents.startEvent.startEvent.isEnabledbooleanIndicates whether the assist start event is enabled.false
metaInfo.agentTransferConfig.lastIntentNamestringThe last intent posted to the bot by the user.Pay Bill
metaInfo.agentTransferConfig.lastIntentuserInputstringThe user posted by the user.Can you please pay my bill?
metaInfo.agentTransferConfig.dialog_tonearrayCollection of detected conversational tone attributes associated with the interaction.
metaInfo.ipAddressstringIP address from which the user accessed the session.123.xxx.xxx.876
metaInfo.hostDomainstringDomain of the platform instance handling the interaction.
metaInfo.osstringOperating system of the user’s device.Windows
metaInfo.customerinfoObjectContains customer details captured during the session.
metaInfo.customerinfo.CustomerPhonestringCustomer’s phone number.+198765xxxxx
metaInfo.customerinfo.CenterPhonestringContact number of the service center.
metaInfo.customerinfo.CustomerFirstNamestringCustomer’s first name.John
metaInfo.customerinfo.CustomerLastNamestringCustomer’s last name.Doe
metaInfo.customerinfo.CustomerEmailstringCustomer’s email address.john.doe@example.com
metaInfo.agentTransferConfig.accountIdstringUnique identifier of the customer account associated with the session.674daf4bc9d17f4dc070xxxx
metaInfo.workinghoursobjectDefines the agent’s working days and hours.
metaInfo.workinghours.workdaysstringThe working days of the agent.mon,tue,wed,thu,fri
metaInfo.workinghours.workstartstringThe time when the agent begins accepting calls.8:00 AM
metaInfo.workinghours.workendstringThe time when the agent stops accepting calls.5:00 PM
metaInfo.profImagestringProfile image of the agent.
metaInfo.profColourstringProfile color code.#ff4500
metaInfo.jTitlestringJob title of the agent.
metaInfo.deptStringDepartment of the agent.
metaInfo.activationStatusstringThe activation status of agent.active
metaInfo.firstNamestringThe first name of the agent.Jane
metaInfo.lastNamestringThe last name of the agent.Doe
metaInfo._idstringInternal identifier for the user object.u-c1ca58fb-2208-52f8-9f9c-d542316exxxx
metaInfo.identitiesArray of objectsContains the list of mapped identities for the user.
metaInfo.identities.valstringMapped identity value.cs-259844d3-7827-5f33-ae7c-9d790e6d7548/c246a41e-91c1-418f-a4c3-a5d4ad59xxxx
metaInfo.identities.typestringType of identity mapping.mapped
metaInfo.transcribeConfigobjectConfiguration for call transcription.
metaInfo.transcribeConfig.transcribeBooleanIndicates whether transcription is enabled for the session.true
destinationsarray of objectsOne object for each Queue or Agent that the call was transferred to.
destinations.destinationTypeStringDestination for any transfer - to distinguish a direct-to-agent transfer from a transfer to queue.QueueEntry
destinations.queueIdtype-prefixed-guidSmartAssist’s internal ID for the Queue.qu-123dbe9-c752-464d-a9be-1d0e43b6xxxx
destinations.queueNamecharacter stringName of the queueResidential - Sales
destinations.CallbackOptedBooleanIndicates whether the customer opted for a callback.True or False
destinations.CallbackOptedTimeString (ISO 8601 datetime)Timestamp when the customer opted for the callback. Displayed only if CallbackOpted = true2025-09-30T06:34:48.810Z
destinations.userCallbackAcceptTimeString (ISO 8601 datetime)Timestamp when the customer accepted the callback initiated by the agent. Displayed only if CallbackOpted = true2025-09-30T06:35:00.589Z
destinations.EnterTimeString (ISO 8601 datetime)Time at which this conversation entered this queue.2023-01-10 2:25:54
destinations.respondingAgentobjectDetails of the responding agent. Note: When an agent responds to a conversation after it has been handed over, their details are captured in the respondingAgent object. However, if the initially assigned agent doesn’t respond and the conversation is reassigned to another agent, details of both the non-responding and responding agents are included in the nonRespondingAgent array of objects.
destinations.respondingAgent.agentIdtype-prefixed-guidSmartAssist’s internal ID for the agent.u-f3a11f62-57d7-5a9f-a071-787650b1xxxx
destinations.respondingAgent.agentNotesarray of stringsNotes provided by the agent.Customer has a problem with Products and Sales. She needs an agent to help her.
destinations.respondingAgent.destinationTypestringType of agent destination.AgentSegment
destinations.respondingAgent.statusstringStatus of the conversation with this respondingAgent.Answered
destinations.respondingAgent.firstResponseTimeYYYY-MM-DDTHH SSThe time at which this agent first responded.2023-01-10 2:25:54
destinations.respondingAgent.firstResponseDurationintegerDuration in seconds, from the time of Agent’s acceptance to the time of his first response.20
destinations.respondingAgent.interactionEndTimeYYYY-MM-DDTHH SSThe time at which the interaction with this respondingAgent ended.2023-01-10 2:25:54
destinations.respondingAgent.interactionDurationintegerDuration in seconds, from the time of Agent’s acceptance to the time of the last utterance.51
destinations.respondingAgent.afterCallWorkDurationintegerDuration in seconds, of the post-call-work of this agent.8
destinations.respondingAgent.afterCallWorkEndTimeYYYY-MM-DDTHH SSThe time when this agent completed post-call work.2023-01-10 2:25:54
destinations.respondingAgent.ConsultingAgentsarray of objectsContains details of the internal/external agent to whom the call has been transferred by the primary agent.
destinations.respondingAgent.ConsultingAgents.isMergedBooleanIndicates whether the agent’s record is merged with another.True or False
destinations.respondingAgent.ConsultingAgents.namestringThe name or phone number of the external agent.+9198765xxxxx
destinations.respondingAgent.ConsultingAgents.acceptedTimeString (ISO 8601 datetime)The timestamp when the external agent accepted the call.2025-09-30T12:05:45
destinations.respondingAgent.ConsultingAgents.assignedAtString (ISO 8601 datetime)The timestamp when the call was assigned to the external agent.2025-09-30T12:05:36
destinations.respondingAgent.ConsultingAgents.consultingEndTimeString (ISO 8601 datetime)The timestamp when the call ended.2025-09-30T12:05:58
destinations.respondingAgent.JoinedUsersarrayUsers who joined the call.
destinations.respondingAgent.emailstringAgent’s email address.john.doe@example.com
destinations.respondingAgent.namecharacter stringAgent’s name.
destinations.respondingAgent.assignedAtYYYY-MM-DDTHH SSThe time at which this conversation was assigned to the Agent.2023-01-10 2:25:54
destinations.respondingAgent.acceptedTimeYYYY-MM-DDTHH SSThe time at which this Agent accepted this conversation.2023-01-10 2:25:54
destinations.nonRespondingAgentsArray of objectsContains details of agents who were assigned to the interaction but didn’t respond.
destinations.nonRespondingAgents.agentIdStringUnique identifier of the agent who was assigned to the interaction but didn’t respond.u-3ea001b4-664a-58b6-8108-b8bca375xxxx
destinations.nonRespondingAgents.agentNotesArray of StringsList of notes or remarks recorded for the interaction, typically describing customer intent, bot behavior, or agent context.The customer initiated a conversation with the bot for various requests, including connecting to an agent.
destinations.nonRespondingAgents.destinationTypeStringSpecifies the segment type of the interaction. For non-responding agents, this value is typically AgentSegment.AgentSegment
destinations.nonRespondingAgents.emailstringEmail address of the agent who was assigned to handle the interaction.john.doe@example.com
destinations.nonRespondingAgents.namestringFull name of the assigned agent.John Doe
destinations.nonRespondingAgents.assignedAtstring (ISO 8601 datetime)Timestamp when the agent was assigned to the interaction.2025-10-01T13:08:55
destinations.nonRespondingAgents.nonResponseEventstringDescribes the reason the agent didn’t respond to the assigned interaction (for example, Ignored, Supervisor Reassigned).Ignored
csatScoreintegerCustomer Satisfaction (CSAT) score submitted for the call. This field is displayed only when the survey type is csat.4
npsScoreintegerNet Promoter Score (NPS) rating submitted for the call, typically on a scale of 0-10, indicating the likelihood of the customer recommending the service. This field is displayed only when the survey type is nps.2
likeDislikeScoreintegerIndicates whether the customer liked or disliked the interaction. A value of 1 represents Like, 0 represents Dislike. Displayed only when the survey type is likeDislike.0
surveyTypestringType of post-call survey associated with the call. For CSAT surveys, the value is csat, likeDislike, npscsat
csatFeedbackstringOptional textual feedback provided by the customer as part of the CSAT survey. Displayed only when the survey type is csat.
services
userleveltagsarray of tag objectsAll user-level tags associated with this session.{“name”: “accountnum”,”value”: “1214132431412xxxxx”}
sessionleveltagsarray of tag objectsAll session-level tags associated with this session.{“name”: “audioCodesCallDisconnect”,“value”: “1”}
campaigninfoobjectContains metadata of outbound campaigns associated with a specific session or conversation.
campaigninfo.campaignNamestringThe name of the outbound campaign associated with the interaction.Jan 23 hotfix check (Copy)
campaigninfo.campaignIdstringThe name of the outbound campaign associated with the interaction.cd-3e9169e-9b3a-4415-bdcd-4700a44xxxxx
campaigninfo.campaignInstanceIdstringUnique identifier for a specific execution or run of the campaign.cid-3b2e4e9-882d-48a7-a5a3-286b007xxxxx
campaigninfo.campaignDialingListIdstringUnique identifier of the dialing/contact list used in the campaign.cdl-6be0807b-c7cf-53fb-8c3c-ee2f66fxxxxx
campaigninfo.attemptintegerNumber of contact attempts made to the customer within the campaign.2
campaigninfo.contactStatusstringFinal disposition of the contact attempt (for example, answered, no-answer, busy, failed).no-answer
campaigninfo.campaignRunDateDateTime (ISO 8601)Date and time when the campaign was executed, in ISO 8601 UTC format.2026-02-16T14:06:41.807Z
campaigninfo.contactListNamearray[String]Name(s) of the contact list(s) associated with the campaign.WANTED JAN23
channelSpecificUserIdstringChannel-scoped identifier for the conversation.cs-1a12f704-5a74-5a4e-94d1-4a003cbxxxxx/c-40dd2be-1421-4e76-b54a-e5dba60xxxxx