Fetch Virtual Agent Details
This API is used to retrieve Virtual Agent details based on the given organization ID.
Endpoint
Method:GET
URL: https://<<hostname>>/cse/virtualAgentsList?orgIds=<<orgId>>
Header Parameter
Authorization - <Bearer Token>To learn more about Authorization, click here.
Query Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
orgIds | number | ID of Organization for which Virtual Agent's details need to be fetched | Required |
Sample Response
{
"virtualAgents": [
{
"vaId": 20,
"vaName": "USS VA Rule",
"vaAvatarName": "avatar rule",
"vaDescription": "",
"languages": [
{
"langEngId": 41,
"ilmId": null,
"langName": "English-GB",
"channels": null,
"langCode": "en-GB",
"langId": 7,
"faqBotSupport": null,
"generativeAiSupport": false,
"subDialectAvailable": true,
"featureFlagValueForGenAi": false
},
{
"langEngId": 45,
"ilmId": null,
"langName": "English-PH",
"channels": null,
"langCode": "en-PH",
"langId": 33,
"faqBotSupport": null,
"generativeAiSupport": false,
"subDialectAvailable": true,
"featureFlagValueForGenAi": false
}
],
"channels": [
{
"virtualAgentRoleChannelMapId": null,
"channelId": 2,
"channelName": "IVR"
}
],
"businessUnitData": {
"catId": 1,
"categoryName": "DefaultCat",
"nluEngine": null,
"organization": {
"orgId": 1,
"organizationName": "DefaultOrg"
}
},
"saveUtterancesTraining": false,
"faqBotIntent": false,
"vrms": [
{
"vrmId": 40,
"vrmIsLive": false,
"languages": [
{
"langEngId": 41,
"ilmId": null,
"langName": "English-GB",
"channels": null,
"langCode": "en-GB",
"langId": 7,
"faqBotSupport": null,
"generativeAiSupport": false,
"subDialectAvailable": true,
"featureFlagValueForGenAi": false
},
{
"langEngId": 45,
"ilmId": null,
"langName": "English-PH",
"channels": null,
"langCode": "en-PH",
"langId": 33,
"faqBotSupport": null,
"generativeAiSupport": false,
"subDialectAvailable": true,
"featureFlagValueForGenAi": false
}
],
"intentCount": 0,
"entityCount": 0,
"envId": 2,
"envName": "Test"
}
],
"isLLM": false
}
],
"errorBody": null
}Response Parameter
The following Response parameters are required to execute the Update Perceived Latency Settings API and Update Deepgram ASR Configuration.
Parameter Name | Description |
|---|---|
vrmId | Virtual Agent and Role combination ID |
langId | Language ID |
Response and Error Codes
Response Code | Condition |
|---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
500 | Internal Server Error |