/genesys-agent-assistants | Type: Application | PCID required: Yes
Tools
genesys-agent-assistants_delete_agentchecklist
Delete an agent checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentChecklistId | string | Yes | — | Agent Checklist ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentChecklistId": {
"type": "string",
"description": "Agent Checklist ID"
}
},
"required": [
"PCID",
"agentChecklistId"
]
}
genesys-agent-assistants_delete_assistant
Delete an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_delete_assistant_queue
Disassociate a queue from an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
}
},
"required": [
"PCID",
"assistantId",
"queueId"
]
}
genesys-agent-assistants_delete_assistant_queues
Disassociate the queues from an assistant for the given assistant ID and queue IDs. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueIds | string | No | — | Comma-separated identifiers of the queues that need to be deleted. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueIds": {
"type": "string",
"description": "Comma-separated identifiers of the queues that need to be deleted."
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_delete_assistant_variation
Delete assistant copilot variation by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
variationId | string | Yes | — | Variation ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"variationId": {
"type": "string",
"description": "Variation ID"
}
},
"required": [
"PCID",
"assistantId",
"variationId"
]
}
genesys-agent-assistants_delete_users_agentui_agents_autoanswer_agent_id_settings
Delete agent auto answer settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentId | string | Yes | — | The agent to apply the auto answer settings to |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent to apply the auto answer settings to"
}
},
"required": [
"PCID",
"agentId"
]
}
genesys-agent-assistants_get_agentchecklist
Get an agent checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentChecklistId | string | Yes | — | Agent Checklist ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentChecklistId": {
"type": "string",
"description": "Agent Checklist ID"
}
},
"required": [
"PCID",
"agentChecklistId"
]
}
genesys-agent-assistants_get_agentchecklists
Get the list of agent checklists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | The page size for the listing. The max that will be returned is 100. |
namePrefix | string | No | — | The agent checklist name prefix filter applied to the listing. |
language | string | No | — | The agent checklist language filter applied to the listing. |
sortOrder | string | No | — | The sort order for the listing |
sortBy | string | No | — | The field to sort by for the listing. |
agentChecklistIds | string[] | No | — | Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "The page size for the listing. The max that will be returned is 100."
},
"namePrefix": {
"type": "string",
"description": "The agent checklist name prefix filter applied to the listing."
},
"language": {
"type": "string",
"description": "The agent checklist language filter applied to the listing."
},
"sortOrder": {
"type": "string",
"description": "The sort order for the listing",
"enum": [
"asc",
"desc"
]
},
"sortBy": {
"type": "string",
"description": "The field to sort by for the listing.",
"enum": [
"dateModified",
"language",
"name"
]
},
"agentChecklistIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters."
}
},
"required": [
"PCID"
]
}
genesys-agent-assistants_get_agentchecklists_languages
Get the list of supported languagesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys-agent-assistants_get_assistant
Get an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
expand | string | No | — | Which fields, if any, to expand. |
languageVariation | string | No | — | Language variation |
fallbackToPrimaryAssistant | boolean | No | — | Fall back to primary assistant if specified variation is not found |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"expand": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"copilot"
]
},
"languageVariation": {
"type": "string",
"description": "Language variation"
},
"fallbackToPrimaryAssistant": {
"type": "boolean",
"description": "Fall back to primary assistant if specified variation is not found"
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_get_assistant_copilot
Get copilot configuration of an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_get_assistant_queue
Get queue Information for an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
expand | string | No | — | Which fields, if any, to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"expand": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"assistant"
]
}
},
"required": [
"PCID",
"assistantId",
"queueId"
]
}
genesys-agent-assistants_get_assistant_queue_users_job
Get job details. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
jobId | string | Yes | — | Job ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"jobId": {
"type": "string",
"description": "Job ID"
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"jobId"
]
}
genesys-agent-assistants_get_assistant_queues
Get all the queues associated with an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
expand | string | No | — | Which fields, if any, to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"expand": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"assistant"
]
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_get_assistant_variation
Get assistant copilot variation by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
variationId | string | Yes | — | Variation ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"variationId": {
"type": "string",
"description": "Variation ID"
}
},
"required": [
"PCID",
"assistantId",
"variationId"
]
}
genesys-agent-assistants_get_assistant_variations
Get variations of an assistant copilot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
}
},
"required": [
"PCID",
"assistantId"
]
}
genesys-agent-assistants_get_assistants
Get all assistants. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
limit | string | No | — | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
name | string | No | — | Return the assistant by the given name. |
expand | string | No | — | Which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"limit": {
"type": "string",
"description": "Number of entities to return. Maximum of 200. Deprecated in favour of pageSize"
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"name": {
"type": "string",
"description": "Return the assistant by the given name."
},
"expand": {
"type": "string",
"description": "Which fields, if any, to expand",
"enum": [
"copilot"
]
}
},
"required": [
"PCID"
]
}
genesys-agent-assistants_get_copilot_featuresupport
Get information about the support of features for all the languages or only for a certain language. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
language | string | No | — | Which language are the features supported for |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"language": {
"type": "string",
"description": "Which language are the features supported for"
}
},
"required": [
"PCID"
]
}
genesys-agent-assistants_get_queues
Get all queues assigned to any assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
queueIds | string | No | — | Comma-separated identifiers of the queues that need to be retrieved. |
expand | string | No | — | Which fields, if any, to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"queueIds": {
"type": "string",
"description": "Comma-separated identifiers of the queues that need to be retrieved."
},
"expand": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"assistant"
]
}
},
"required": [
"PCID"
]
}
genesys-agent-assistants_get_users_agentui_agents_autoanswer_agent_id_settings
Get agent auto answer settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentId | string | Yes | — | The agent to apply the auto answer settings to |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent to apply the auto answer settings to"
}
},
"required": [
"PCID",
"agentId"
]
}
genesys-agent-assistants_patch_assistant
Update an assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
copilot | object | No | — | The copilot value |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
googleDialogflowConfig | object | No | — | Google Dialogflow Config |
id | string | No | — | The globally unique identifier for the object. |
knowledgeSuggestionConfig | object | No | — | Knowledge Suggestion Config |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | The name of the assistant that will assist the agent. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | State of the assistant. |
transcriptionConfig | object | Yes | — | Transcription Config |
variationParent | object | No | — | Variation Parent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"copilot": {
"type": "object",
"description": "The copilot value",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot is enabled."
},
"liveOnQueue": {
"type": "boolean",
"description": "Copilot is live on selected queue."
},
"defaultLanguage": {
"type": "string",
"description": "Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."
},
"knowledgeAnswerConfig": {
"type": "object",
"description": "Knowledge Answer Config"
},
"summaryGenerationConfig": {
"type": "object",
"description": "Summary Generation Config"
},
"wrapupCodePredictionConfig": {
"type": "object",
"description": "Wrapup Code Prediction Config"
},
"answerGenerationConfig": {
"type": "object",
"description": "Answer Generation Config"
},
"nluEngineType": {
"type": "string",
"description": "Language understanding engine type.",
"enum": [
"NluV3"
]
},
"nluConfig": {
"type": "object",
"description": "Nlu Config"
},
"ruleEngineConfig": {
"type": "object",
"description": "Rule Engine Config"
},
"autoSearchConfig": {
"type": "object",
"description": "Auto Search Config"
},
"manualSearchConfig": {
"type": "object",
"description": "Manual Search Config"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"defaultLanguage",
"liveOnQueue"
]
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"googleDialogflowConfig": {
"type": "object",
"description": "Google Dialogflow Config",
"properties": {
"integrationId": {
"type": "string",
"description": "The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."
},
"conversationProfiles": {
"type": "array",
"items": {
"type": "object"
},
"description": "The conversation profiles for which the assistant will fetch transcription and knowledge suggestions."
}
},
"required": [
"conversationProfiles"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"knowledgeSuggestionConfig": {
"type": "object",
"description": "Knowledge Suggestion Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of vendor used for knowledge suggestions.",
"enum": [
"GoogleDialogflow",
"GenesysKnowledge",
"GenesysKnowledgeV3",
"Unknown"
]
},
"knowledgeBase": {
"type": "object",
"description": "Knowledge Base"
},
"knowledgeBases": {
"type": "array",
"items": {
"type": "object"
},
"description": "The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider."
},
"receiveSegmentedArticles": {
"type": "boolean",
"description": "Include segmented articles in knowledge suggestions."
}
},
"required": [
"vendorName"
]
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name of the assistant that will assist the agent."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "State of the assistant.",
"enum": [
"Active",
"Inactive"
]
},
"transcriptionConfig": {
"type": "object",
"description": "Transcription Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of the vendor used for speech transcription.",
"enum": [
"GoogleDialogflow",
"Unknown",
"Genesys"
]
}
},
"required": [
"vendorName"
]
},
"variationParent": {
"type": "object",
"description": "Variation Parent",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"assistantId",
"name",
"transcriptionConfig"
]
}
genesys-agent-assistants_patch_assistant_queues
Update Queues for an Assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
body | object[] | Yes | — | Request body |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the queue."
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of media Types in which the assistant is activated for this queue."
},
"assistant": {
"type": "object",
"description": "The assistant value"
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date when the assistant queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"format": "date-time",
"description": "Date when the assistant queue was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"id",
"mediaTypes"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"assistantId",
"body"
]
}
genesys-agent-assistants_patch_users_agentui_agents_autoanswer_agent_id_settings
Update agent auto answer settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentId | string | Yes | — | The agent to apply the auto answer settings to |
settings | object | Yes | — | Map of conversation media type enabled status. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent to apply the auto answer settings to"
},
"settings": {
"type": "object",
"description": "Map of conversation media type enabled status."
}
},
"required": [
"PCID",
"agentId",
"settings"
]
}
genesys-agent-assistants_post_agentchecklists
Create an agent checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklistItems | object[] | Yes | — | Agent Checklist Items. |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the agent checklist was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the agent checklist was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | No | — | Agent Checklist ID. |
language | string | Yes | — | Agent Checklist Language. |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | Agent Checklist Name. |
selfUri | string | No | — | The URI for this object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"checklistItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the checklist item."
},
"name": {
"type": "string",
"description": "Name of the checklist item."
},
"description": {
"type": "string",
"description": "Description of the checklist item."
},
"automatedCheckEnabled": {
"type": "boolean",
"description": "Flag to indicate whether automated check is enabled for this checklist item."
},
"exactPhraseMatch": {
"type": "boolean",
"description": "Flag to indicate whether exact phrase matching is applicable for this checklist item."
},
"important": {
"type": "boolean",
"description": "Flag to indicate whether this checklist item is marked as important."
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"description": "Agent Checklist Items."
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the agent checklist was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the agent checklist was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "Agent Checklist ID."
},
"language": {
"type": "string",
"description": "Agent Checklist Language."
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "Agent Checklist Name."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"checklistItems",
"language",
"name"
]
}
genesys-agent-assistants_post_assistant_queue_users_bulk_add
Bulk add users to assistant-queue (requires manual assignment mode). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
entities | object[] | Yes | — | List of users to assign assistant for. Maximum users to add is 100 per request. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the user."
}
},
"required": [
"id"
]
},
"description": "List of users to assign assistant for. Maximum users to add is 100 per request."
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"entities"
]
}
genesys-agent-assistants_post_assistant_queue_users_bulk_remove
Bulk remove users from assistant-queue (requires manual assignment mode). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
entities | object[] | Yes | — | List of users to de-assign assistant form. Maximum users to remove is 100 per request. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the user."
}
},
"required": [
"id"
]
},
"description": "List of users to de-assign assistant form. Maximum users to remove is 100 per request."
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"entities"
]
}
genesys-agent-assistants_post_assistant_queue_users_jobs
Start a new job to assistant-queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
action | string | Yes | — | Action to perform by the job. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"action": {
"type": "string",
"description": "Action to perform by the job.",
"enum": [
"AutoAssignment",
"ManualAssignment"
]
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"action"
]
}
genesys-agent-assistants_post_assistant_queue_users_query
Query for users in the assistant-queue (requires manual assignment mode). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
expand | string[] | No | — | Which fields, if any, to expand with. |
entities | object[] | Yes | — | List of users to query. Maximum users to query is 100 per request. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"assistant",
"copilot"
]
},
"description": "Which fields, if any, to expand with."
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the user."
}
},
"required": [
"id"
]
},
"description": "List of users to query. Maximum users to query is 100 per request."
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"entities"
]
}
genesys-agent-assistants_post_assistant_variations
Create assistant copilot variation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
copilot | object | Yes | — | The copilot value |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
googleDialogflowConfig | object | No | — | Google Dialogflow Config |
id | string | No | — | The globally unique identifier for the object. |
knowledgeSuggestionConfig | object | No | — | Knowledge Suggestion Config |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | The name of the assistant that will assist the agent. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | State of the assistant. |
transcriptionConfig | object | Yes | — | Transcription Config |
variationParent | object | No | — | Variation Parent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"copilot": {
"type": "object",
"description": "The copilot value",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot is enabled."
},
"liveOnQueue": {
"type": "boolean",
"description": "Copilot is live on selected queue."
},
"defaultLanguage": {
"type": "string",
"description": "Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."
},
"knowledgeAnswerConfig": {
"type": "object",
"description": "Knowledge Answer Config"
},
"summaryGenerationConfig": {
"type": "object",
"description": "Summary Generation Config"
},
"wrapupCodePredictionConfig": {
"type": "object",
"description": "Wrapup Code Prediction Config"
},
"answerGenerationConfig": {
"type": "object",
"description": "Answer Generation Config"
},
"nluEngineType": {
"type": "string",
"description": "Language understanding engine type.",
"enum": [
"NluV3"
]
},
"nluConfig": {
"type": "object",
"description": "Nlu Config"
},
"ruleEngineConfig": {
"type": "object",
"description": "Rule Engine Config"
},
"autoSearchConfig": {
"type": "object",
"description": "Auto Search Config"
},
"manualSearchConfig": {
"type": "object",
"description": "Manual Search Config"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"defaultLanguage",
"liveOnQueue"
]
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"googleDialogflowConfig": {
"type": "object",
"description": "Google Dialogflow Config",
"properties": {
"integrationId": {
"type": "string",
"description": "The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."
},
"conversationProfiles": {
"type": "array",
"items": {
"type": "object"
},
"description": "The conversation profiles for which the assistant will fetch transcription and knowledge suggestions."
}
},
"required": [
"conversationProfiles"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"knowledgeSuggestionConfig": {
"type": "object",
"description": "Knowledge Suggestion Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of vendor used for knowledge suggestions.",
"enum": [
"GoogleDialogflow",
"GenesysKnowledge",
"GenesysKnowledgeV3",
"Unknown"
]
},
"knowledgeBase": {
"type": "object",
"description": "Knowledge Base"
},
"knowledgeBases": {
"type": "array",
"items": {
"type": "object"
},
"description": "The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider."
},
"receiveSegmentedArticles": {
"type": "boolean",
"description": "Include segmented articles in knowledge suggestions."
}
},
"required": [
"vendorName"
]
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name of the assistant that will assist the agent."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "State of the assistant.",
"enum": [
"Active",
"Inactive"
]
},
"transcriptionConfig": {
"type": "object",
"description": "Transcription Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of the vendor used for speech transcription.",
"enum": [
"GoogleDialogflow",
"Unknown",
"Genesys"
]
}
},
"required": [
"vendorName"
]
},
"variationParent": {
"type": "object",
"description": "Variation Parent",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"assistantId",
"copilot",
"name",
"transcriptionConfig"
]
}
genesys-agent-assistants_post_assistants
Create an Assistant. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
copilot | object | No | — | The copilot value |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
googleDialogflowConfig | object | No | — | Google Dialogflow Config |
id | string | No | — | The globally unique identifier for the object. |
knowledgeSuggestionConfig | object | No | — | Knowledge Suggestion Config |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | The name of the assistant that will assist the agent. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | State of the assistant. |
transcriptionConfig | object | Yes | — | Transcription Config |
variationParent | object | No | — | Variation Parent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"copilot": {
"type": "object",
"description": "The copilot value",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot is enabled."
},
"liveOnQueue": {
"type": "boolean",
"description": "Copilot is live on selected queue."
},
"defaultLanguage": {
"type": "string",
"description": "Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."
},
"knowledgeAnswerConfig": {
"type": "object",
"description": "Knowledge Answer Config"
},
"summaryGenerationConfig": {
"type": "object",
"description": "Summary Generation Config"
},
"wrapupCodePredictionConfig": {
"type": "object",
"description": "Wrapup Code Prediction Config"
},
"answerGenerationConfig": {
"type": "object",
"description": "Answer Generation Config"
},
"nluEngineType": {
"type": "string",
"description": "Language understanding engine type.",
"enum": [
"NluV3"
]
},
"nluConfig": {
"type": "object",
"description": "Nlu Config"
},
"ruleEngineConfig": {
"type": "object",
"description": "Rule Engine Config"
},
"autoSearchConfig": {
"type": "object",
"description": "Auto Search Config"
},
"manualSearchConfig": {
"type": "object",
"description": "Manual Search Config"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"defaultLanguage",
"liveOnQueue"
]
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"googleDialogflowConfig": {
"type": "object",
"description": "Google Dialogflow Config",
"properties": {
"integrationId": {
"type": "string",
"description": "The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."
},
"conversationProfiles": {
"type": "array",
"items": {
"type": "object"
},
"description": "The conversation profiles for which the assistant will fetch transcription and knowledge suggestions."
}
},
"required": [
"conversationProfiles"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"knowledgeSuggestionConfig": {
"type": "object",
"description": "Knowledge Suggestion Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of vendor used for knowledge suggestions.",
"enum": [
"GoogleDialogflow",
"GenesysKnowledge",
"GenesysKnowledgeV3",
"Unknown"
]
},
"knowledgeBase": {
"type": "object",
"description": "Knowledge Base"
},
"knowledgeBases": {
"type": "array",
"items": {
"type": "object"
},
"description": "The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider."
},
"receiveSegmentedArticles": {
"type": "boolean",
"description": "Include segmented articles in knowledge suggestions."
}
},
"required": [
"vendorName"
]
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name of the assistant that will assist the agent."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "State of the assistant.",
"enum": [
"Active",
"Inactive"
]
},
"transcriptionConfig": {
"type": "object",
"description": "Transcription Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of the vendor used for speech transcription.",
"enum": [
"GoogleDialogflow",
"Unknown",
"Genesys"
]
}
},
"required": [
"vendorName"
]
},
"variationParent": {
"type": "object",
"description": "Variation Parent",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"name",
"transcriptionConfig"
]
}
genesys-agent-assistants_put_agentchecklist
Update an agent checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentChecklistId | string | Yes | — | Agent Checklist ID |
checklistItems | object[] | Yes | — | Agent Checklist Items. |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the agent checklist was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the agent checklist was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | No | — | Agent Checklist ID. |
language | string | Yes | — | Agent Checklist Language. |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | Agent Checklist Name. |
selfUri | string | No | — | The URI for this object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentChecklistId": {
"type": "string",
"description": "Agent Checklist ID"
},
"checklistItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the checklist item."
},
"name": {
"type": "string",
"description": "Name of the checklist item."
},
"description": {
"type": "string",
"description": "Description of the checklist item."
},
"automatedCheckEnabled": {
"type": "boolean",
"description": "Flag to indicate whether automated check is enabled for this checklist item."
},
"exactPhraseMatch": {
"type": "boolean",
"description": "Flag to indicate whether exact phrase matching is applicable for this checklist item."
},
"important": {
"type": "boolean",
"description": "Flag to indicate whether this checklist item is marked as important."
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"description": "Agent Checklist Items."
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the agent checklist was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the agent checklist was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "Agent Checklist ID."
},
"language": {
"type": "string",
"description": "Agent Checklist Language."
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "Agent Checklist Name."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"agentChecklistId",
"checklistItems",
"language",
"name"
]
}
genesys-agent-assistants_put_assistant_copilot
Update agent copilot configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
answerGenerationConfig | object | No | — | Answer Generation Config |
autoSearchConfig | object | No | — | Auto Search Config |
defaultLanguage | string | Yes | — | Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified. |
enabled | boolean | No | — | Copilot is enabled. |
knowledgeAnswerConfig | object | No | — | Knowledge Answer Config |
liveOnQueue | boolean | Yes | — | Copilot is live on selected queue. |
manualSearchConfig | object | No | — | Manual Search Config |
nluConfig | object | No | — | Nlu Config |
nluEngineType | string | No | — | Language understanding engine type. |
ruleEngineConfig | object | No | — | Rule Engine Config |
selfUri | string | No | — | The URI for this object |
summaryGenerationConfig | object | No | — | Summary Generation Config |
wrapupCodePredictionConfig | object | No | — | Wrapup Code Prediction Config |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"answerGenerationConfig": {
"type": "object",
"description": "Answer Generation Config",
"properties": {
"enabled": {
"type": "boolean",
"description": "Answer generation is enabled."
}
},
"required": [
"enabled"
]
},
"autoSearchConfig": {
"type": "object",
"description": "Auto Search Config",
"properties": {
"type": {
"type": "string",
"description": "Auto search configuration type.",
"enum": [
"ArticlesOnly",
"ArticlesWithAnswerHighlights",
"AnswerGeneration"
]
}
}
},
"defaultLanguage": {
"type": "string",
"description": "Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."
},
"enabled": {
"type": "boolean",
"description": "Copilot is enabled."
},
"knowledgeAnswerConfig": {
"type": "object",
"description": "Knowledge Answer Config",
"properties": {
"enabled": {
"type": "boolean",
"description": "Knowledge answer is enabled."
}
},
"required": [
"enabled"
]
},
"liveOnQueue": {
"type": "boolean",
"description": "Copilot is live on selected queue."
},
"manualSearchConfig": {
"type": "object",
"description": "Manual Search Config",
"properties": {
"articlesWithAnswerHighlights": {
"type": "boolean",
"description": "Articles with answer highlights."
},
"answerGeneration": {
"type": "boolean",
"description": "Answer generation."
}
}
},
"nluConfig": {
"type": "object",
"description": "Nlu Config",
"properties": {
"domain": {
"type": "object",
"description": "The domain value"
},
"intentConfidenceThreshold": {
"type": "number",
"description": "Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1."
}
},
"required": [
"domain",
"intentConfidenceThreshold"
]
},
"nluEngineType": {
"type": "string",
"description": "Language understanding engine type.",
"enum": [
"NluV3"
]
},
"ruleEngineConfig": {
"type": "object",
"description": "Rule Engine Config",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of rules to evaluate by the engine."
},
"fallback": {
"type": "object",
"description": "The fallback value"
}
},
"required": [
"rules"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"summaryGenerationConfig": {
"type": "object",
"description": "Summary Generation Config",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot generated summary is enabled."
},
"summarySetting": {
"type": "object",
"description": "Summary Setting"
},
"retentionSeconds": {
"type": "integer",
"description": "Summary retention time in seconds. Can only be modified on the parent assistant."
},
"onDemandSummaryConfig": {
"type": "object",
"description": "On Demand Summary Config"
},
"modelConfig": {
"type": "object",
"description": "Model Config"
}
},
"required": [
"enabled"
]
},
"wrapupCodePredictionConfig": {
"type": "object",
"description": "Wrapup Code Prediction Config",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot generated wrapup code prediction is enabled."
}
},
"required": [
"enabled"
]
}
},
"required": [
"PCID",
"assistantId",
"defaultLanguage",
"liveOnQueue"
]
}
genesys-agent-assistants_put_assistant_queue
Create a queue assistant association. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
queueId | string | Yes | — | Queue ID |
assistant | object | No | — | The assistant value |
dateCreated | string | No | — | Date when the assistant queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the assistant queue was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | Yes | — | The globally unique identifier for the queue. |
mediaTypes | string[] | Yes | — | List of media Types in which the assistant is activated for this queue. |
selfUri | string | No | — | The URI for this object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"assistant": {
"type": "object",
"description": "The assistant value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the assistant that will assist the agent."
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"modifiedBy": {
"type": "object",
"description": "Modified By"
},
"googleDialogflowConfig": {
"type": "object",
"description": "Google Dialogflow Config"
},
"transcriptionConfig": {
"type": "object",
"description": "Transcription Config"
},
"knowledgeSuggestionConfig": {
"type": "object",
"description": "Knowledge Suggestion Config"
},
"state": {
"type": "string",
"description": "State of the assistant.",
"enum": [
"Active",
"Inactive"
]
},
"copilot": {
"type": "object",
"description": "The copilot value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"variationParent": {
"type": "object",
"description": "Variation Parent"
}
},
"required": [
"name",
"transcriptionConfig"
]
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant queue was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the queue."
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Call",
"Email",
"Message"
]
},
"description": "List of media Types in which the assistant is activated for this queue."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"assistantId",
"queueId",
"id",
"mediaTypes"
]
}
genesys-agent-assistants_put_assistant_variation
Update assistant copilot variation by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assistantId | string | Yes | — | Assistant ID |
variationId | string | Yes | — | Variation ID |
copilot | object | Yes | — | The copilot value |
createdBy | object | No | — | Created By |
dateCreated | string | No | — | Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
googleDialogflowConfig | object | No | — | Google Dialogflow Config |
id | string | No | — | The globally unique identifier for the object. |
knowledgeSuggestionConfig | object | No | — | Knowledge Suggestion Config |
modifiedBy | object | No | — | Modified By |
name | string | Yes | — | The name of the assistant that will assist the agent. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | State of the assistant. |
transcriptionConfig | object | Yes | — | Transcription Config |
variationParent | object | No | — | Variation Parent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assistantId": {
"type": "string",
"description": "Assistant ID"
},
"variationId": {
"type": "string",
"description": "Variation ID"
},
"copilot": {
"type": "object",
"description": "The copilot value",
"properties": {
"enabled": {
"type": "boolean",
"description": "Copilot is enabled."
},
"liveOnQueue": {
"type": "boolean",
"description": "Copilot is live on selected queue."
},
"defaultLanguage": {
"type": "string",
"description": "Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."
},
"knowledgeAnswerConfig": {
"type": "object",
"description": "Knowledge Answer Config"
},
"summaryGenerationConfig": {
"type": "object",
"description": "Summary Generation Config"
},
"wrapupCodePredictionConfig": {
"type": "object",
"description": "Wrapup Code Prediction Config"
},
"answerGenerationConfig": {
"type": "object",
"description": "Answer Generation Config"
},
"nluEngineType": {
"type": "string",
"description": "Language understanding engine type.",
"enum": [
"NluV3"
]
},
"nluConfig": {
"type": "object",
"description": "Nlu Config"
},
"ruleEngineConfig": {
"type": "object",
"description": "Rule Engine Config"
},
"autoSearchConfig": {
"type": "object",
"description": "Auto Search Config"
},
"manualSearchConfig": {
"type": "object",
"description": "Manual Search Config"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"defaultLanguage",
"liveOnQueue"
]
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateCreated": {
"type": "string",
"description": "Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the assistant was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"googleDialogflowConfig": {
"type": "object",
"description": "Google Dialogflow Config",
"properties": {
"integrationId": {
"type": "string",
"description": "The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."
},
"conversationProfiles": {
"type": "array",
"items": {
"type": "object"
},
"description": "The conversation profiles for which the assistant will fetch transcription and knowledge suggestions."
}
},
"required": [
"conversationProfiles"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"knowledgeSuggestionConfig": {
"type": "object",
"description": "Knowledge Suggestion Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of vendor used for knowledge suggestions.",
"enum": [
"GoogleDialogflow",
"GenesysKnowledge",
"GenesysKnowledgeV3",
"Unknown"
]
},
"knowledgeBase": {
"type": "object",
"description": "Knowledge Base"
},
"knowledgeBases": {
"type": "array",
"items": {
"type": "object"
},
"description": "The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider."
},
"receiveSegmentedArticles": {
"type": "boolean",
"description": "Include segmented articles in knowledge suggestions."
}
},
"required": [
"vendorName"
]
},
"modifiedBy": {
"type": "object",
"description": "Modified By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"name": {
"type": "string",
"description": "The name of the assistant that will assist the agent."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "State of the assistant.",
"enum": [
"Active",
"Inactive"
]
},
"transcriptionConfig": {
"type": "object",
"description": "Transcription Config",
"properties": {
"vendorName": {
"type": "string",
"description": "The name of the vendor used for speech transcription.",
"enum": [
"GoogleDialogflow",
"Unknown",
"Genesys"
]
}
},
"required": [
"vendorName"
]
},
"variationParent": {
"type": "object",
"description": "Variation Parent",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
}
},
"required": [
"PCID",
"assistantId",
"variationId",
"copilot",
"name",
"transcriptionConfig"
]
}
genesys-agent-assistants_put_users_agentui_agents_autoanswer_agent_id_settings
Set agent auto answer settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentId | string | Yes | — | The agent to apply the auto answer settings to |
settings | object | Yes | — | Map of conversation media type enabled status. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent to apply the auto answer settings to"
},
"settings": {
"type": "object",
"description": "Map of conversation media type enabled status."
}
},
"required": [
"PCID",
"agentId",
"settings"
]
}

