/genesys-intents | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
genesys-intents_delete_category | Delete category for categoryId |
genesys-intents_delete_customerintent | Delete customer intent for customerIntentId |
genesys-intents_get_assignments_externalcontact | Get customer intent assignments for externalContactId |
genesys-intents_get_categories | Get categories |
genesys-intents_get_category | Get category for categoryId |
genesys-intents_get_customerintent | Get customer intent for customerIntentId |
genesys-intents_get_customerintent_sourceintents | Get source intents mapped to a customer intent |
genesys-intents_get_customerintents | Get customer intents |
genesys-intents_get_sourceintents | Get all mapped source intents by type. If no type selected default is type Segment |
genesys-intents_patch_category | Patch category for categoryId |
genesys-intents_patch_customerintent | Patch customer intent for customerIntentId |
genesys-intents_post_categories | Create category |
genesys-intents_post_customerintent_sourceintents_bulk_add | Bulk add source intents to a customer intent |
genesys-intents_post_customerintent_sourceintents_bulk_remove | Bulk remove source intents mapped to a customer intent |
genesys-intents_post_customerintents | Create customer intents |
genesys-intents_post_externalcontact_intent_assignment | Create customer intent assignment for external contact |
genesys-intents_delete_category
Delete category for categoryId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId | string | Yes | — | Category id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryId": {
"type": "string",
"description": "Category id"
}
},
"required": [
"PCID",
"categoryId"
]
}
genesys-intents_delete_customerintent
Delete customer intent for customerIntentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
}
},
"required": [
"PCID",
"customerIntentId"
]
}
genesys-intents_get_assignments_externalcontact
Get customer intent assignments for externalContactId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalContactId | string | Yes | — | External Contact id |
pageSize | integer | No | — | The total page size requested |
pageNumber | integer | No | — | The page number requested |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalContactId": {
"type": "string",
"description": "External Contact id"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
}
},
"required": [
"PCID",
"externalContactId"
]
}
genesys-intents_get_categories
Get categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The total page size requested |
pageNumber | integer | No | — | The page number requested |
queryValue | string | No | — | Search query value to filter results by |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"queryValue": {
"type": "string",
"description": "Search query value to filter results by"
}
},
"required": [
"PCID"
]
}
genesys-intents_get_category
Get category for categoryId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId | string | Yes | — | Category id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryId": {
"type": "string",
"description": "Category id"
}
},
"required": [
"PCID",
"categoryId"
]
}
genesys-intents_get_customerintent
Get customer intent for customerIntentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
}
},
"required": [
"PCID",
"customerIntentId"
]
}
genesys-intents_get_customerintent_sourceintents
Get source intents mapped to a customer intent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
pageSize | integer | No | — | The total page size requested |
pageNumber | integer | No | — | The page number requested |
queryValue | string | No | — | Search query value to filter results by |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"queryValue": {
"type": "string",
"description": "Search query value to filter results by"
}
},
"required": [
"PCID",
"customerIntentId"
]
}
genesys-intents_get_customerintents
Get customer intents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The total page size requested |
pageNumber | integer | No | — | The page number requested |
queryValue | string | No | — | Search query value to filter results by |
categoryId | string | No | — | CategoryId to filter query by |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"queryValue": {
"type": "string",
"description": "Search query value to filter results by"
},
"categoryId": {
"type": "string",
"description": "CategoryId to filter query by"
}
},
"required": [
"PCID"
]
}
genesys-intents_get_sourceintents
Get all mapped source intents by type. If no type selected default is type Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The total page size requested |
pageNumber | integer | No | — | The page number requested |
type | string | No | — | Source Type to query by. If none selected default response will be for type Segment. |
sourceId | string | No | — | Source Id to query by. Only required for sourceType: Copilot, Bot, Digitalbot |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"type": {
"type": "string",
"description": "Source Type to query by. If none selected default response will be for type Segment.",
"enum": [
"Bot",
"Copilot",
"Digitalbot",
"Segment",
"Topic",
"Unknown"
]
},
"sourceId": {
"type": "string",
"description": "Source Id to query by. Only required for sourceType: Copilot, Bot, Digitalbot"
}
},
"required": [
"PCID"
]
}
genesys-intents_patch_category
Patch category for categoryId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId | string | Yes | — | Category id |
description | string | No | — | Description of the category |
id | string | No | — | The globally unique identifier for the object. |
name | string | No | — | The name value |
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"
},
"categoryId": {
"type": "string",
"description": "Category id"
},
"description": {
"type": "string",
"description": "Description of the category"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"categoryId"
]
}
genesys-intents_patch_customerintent
Patch customer intent for customerIntentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
categoryId | string | No | — | CategoryId of the customer intent |
description | string | No | — | Description of the customer intent |
expiryTime | integer | No | — | Expiry time in hours of the customer intent |
id | string | No | — | The globally unique identifier for the object. |
name | string | No | — | The name value |
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"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
},
"categoryId": {
"type": "string",
"description": "CategoryId of the customer intent"
},
"description": {
"type": "string",
"description": "Description of the customer intent"
},
"expiryTime": {
"type": "integer",
"description": "Expiry time in hours of the customer intent"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"customerIntentId"
]
}
genesys-intents_post_categories
Create category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateCreated | string | No | — | Creation date of the category. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | Yes | — | Description of the category |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | Name of the category |
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"
},
"dateCreated": {
"type": "string",
"description": "Creation date of the category. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "Description of the category"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "Name of the category"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"description",
"name"
]
}
genesys-intents_post_customerintent_sourceintents_bulk_add
Bulk add source intents to a customer intent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
items | object[] | Yes | — | List of items to add |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceIntentId": {
"type": "string",
"description": "Id of the source intent"
},
"sourceIntentName": {
"type": "string",
"description": "Name of the source intent"
},
"sourceType": {
"type": "string",
"enum": [
"Bot",
"Copilot",
"Digitalbot",
"Segment",
"Topic",
"Unknown"
],
"description": "Source type"
},
"sourceId": {
"type": "string",
"description": "Id of the source"
},
"sourceName": {
"type": "string",
"description": "Name of the source"
}
}
},
"description": "List of items to add"
}
},
"required": [
"PCID",
"customerIntentId",
"items"
]
}
genesys-intents_post_customerintent_sourceintents_bulk_remove
Bulk remove source intents mapped to a customer intent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | Customer Intent id |
items | string[] | Yes | — | List of ids to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ids to delete"
}
},
"required": [
"PCID",
"customerIntentId",
"items"
]
}
genesys-intents_post_customerintents
Create customer intents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId | string | Yes | — | CategoryId of the customer intent |
description | string | Yes | — | Description of the customer intent |
expiryTime | integer | Yes | — | Expiry time in hours of the customer intent |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | Name of the customer intent |
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"
},
"categoryId": {
"type": "string",
"description": "CategoryId of the customer intent"
},
"description": {
"type": "string",
"description": "Description of the customer intent"
},
"expiryTime": {
"type": "integer",
"description": "Expiry time in hours of the customer intent"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "Name of the customer intent"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"categoryId",
"description",
"expiryTime",
"name"
]
}
genesys-intents_post_externalcontact_intent_assignment
Create customer intent assignment for external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalContactId | string | Yes | — | External Contact id |
customerIntentId | string | Yes | — | Customer Intent id |
conversationId | string | No | — | Id of conversation assignment occurred in |
sessionId | string | No | — | Id of session assignment occurred in |
sourceId | string | No | — | Id of the source of assignment |
sourceType | string | No | — | Type of source of assignment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalContactId": {
"type": "string",
"description": "External Contact id"
},
"customerIntentId": {
"type": "string",
"description": "Customer Intent id"
},
"conversationId": {
"type": "string",
"description": "Id of conversation assignment occurred in"
},
"sessionId": {
"type": "string",
"description": "Id of session assignment occurred in"
},
"sourceId": {
"type": "string",
"description": "Id of the source of assignment"
},
"sourceType": {
"type": "string",
"description": "Type of source of assignment",
"enum": [
"Bot",
"Case",
"Copilot",
"Digitalbot",
"Segment",
"Topic",
"Unknown"
]
}
},
"required": [
"PCID",
"externalContactId",
"customerIntentId"
]
}