GETTING STARTED
Introduction to SmartAssist
Glossary
SmartAssist Lifecycle Management
SmartAssist Setup Guide
Sign Up for SmartAssist
Release Notes
Recent Updates
Previous Versions
Frequently Asked Questions (FAQ)

EXPERIENCE DESIGNERS
Flow Designer
Introduction
Create Experience Flows
Navigate the Flow Designer
Experience Flow Nodes
Introduction
Node Types
IVR Menu
IVR Digit Input
Conversational Input
Split
Check Agent Availability
Check Business Hours
Message Prompt
Run Automation
Agent Transfer
Connect to API
Go to Flow
Deflect to Chat
Script Task
Set Queue
End Flow
Waiting Experience
Conversation Automation
Testing Widget
Use Cases
Overview
Questions & Answers
Conversations

ADMINISTRATORS
Account Management
Switch Account
Invite Developers to an Account
Routing
Skills
Skill Groups
Queues
Hours of Operation
Default Flows
User Management
Users
Agent Groups
Agent Settings
Role Management
Agent Status
System Setup
Channels
Voice
Chat
Email
Limitations With Accounts Using AudioCodes
Agent Transfer
Surveys
Agent Forms
Dispositions
Language & Speech
Overview
Language Management
Voice Preferences
Hold Audio
Standard Responses
Handling Sensitive Data
Widgets
Utils
AgentAssist Settings
SearchAssist
Advanced Settings
Co-Browse Settings
Community WFM (Beta)
Automatic Conversation Summary (Beta)
Intelligent Agent Tools
Sensitive Data Masking
API Reference
API Setup
API List
Integrations
Genesys Voice Bot
Genesys + Kore Voice Automation - Manual Installation Guide
Voice Automation - Integration with Amazon Connect
Voice Automation NiceCX (CX One) - SIP Integration
Talkdesk Voice Automation
ID R&D Integration With Kore
Audit Report

AGENTS
Agent Console
Introduction
Conversation Tray
Incoming Interactions
Interacting with Customers
Additional Tools
My Dashboard

SUPERVISORS
Dashboard
Automation
Queues and Agents
Interactions
Monitor Queues, Agents, Interactions, and Service Levels
Manage Layout

BUSINESS USERS
Reports
Introduction
Reports List

Update a Specific Agent

To update the details of a particular agent with the given streamId and agentId.

Method PUT
Endpoint https://{host}/agentassist/api/v1/public/{streamId}/agents/{agentId}?groupId={agentGroupId}
Content Type application/json
Authorization auth: {{JWT}}
See How to generate the JWT Token.
API Scope SmartAssist Analytics

 

Path Parameters

Parameter Description Type
host Environment URL, for example, https://smartassist.kore.ai String, Required
BotId BotId or StreamId. You can access it from the General Settings page of the bot. String, Required
agentId The agentId of the particular agent whose details are being retrieved. String, Required

 

Query Parameter

Parameter Description Type
agentgroupId The agentgroupId of the particular agent whose details are being retrieved. String, Required

 

Sample Request

curl --location --request PUT\
     'https://{host}/agentassist/api/v1/public/{streamId}/agents/{agentId}?groupId={agentGroupId}'
     --header 'auth: {jwt-code}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
    "emailId": "username@domain.com",
    "firstName": "Amanda",
    "lastName": "Jones",
    "nickName": "Amanda",
    "phoneNumber": 13456782xxx,
    "profImage": "5ff2331231245454",
    "agentGroupId": "ag-3234fsdf21312412123",
    "canSupportChat": true,
    "maxChatSupport": 5,
    "canSupportVoice": true,
    "roleId": "6ff2331231245454",
    "chatLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "voiceLanguageSupport": [
        {
            "language": "es",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "skills": [
        {
            "skillId": "s-21223123",
            "proficiencyLevel": "expert",
            "userId": "u-f9e37b9c-66d5-5525-9df1-da0edbeaxxxx",
            "createdBy": "u-f9e37b9c-66d5-5525-9df1-da0edbeae62e",
            "orgId": "o-cff7fba7-ebf6-5b01-81a3-42bd24fa4eca",
            "accountId": "62cd37c6f35860734283xxxx",
            "id": "62cd41c87e03db7067180d63",
            "name": "Default Skill",
            "skillGroupName": "Default SkillGroup",
            "skillGroupColor": "#D2000D"
        }
    ],
    "desktopLayouts": [
        {
            "id": "ly-de35d82-7323-4420-b893-c35b5175c6c6",
            "isDefault": true
        }
    ],
    "queues": [
        {
            "id": "qu-80ac056-57db-420b-b937-9581dd2074c0",
            "isPreferredAgent": true
        }
    ],
    "createDefaultLayoutAndAssign": true
  }
}'

 

Body Parameters

Parameter Description Type
emaiId The Email Id of the agent.
Example: adfa@adfa.com
Email, Required
firstName The First Name of the agent up to 50 characters long. String, Required
lastName The Last Name of the agent up to 50 characters long. String, Required
nickName The Nick Name of the agent up to 50 characters long. String, Optional
phoneNumber The Phone number of the agent. String, Required
profImage The File id of the profile image to be set. String, Optional
agentGroupId The Id of the agent group, which you can find with GET /agent-groups
Example: ag-3234fsdf21312412123
String, Optional
canSupportChat It tells whether the agent supports chat. Boolean, Optional
canSupportVoice It tells whether the agent can support the voice chat. Boolean, Optional
maxChatSupport It tells how many chats the agent can handle at a time. Number, Optional
voiceLanguageSupport An Array of Objects with the following details Required
language The Language supported.
Example: en/es
String, Required
proficiency The Proficiency level can be:
expert, novice, average, good.
Example: ‘expert’
String, Required
isActive It tells whether this support is active. Boolean, Optional
chatLanguageSupport An Array of Objects with the following details Required
language The Language supported.
Example: en/es
String, Required
proficiency The Proficiency level can be:
expert, novice, average, good.
Example: ‘expert’
String, Required
isActive It tells whether this support is active. Boolean, Optional
skills Array of Objects, which you can find with GET /skills . It contains the
the following details
Required
skillId The Skill Id.
Example: s-21223123
String, Required
proficiencyLevel The Proficiency level can be:
expert, novice, average, good
Example: ‘expert’
String, Required
roleId The Role id which you can find with GET /roles.
Example:633edb2bfa0ecc1192c62190
String, Optional
desktopLayouts Array of Objects which you can find with GET /layouts. It contains the following details Optional
id The desktop Layout Id.
Example: ly-de35d82-7323-4420-b893-c35b5175c6c6
String, Optional
isPreferredAgent It tells whether this is a preferred agent. Boolean, Optional
createDefaultLayoutAndAssign It tells whether to create and assign the default layout. Boolean, Optional

 

Sample Response

{
  "status": "ACTIVE",
  "agentAffinity": false,
  "canSupportChat": true,
  "maxChatSupport": 5,
  "roleId": "6344eb107b65bd738aa698b1",
  "chatLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "canSupportVoice": true,
  "voiceLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "desktopLayouts": [
    {
      "isDefault": true,
      "name": "Default Layout",
      "id": "ly-59736ed-eaac-40d6-8c5b-db294b100672"
    },
    {
      "isDefault": false,
      "name": "test1",
      "id": "ly-2a591ae-5021-4e25-a9be-9997e5857e2d"
    }
  ],
  "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
  "accountId": "633ffa91d784f471d0b8xxxx",
  "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d88050",
  "orgId": "o-f7507858-f354-504a-b56b-39464fb05319",
  "agentGroups": [
    {
      "groupId": "ag-bdc4010-e237-48e6-bb72-d3449a03a622",
      "role": "agent"
    }
  ],
  "lastOnlineAt": "2022-10-11T04:06:41.286Z",
  "createdAt": "2022-10-07T10:10:39.231Z",
  "updatedAt": "2022-10-12T10:48:53.418Z",
  "onlineStatus": "Available",
  "onlineStatusType": "AVAILABLE",
  "id": "a-1a36a7e-bb33-4bcc-ab7b-ac33773871d8",
  "emailId": "test.agent01.octxx@domain.com",
  "firstName": "test",
  "lastName": "agent 01",
  "nickName": "test agent 01",
  "phoneNumber": "9123456xxxx",
  "profImage": "no-avatar",
  "sipURI": "sip:supportdevelopment2xx@52.4.142.1xx:5060",
  "skills": [
    {
      "skillId": "633ffac608f3a07459939a1f",
      "proficiencyLevel": "expert",
      "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
      "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d88050",
      "accountId": "633ffa91d784f471d0b8xxxx",
      "orgId": "o-f7507858-f354-504a-b56b-39464fb05319",
      "createdAt": "2022-10-12T10:48:53.468Z",
      "updatedAt": "2022-10-12T10:48:53.468Z",
      "id": "63469b95b63e3c0ed3e3fa5b",
      "name": "Default Skill",
      "skillGroupName": "Default SkillGroup",
      "skillGroupColor": "#D2000D"
    }
  ],
  "queues": [
    {
      "id": "qu-353c014-96bb-4c3e-aebd-87a37927c780",
      "name": "Default Queue",
      "description": "queue description",
      "isPreferredAgent": true
    }
  ]
}

Update a Specific Agent

To update the details of a particular agent with the given streamId and agentId.

Method PUT
Endpoint https://{host}/agentassist/api/v1/public/{streamId}/agents/{agentId}?groupId={agentGroupId}
Content Type application/json
Authorization auth: {{JWT}}
See How to generate the JWT Token.
API Scope SmartAssist Analytics

 

Path Parameters

Parameter Description Type
host Environment URL, for example, https://smartassist.kore.ai String, Required
BotId BotId or StreamId. You can access it from the General Settings page of the bot. String, Required
agentId The agentId of the particular agent whose details are being retrieved. String, Required

 

Query Parameter

Parameter Description Type
agentgroupId The agentgroupId of the particular agent whose details are being retrieved. String, Required

 

Sample Request

curl --location --request PUT\
     'https://{host}/agentassist/api/v1/public/{streamId}/agents/{agentId}?groupId={agentGroupId}'
     --header 'auth: {jwt-code}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
    "emailId": "username@domain.com",
    "firstName": "Amanda",
    "lastName": "Jones",
    "nickName": "Amanda",
    "phoneNumber": 13456782xxx,
    "profImage": "5ff2331231245454",
    "agentGroupId": "ag-3234fsdf21312412123",
    "canSupportChat": true,
    "maxChatSupport": 5,
    "canSupportVoice": true,
    "roleId": "6ff2331231245454",
    "chatLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "voiceLanguageSupport": [
        {
            "language": "es",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "skills": [
        {
            "skillId": "s-21223123",
            "proficiencyLevel": "expert",
            "userId": "u-f9e37b9c-66d5-5525-9df1-da0edbeaxxxx",
            "createdBy": "u-f9e37b9c-66d5-5525-9df1-da0edbeae62e",
            "orgId": "o-cff7fba7-ebf6-5b01-81a3-42bd24fa4eca",
            "accountId": "62cd37c6f35860734283xxxx",
            "id": "62cd41c87e03db7067180d63",
            "name": "Default Skill",
            "skillGroupName": "Default SkillGroup",
            "skillGroupColor": "#D2000D"
        }
    ],
    "desktopLayouts": [
        {
            "id": "ly-de35d82-7323-4420-b893-c35b5175c6c6",
            "isDefault": true
        }
    ],
    "queues": [
        {
            "id": "qu-80ac056-57db-420b-b937-9581dd2074c0",
            "isPreferredAgent": true
        }
    ],
    "createDefaultLayoutAndAssign": true
  }
}'

 

Body Parameters

Parameter Description Type
emaiId The Email Id of the agent.
Example: adfa@adfa.com
Email, Required
firstName The First Name of the agent up to 50 characters long. String, Required
lastName The Last Name of the agent up to 50 characters long. String, Required
nickName The Nick Name of the agent up to 50 characters long. String, Optional
phoneNumber The Phone number of the agent. String, Required
profImage The File id of the profile image to be set. String, Optional
agentGroupId The Id of the agent group, which you can find with GET /agent-groups
Example: ag-3234fsdf21312412123
String, Optional
canSupportChat It tells whether the agent supports chat. Boolean, Optional
canSupportVoice It tells whether the agent can support the voice chat. Boolean, Optional
maxChatSupport It tells how many chats the agent can handle at a time. Number, Optional
voiceLanguageSupport An Array of Objects with the following details Required
language The Language supported.
Example: en/es
String, Required
proficiency The Proficiency level can be:
expert, novice, average, good.
Example: ‘expert’
String, Required
isActive It tells whether this support is active. Boolean, Optional
chatLanguageSupport An Array of Objects with the following details Required
language The Language supported.
Example: en/es
String, Required
proficiency The Proficiency level can be:
expert, novice, average, good.
Example: ‘expert’
String, Required
isActive It tells whether this support is active. Boolean, Optional
skills Array of Objects, which you can find with GET /skills . It contains the
the following details
Required
skillId The Skill Id.
Example: s-21223123
String, Required
proficiencyLevel The Proficiency level can be:
expert, novice, average, good
Example: ‘expert’
String, Required
roleId The Role id which you can find with GET /roles.
Example:633edb2bfa0ecc1192c62190
String, Optional
desktopLayouts Array of Objects which you can find with GET /layouts. It contains the following details Optional
id The desktop Layout Id.
Example: ly-de35d82-7323-4420-b893-c35b5175c6c6
String, Optional
isPreferredAgent It tells whether this is a preferred agent. Boolean, Optional
createDefaultLayoutAndAssign It tells whether to create and assign the default layout. Boolean, Optional

 

Sample Response

{
  "status": "ACTIVE",
  "agentAffinity": false,
  "canSupportChat": true,
  "maxChatSupport": 5,
  "roleId": "6344eb107b65bd738aa698b1",
  "chatLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "canSupportVoice": true,
  "voiceLanguageSupport": [
    {
      "isActive": true,
      "language": "en",
      "proficiency": "expert"
    }
  ],
  "desktopLayouts": [
    {
      "isDefault": true,
      "name": "Default Layout",
      "id": "ly-59736ed-eaac-40d6-8c5b-db294b100672"
    },
    {
      "isDefault": false,
      "name": "test1",
      "id": "ly-2a591ae-5021-4e25-a9be-9997e5857e2d"
    }
  ],
  "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
  "accountId": "633ffa91d784f471d0b8xxxx",
  "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d88050",
  "orgId": "o-f7507858-f354-504a-b56b-39464fb05319",
  "agentGroups": [
    {
      "groupId": "ag-bdc4010-e237-48e6-bb72-d3449a03a622",
      "role": "agent"
    }
  ],
  "lastOnlineAt": "2022-10-11T04:06:41.286Z",
  "createdAt": "2022-10-07T10:10:39.231Z",
  "updatedAt": "2022-10-12T10:48:53.418Z",
  "onlineStatus": "Available",
  "onlineStatusType": "AVAILABLE",
  "id": "a-1a36a7e-bb33-4bcc-ab7b-ac33773871d8",
  "emailId": "test.agent01.octxx@domain.com",
  "firstName": "test",
  "lastName": "agent 01",
  "nickName": "test agent 01",
  "phoneNumber": "9123456xxxx",
  "profImage": "no-avatar",
  "sipURI": "sip:supportdevelopment2xx@52.4.142.1xx:5060",
  "skills": [
    {
      "skillId": "633ffac608f3a07459939a1f",
      "proficiencyLevel": "expert",
      "userId": "u-cc128d1c-a846-5acb-b075-9fc49a73xxxx",
      "createdBy": "u-ca2cc57f-5c2b-5437-bb07-fe9020d88050",
      "accountId": "633ffa91d784f471d0b8xxxx",
      "orgId": "o-f7507858-f354-504a-b56b-39464fb05319",
      "createdAt": "2022-10-12T10:48:53.468Z",
      "updatedAt": "2022-10-12T10:48:53.468Z",
      "id": "63469b95b63e3c0ed3e3fa5b",
      "name": "Default Skill",
      "skillGroupName": "Default SkillGroup",
      "skillGroupColor": "#D2000D"
    }
  ],
  "queues": [
    {
      "id": "qu-353c014-96bb-4c3e-aebd-87a37927c780",
      "name": "Default Queue",
      "description": "queue description",
      "isPreferredAgent": true
    }
  ]
}