streamId.
| Method | GET |
|---|---|
| Endpoint | https://{{host}}/agentassist/api/v1/public/{{streamId}}/organizations/{{orgId}}/agents?page=1&includeQueues=True |
| 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://platform.kore.ai | String, required |
streamId | Bot identifier or Stream identifier. You can get it from the App Settings page. | String, required |
orgId | The organization identifier. | String, required |
Query Parameters
| Parameter | Description | Type |
|---|---|---|
page | The page number to return. Default is 1. | Integer, optional |
includeQueues | Whether to include queues in the response. | Boolean, optional |
Sample Request
curl --location 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/organizations/{{orgId}}/agents?page=1&includeQueues=True' \
--header 'auth: {{JWT_TOKEN}}'
--header 'accountId: {{accountId}}'
Sample Response
{
"results": [
{
"status": "ACTIVE",
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3xxxx",
"accountId": "6201eaad257a163e989axxxx",
"IsAgentConsoleLanding": true,
"agentGroups": [
{
"groupId": "ag-b6a6178-e35e-47cc-9a40-900956c0xxxx",
"accessLevel": "full",
"role": "manager",
"groupName": "Default Group"
},
{
"groupId": "ag-30ecdc8-19d2-40e8-a0b9-e9387319xxxx",
"accessLevel": "full",
"role": "manager",
"groupName": "New Group"
}
],
"canSupportChat": true,
"maxChatSupport": 5,
"chatLanguageSupport": [
{
"isActive": true,
"language": "en",
"proficiency": "expert"
},
{
"isActive": true,
"language": "de",
"proficiency": "expert"
},
{
"isActive": true,
"language": "es",
"proficiency": "expert"
}
],
"canSupportVoice": true,
"voiceLanguageSupport": [
{
"isActive": true,
"language": "en",
"proficiency": "expert"
},
{
"isActive": true,
"language": "de",
"proficiency": "expert"
},
{
"isActive": true,
"language": "es",
"proficiency": "expert"
}
],
"createdBy": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"onlineStatus": "Offline",
"onlineStatusType": "OFFLINE",
"hoursOfOperationId": "6201ead21e06473c153cxxxx",
"roleId": "6201eaad257a163e989axxxx",
"createdAt": "2022-02-08T04:00:19.156Z",
"updatedAt": "2023-05-11T07:29:25.278Z",
"lastOnlineAt": "2023-05-11T07:29:25.278Z",
"desktopLayouts": [
{
"isDefault": false,
"id": "ly-ca5231e-9b44-4b39-ac8d-0b36202axxxx"
},
{
"isDefault": true,
"id": "ly-92d92b7-4798-419a-a719-07aab1a6xxxx"
},
{
"isDefault": false,
"id": "ly-b0ed0dc-7dec-4d7c-8933-78797a22xxxx"
}
],
"attachmentsEnabled": true,
"emojisEnabled": true,
"isAccountOwner": true,
"sipURI": "sip:supportuat94@smartassist-agent-np.kore.ai:5060",
"id": "a-1353078-d362-4d5e-95ed-554056e7xxxx",
"emailId": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"nickName": "John",
"phoneNumber": "221421421421",
"profImage": "no-avatar",
"skills": [
{
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"skillId": "641847bf731b5d4baa2dxxxx",
"proficiencyLevel": "average",
"name": "Blue Skill",
"skillGroupId": "6201ead21e06473c153cxxxx",
"skillGroupName": "Default SkillGroup",
"skillGroupColor": "#D2000D",
"id": "641847bf731b5d4baa2dxxxx"
},
{
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"skillId": "641847d1731b5d4baa2dxxxx",
"proficiencyLevel": "average",
"name": "Red Skill",
"skillGroupId": "6201ead21e06473c153cxxxx",
"skillGroupName": "Default SkillGroup",
"skillGroupColor": "#D2000D",
"id": "641847d1731b5d4baa2dxxxx"
},
{
"skillId": "6201ead31e06473c153cxxxx",
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"proficiencyLevel": "expert",
"name": "Default Skill",
"skillGroupId": "6201ead21e06473c153cxxxx",
"skillGroupName": "Default SkillGroup",
"skillGroupColor": "#D2000D",
"id": "6201ead31e06473c153cxxxx"
}
],
"queues": [
{
"name": "Default Queue",
"description": "queue description",
"agents": [
{
"isPreferredAgent": true,
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx"
}
],
"id": "qu-53c78e9-d249-477e-a472-9426e25dxxxx"
},
{
"agents": [
{
"isPreferredAgent": false,
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx"
}
],
"name": "Test Queue",
"description": "121242",
"id": "qu-3066a40-5b85-4ee5-9a8e-6bd8002xxxx"
},
{
"agentGroups": [],
"agents": [
{
"isPreferredAgent": false,
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx"
}
],
"name": "Test Queue 6090",
"id": "qu-b3b13c5-271a-4599-ab38-9e44acc4xxxx"
},
{
"agentGroups": [],
"agents": [
{
"isPreferredAgent": false,
"userId": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx"
}
],
"name": "Sample Queue4",
"id": "qu-d937893-c788-45d0-9da8-23490287xxxx"
}
],
"role": "Administrator"
},
{
"status": "ACTIVE",
"hoursOfOperationId": "6201ead21e06473c153cxxxx",
"canSupportChat": true,
"IsAgentConsoleLanding": true,
"maxChatSupport": 20,
"roleId": "6389e47741afba5c08bfxxxx",
"chatLanguageSupport": [
{
"isActive": true,
"language": "en",
"proficiency": "expert"
},
{
"isActive": false,
"language": "de",
"proficiency": "expert"
}
],
"canSupportVoice": true,
"voiceLanguageSupport": [
{
"isActive": true,
"language": "en",
"proficiency": "expert"
},
{
"isActive": false,
"language": "de",
"proficiency": "expert"
}
],
"userId": "u-70b19d34-e795-5059-b687-484c0bcxxxx",
"accountId": "6201eaad257a163e989axxxx",
"createdBy": "u-c8a51563-bae4-5730-bc2e-4a838898xxxx",
"orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3xxxx",
"agentGroups": [
{
"groupId": "ag-b6a6178-e35e-47cc-9a40-900956c0xxxx",
"role": "manager",
"accessLevel": "view",
"groupName": "Default Group"
}
],
"createdAt": "2022-03-15T12:40:33.177Z",
"updatedAt": "2023-03-06T05:55:20.517Z",
"onlineStatus": "Offline",
"onlineStatusType": "OFFLINE",
"lastOnlineAt": "2023-03-06T05:55:20.517Z",
"attachmentsEnabled": true,
"emojisEnabled": true,
"id": "a-898331c-c9e6-4918-9501-6c262619xxxx",
"emailId": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"nickName": "Jane",
"phoneNumber": "9000011111",
"profImage": "no-avatar",
"skills": [],
"queues": [
{
"agentGroups": [],
"agents": [
{
"isPreferredAgent": false,
"userId": "u-70b19d34-e795-5059-b687-484c0bc1xxxx"
}
],
"name": "Test Queue 6090",
"id": "qu-b3b13c5-271a-4599-ab38-9e44accxxxx"
},
{
"agentGroups": [],
"agents": [
{
"isPreferredAgent": false,
"userId": "u-70b19d34-e795-5059-b687-484c0bc1xxxx
}
],
"name": "Sample Queue4",
"id": "qu-d937893-c788-45d0-9da8-23490287xxxx"
}
],
"role": "Agent"
}
],
"skip": 0,
"limit": 10,
"hasMore": false,
"totalPages": 1,
"totalResults": 10
}
Response Body Parameters
| Parameter | Type | Description |
|---|---|---|
results | Array | List of agents returned in the response. |
results.status | String | Status of the agent. |
results.userId | String | Unique identifier of the user. |
results.orgId | String | Unique identifier of the organization. |
results.accountId | String | Unique identifier of the account. |
results.IsAgentConsoleLanding | Boolean | Indicates whether the Agent Console is the landing page for the agent. |
results.agentGroups | Array | Groups assigned to the agent. |
results.agentGroups.groupId | String | Unique identifier of the agent group. |
results.agentGroups.accessLevel | String | Access level assigned to the agent for the group. |
results.agentGroups.role | String | Role assigned to the agent in the group. |
results.agentGroups.groupName | String | Name of the agent group. |
results.canSupportChat | Boolean | Indicates whether the agent can support chat interactions. |
results.maxChatSupport | Integer | Maximum number of chat interactions the agent can support simultaneously. |
results.chatLanguageSupport | Array | Languages supported by the agent for chat interactions. |
results.chatLanguageSupport.isActive | Boolean | Indicates whether the language is active for chat support. |
results.chatLanguageSupport.language | String | Language code supported for chat. |
results.chatLanguageSupport.proficiency | String | Agent’s proficiency level in the language. |
results.canSupportVoice | Boolean | Indicates whether the agent can support voice interactions. |
results.voiceLanguageSupport | Array | Languages supported by the agent for voice interactions. |
results.voiceLanguageSupport.isActive | Boolean | Indicates whether the language is active for voice support. |
results.voiceLanguageSupport.language | String | Language code supported for voice interactions. |
results.voiceLanguageSupport.proficiency | String | Agent’s proficiency level in the language. |
results.createdBy | String | Unique identifier of the user who created the agent. |
results.onlineStatus | String | Current online status of the agent. |
results.onlineStatusType | String | Type of the agent’s online status. |
results.hoursOfOperationId | String | Unique identifier of the associated hours of operation configuration. |
results.roleId | String | Unique identifier of the agent’s role. |
results.createdAt | String | Date and time when the agent was created in ISO 8601 format. |
results.updatedAt | String | Date and time when the agent was last updated in ISO 8601 format. |
results.lastOnlineAt | String | Date and time when the agent was last online in ISO 8601 format. |
results.desktopLayouts | Array | Desktop layouts assigned to the agent. |
results.desktopLayouts.isDefault | Boolean | Indicates whether the desktop layout is the default layout. |
results.desktopLayouts.id | String | Unique identifier of the desktop layout. |
results.attachmentsEnabled | Boolean | Indicates whether attachments are enabled for the agent. |
results.emojisEnabled | Boolean | Indicates whether emojis are enabled for the agent. |
results.isAccountOwner | Boolean | Indicates whether the agent is the account owner. |
results.sipURI | String | SIP URI associated with the agent. |
results.id | String | Unique identifier of the agent. |
results.emailId | String | Email address of the agent. |
results.firstName | String | First name of the agent. |
results.lastName | String | Last name of the agent. |
results.nickName | String | Nickname of the agent. |
results.phoneNumber | String | Phone number of the agent. |
results.profImage | String | Profile image identifier or URL. |
results.skills | Array | Skills assigned to the agent. |
results.skills.userId | String | Unique identifier of the user associated with the skill. |
results.skills.skillId | String | Unique identifier of the skill. |
results.skills.proficiencyLevel | String | Agent’s proficiency level for the skill. |
results.skills.name | String | Name of the skill. |
results.skills.skillGroupId | String | Unique identifier of the skill group. |
results.skills.skillGroupName | String | Name of the skill group. |
results.skills.skillGroupColor | String | Color associated with the skill group. |
results.skills.id | String | Unique identifier of the skill assignment. |
results.queues | Array | Queues assigned to the agent. |
results.queues.name | String | Name of the queue. |
results.queues.description | String | Description of the queue. |
results.queues.agents | Array | Agents assigned to the queue. |
results.queues.agents.isPreferredAgent | Boolean | Indicates whether the agent is the preferred agent for the queue. |
results.queues.agents.userId | String | Unique identifier of the agent assigned to the queue. |
results.queues.agentGroups | Array | Agent groups associated with the queue. |
results.queues.id | String | Unique identifier of the queue. |
results.role | String | Role assigned to the agent. |
skip | Integer | Number of results skipped from the beginning of the result set. |
limit | Integer | Maximum number of results returned in the response. |
hasMore | Boolean | Indicates whether more results are available. |
totalPages | Integer | Total number of pages available for the result set. |
totalResults | Integer | Total number of results available. |