> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# genesys-integrations
> Genesys Integrations - integration lifecycle (CRUD, types, config, credentials), data actions (create, draft, publish, test, execute, function upload), bot connectors, speech engine config, unified communications, and webhooks
**Server path:** `/genesys-integrations` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`genesys-integrations_delete_credential`](#genesys-integrations_delete_credential) | Delete a set of credentials |
| [`genesys-integrations_delete_integration`](#genesys-integrations_delete_integration) | Delete integration. |
| [`genesys-integrations_get_action`](#genesys-integrations_get_action) | Retrieves a single Action matching id. |
| [`genesys-integrations_get_action_draft`](#genesys-integrations_get_action_draft) | Retrieve a Draft |
| [`genesys-integrations_get_action_draft_function`](#genesys-integrations_get_action_draft_function) | Get draft function settings for Action |
| [`genesys-integrations_get_action_draft_schema`](#genesys-integrations_get_action_draft_schema) | Retrieve schema for a Draft based on filename. |
| [`genesys-integrations_get_action_draft_template`](#genesys-integrations_get_action_draft_template) | Retrieve templates for a Draft based on filename. |
| [`genesys-integrations_get_action_draft_validation`](#genesys-integrations_get_action_draft_validation) | Validate current Draft configuration. |
| [`genesys-integrations_get_action_function`](#genesys-integrations_get_action_function) | Get published function settings for Action |
| [`genesys-integrations_get_action_schema`](#genesys-integrations_get_action_schema) | Retrieve schema for an action based on filename. |
| [`genesys-integrations_get_action_template`](#genesys-integrations_get_action_template) | Retrieve text of templates for an action based on filename. |
| [`genesys-integrations_get_actions`](#genesys-integrations_get_actions) | Retrieves all actions associated with filters passed in via query param. |
| [`genesys-integrations_get_actions_categories`](#genesys-integrations_get_actions_categories) | Retrieves all categories of available Actions |
| [`genesys-integrations_get_actions_certificates`](#genesys-integrations_get_actions_certificates) | Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress. |
| [`genesys-integrations_get_actions_certificates_truststore`](#genesys-integrations_get_actions_certificates_truststore) | Retrieves basic info about trusted root CA certificates |
| [`genesys-integrations_get_actions_drafts`](#genesys-integrations_get_actions_drafts) | Retrieves all action drafts associated with the filters passed in via query param. |
| [`genesys-integrations_get_actions_functions_runtimes`](#genesys-integrations_get_actions_functions_runtimes) | Get action function settings for Action |
| [`genesys-integrations_get_botconnector_integration_id_bot`](#genesys-integrations_get_botconnector_integration_id_bot) | Get a specific botConnector bot, plus versions, for this integration |
| [`genesys-integrations_get_botconnector_integration_id_bot_versions`](#genesys-integrations_get_botconnector_integration_id_bot_versions) | Get a list of bot versions for a bot |
| [`genesys-integrations_get_botconnector_integration_id_bots`](#genesys-integrations_get_botconnector_integration_id_bots) | Get a list of botConnector bots for this integration |
| [`genesys-integrations_get_botconnector_integration_id_bots_summaries`](#genesys-integrations_get_botconnector_integration_id_bots_summaries) | Get a summary list of botConnector bots for this integration |
| [`genesys-integrations_get_clientapps`](#genesys-integrations_get_clientapps) | List permitted client app integrations for the logged in user |
| [`genesys-integrations_get_credential`](#genesys-integrations_get_credential) | Get a single credential with sensitive fields redacted |
| [`genesys-integrations_get_credentials_listing`](#genesys-integrations_get_credentials_listing) | List multiple sets of credentials using cursor-based paging |
| [`genesys-integrations_get_credentials_types`](#genesys-integrations_get_credentials_types) | List all credential types |
| [`genesys-integrations_get_integration`](#genesys-integrations_get_integration) | Get integration. |
| [`genesys-integrations_get_integration_config_current`](#genesys-integrations_get_integration_config_current) | Get integration configuration. |
| [`genesys-integrations_get_integrations`](#genesys-integrations_get_integrations) | List integrations |
| [`genesys-integrations_get_speech_audioconnector`](#genesys-integrations_get_speech_audioconnector) | Get a list of Audio Connector integrations |
| [`genesys-integrations_get_speech_audioconnector_integration_id`](#genesys-integrations_get_speech_audioconnector_integration_id) | Get an Audio Connector integration |
| [`genesys-integrations_get_speech_dialogflow_agent`](#genesys-integrations_get_speech_dialogflow_agent) | Get details about a Dialogflow agent |
| [`genesys-integrations_get_speech_dialogflow_agents`](#genesys-integrations_get_speech_dialogflow_agents) | Get a list of Dialogflow agents in the customers' Google accounts |
| [`genesys-integrations_get_speech_dialogflowcx_agent`](#genesys-integrations_get_speech_dialogflowcx_agent) | Get details about a Dialogflow CX agent |
| [`genesys-integrations_get_speech_dialogflowcx_agents`](#genesys-integrations_get_speech_dialogflowcx_agents) | Get a list of Dialogflow CX agents in the customers' Google accounts |
| [`genesys-integrations_get_speech_lex_bot_alias`](#genesys-integrations_get_speech_lex_bot_alias) | Get details about a Lex bot alias |
| [`genesys-integrations_get_speech_lex_bot_bot_id_aliases`](#genesys-integrations_get_speech_lex_bot_bot_id_aliases) | Get a list of aliases for a bot in the customer's AWS accounts |
| [`genesys-integrations_get_speech_lex_bots`](#genesys-integrations_get_speech_lex_bots) | Get a list of Lex bots in the customers' AWS accounts |
| [`genesys-integrations_get_speech_lexv2bot_alias`](#genesys-integrations_get_speech_lexv2bot_alias) | Get details about a Lex V2 bot alias |
| [`genesys-integrations_get_speech_lexv2bot_bot_id_aliases`](#genesys-integrations_get_speech_lexv2bot_bot_id_aliases) | Get a list of aliases for a Lex V2 bot |
| [`genesys-integrations_get_speech_lexv2bots`](#genesys-integrations_get_speech_lexv2bots) | Get a list of Lex V2 bots |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bot`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bot) | Get a Nuance bot in the specified Integration |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bot_job`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bot_job) | Get the status of an asynchronous Nuance bot GET job |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bot_job_results`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bot_job_results) | Get the result of an asynchronous Nuance bot GET job |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bots`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bots) | Get a list of Nuance bots available in the specified Integration |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bots_job`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bots_job) | Get the status of an asynchronous Nuance bots GET job |
| [`genesys-integrations_get_speech_nuance_nuance_integration_id_bots_job_results`](#genesys-integrations_get_speech_nuance_nuance_integration_id_bots_job_results) | Get the result of an asynchronous Nuance bots GET job |
| [`genesys-integrations_get_speech_stt_engine`](#genesys-integrations_get_speech_stt_engine) | Get details about a STT engine |
| [`genesys-integrations_get_speech_stt_engines`](#genesys-integrations_get_speech_stt_engines) | Get a list of STT engines enabled for org |
| [`genesys-integrations_get_speech_tts_engine`](#genesys-integrations_get_speech_tts_engine) | Get details about a TTS engine |
| [`genesys-integrations_get_speech_tts_engine_voice`](#genesys-integrations_get_speech_tts_engine_voice) | Get details about a specific voice for a TTS engine |
| [`genesys-integrations_get_speech_tts_engine_voices`](#genesys-integrations_get_speech_tts_engine_voices) | Get a list of voices for a TTS engine |
| [`genesys-integrations_get_speech_tts_engines`](#genesys-integrations_get_speech_tts_engines) | Get a list of TTS engines enabled for org |
| [`genesys-integrations_get_speech_tts_settings`](#genesys-integrations_get_speech_tts_settings) | Get TTS settings for an org |
| [`genesys-integrations_get_type`](#genesys-integrations_get_type) | Get integration type. |
| [`genesys-integrations_get_type_configschema`](#genesys-integrations_get_type_configschema) | Get properties config schema for an integration type. |
| [`genesys-integrations_get_types`](#genesys-integrations_get_types) | List integration types |
| [`genesys-integrations_get_unifiedcommunications_clientapp`](#genesys-integrations_get_unifiedcommunications_clientapp) | UC integration client application configuration. |
| [`genesys-integrations_get_unifiedcommunications_clientapps`](#genesys-integrations_get_unifiedcommunications_clientapps) | List UC integration client application configurations. |
| [`genesys-integrations_get_userapps`](#genesys-integrations_get_userapps) | List permitted user app integrations for the logged in user |
| [`genesys-integrations_patch_action`](#genesys-integrations_patch_action) | Patch an Action |
| [`genesys-integrations_patch_action_draft`](#genesys-integrations_patch_action_draft) | Update an existing Draft |
| [`genesys-integrations_patch_integration`](#genesys-integrations_patch_integration) | Update an integration. |
| [`genesys-integrations_post_action_draft`](#genesys-integrations_post_action_draft) | Create a new Draft from existing Action |
| [`genesys-integrations_post_action_draft_function_upload`](#genesys-integrations_post_action_draft_function_upload) | Create upload presigned URL for draft function package file. |
| [`genesys-integrations_post_action_draft_publish`](#genesys-integrations_post_action_draft_publish) | Publish a Draft and make it the active Action configuration |
| [`genesys-integrations_post_action_draft_test`](#genesys-integrations_post_action_draft_test) | Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging. |
| [`genesys-integrations_post_action_execute`](#genesys-integrations_post_action_execute) | Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error. |
| [`genesys-integrations_post_action_test`](#genesys-integrations_post_action_test) | Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging. |
| [`genesys-integrations_post_actions`](#genesys-integrations_post_actions) | Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action. |
| [`genesys-integrations_post_actions_drafts`](#genesys-integrations_post_actions_drafts) | Create a new Draft |
| [`genesys-integrations_post_credentials`](#genesys-integrations_post_credentials) | Create a set of credentials |
| [`genesys-integrations_post_integrations`](#genesys-integrations_post_integrations) | Create an integration. |
| [`genesys-integrations_post_speech_nuance_nuance_integration_id_bot_jobs`](#genesys-integrations_post_speech_nuance_nuance_integration_id_bot_jobs) | Get a Nuance bot in the specified Integration asynchronously |
| [`genesys-integrations_post_speech_nuance_nuance_integration_id_bots_jobs`](#genesys-integrations_post_speech_nuance_nuance_integration_id_bots_jobs) | Get a list of Nuance bots in the specified Integration asynchronously |
| [`genesys-integrations_post_speech_nuance_nuance_integration_id_bots_launch_validate`](#genesys-integrations_post_speech_nuance_nuance_integration_id_bots_launch_validate) | Try out a single credential for a Nuance bot to know if the secret is correct |
| [`genesys-integrations_post_webhook_events`](#genesys-integrations_post_webhook_events) | Invoke Webhook |
| [`genesys-integrations_put_action_draft_function`](#genesys-integrations_put_action_draft_function) | Update draft function settings. |
| [`genesys-integrations_put_botconnector_integration_id_bots`](#genesys-integrations_put_botconnector_integration_id_bots) | Set a list of botConnector bots plus versions for this integration |
| [`genesys-integrations_put_credential`](#genesys-integrations_put_credential) | Update a set of credentials |
| [`genesys-integrations_put_integration_config_current`](#genesys-integrations_put_integration_config_current) | Update integration configuration. |
| [`genesys-integrations_put_speech_nuance_nuance_integration_id_bots_launch_settings`](#genesys-integrations_put_speech_nuance_nuance_integration_id_bots_launch_settings) | Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration |
| [`genesys-integrations_put_speech_tts_settings`](#genesys-integrations_put_speech_tts_settings) | Update TTS settings for an org |
| [`genesys-integrations_put_unifiedcommunication_thirdpartypresences`](#genesys-integrations_put_unifiedcommunication_thirdpartypresences) | Bulk integration presence ingestion |
***
## genesys-integrations\_delete\_credential
Delete a set of credentials
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------- |
| `credentialId` | string | Yes | — | Credential ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"credentialId": {
"type": "string",
"description": "Credential ID"
}
},
"required": [
"PCID",
"credentialId"
]
}
```
***
## genesys-integrations\_delete\_integration
Delete integration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------- |
| `integrationId` | string | Yes | — | Integration Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "Integration Id"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_action
Retrieves a single Action matching id.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `expand` | string | No | — | Indicates a field in the response which should be expanded. |
| `flatten` | string | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
| `includeConfig` | string | No | — | Return config in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"expand": {
"type": "string",
"description": "Indicates a field in the response which should be expanded.",
"enum": [
"contract"
]
},
"flatten": {
"type": "string",
"description": "Indicates the response should be reformatted, based on Architect's flattening format.",
"enum": [
"true",
"false"
]
},
"includeConfig": {
"type": "string",
"description": "Return config in response.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_get\_action\_draft
Retrieve a Draft
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `expand` | string | No | — | Indicates a field in the response which should be expanded. |
| `flatten` | string | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
| `includeConfig` | string | No | — | Return config in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"expand": {
"type": "string",
"description": "Indicates a field in the response which should be expanded.",
"enum": [
"contract"
]
},
"flatten": {
"type": "string",
"description": "Indicates the response should be reformatted, based on Architect's flattening format.",
"enum": [
"true",
"false"
]
},
"includeConfig": {
"type": "string",
"description": "Return config in response.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_get\_action\_draft\_function
Get draft function settings for Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `actionId` | string | Yes | — | Action Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_get\_action\_draft\_schema
Retrieve schema for a Draft based on filename.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `fileName` | string | Yes | — | Name of schema file to be retrieved for this draft. |
| `flatten` | boolean | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"fileName": {
"type": "string",
"description": "Name of schema file to be retrieved for this draft."
},
"flatten": {
"type": "boolean",
"description": "Indicates the response should be reformatted, based on Architect's flattening format."
}
},
"required": [
"PCID",
"actionId",
"fileName"
]
}
```
***
## genesys-integrations\_get\_action\_draft\_template
Retrieve templates for a Draft based on filename.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `actionId` | string | Yes | — | Action Id |
| `fileName` | string | Yes | — | Name of template file to be retrieved for this action draft. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"fileName": {
"type": "string",
"description": "Name of template file to be retrieved for this action draft."
}
},
"required": [
"PCID",
"actionId",
"fileName"
]
}
```
***
## genesys-integrations\_get\_action\_draft\_validation
Validate current Draft configuration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `actionId` | string | Yes | — | Action Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_get\_action\_function
Get published function settings for Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `actionId` | string | Yes | — | Action Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_get\_action\_schema
Retrieve schema for an action based on filename.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `fileName` | string | Yes | — | Name of schema file to be retrieved for this action. |
| `flatten` | boolean | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"fileName": {
"type": "string",
"description": "Name of schema file to be retrieved for this action."
},
"flatten": {
"type": "boolean",
"description": "Indicates the response should be reformatted, based on Architect's flattening format."
}
},
"required": [
"PCID",
"actionId",
"fileName"
]
}
```
***
## genesys-integrations\_get\_action\_template
Retrieve text of templates for an action based on filename.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------ |
| `actionId` | string | Yes | — | Action Id |
| `fileName` | string | Yes | — | Name of template file to be retrieved for this action. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"fileName": {
"type": "string",
"description": "Name of template file to be retrieved for this action."
}
},
"required": [
"PCID",
"actionId",
"fileName"
]
}
```
***
## genesys-integrations\_get\_actions
Retrieves all actions associated with filters passed in via query param.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `sortBy` | string | No | — | Root level field name to sort on. |
| `sortOrder` | string | No | — | Direction to sort 'sortBy' field. |
| `category` | string | No | — | Filter by category name. |
| `name` | string | No | — | Filter by partial or complete action name. |
| `ids` | string | No | — | Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. |
| `secure` | string | No | — | Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. |
| `includeAuthActions` | string | No | — | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. |
| `includeConfig` | string | No | — | Return config in response. |
```json theme={null}
{
"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"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"sortBy": {
"type": "string",
"description": "Root level field name to sort on."
},
"sortOrder": {
"type": "string",
"description": "Direction to sort 'sortBy' field.",
"enum": [
"ASC",
"DESC"
]
},
"category": {
"type": "string",
"description": "Filter by category name."
},
"name": {
"type": "string",
"description": "Filter by partial or complete action name."
},
"ids": {
"type": "string",
"description": "Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids."
},
"secure": {
"type": "string",
"description": "Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.",
"enum": [
"true",
"false"
]
},
"includeAuthActions": {
"type": "string",
"description": "Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.",
"enum": [
"true",
"false"
]
},
"includeConfig": {
"type": "string",
"description": "Return config in response.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_actions\_categories
Retrieves all categories of available Actions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `sortBy` | string | No | — | Root level field name to sort on. Only 'name' is supported on this endpoint. |
| `sortOrder` | string | No | — | Direction to sort 'sortBy' field. |
| `secure` | string | No | — | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. |
```json theme={null}
{
"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"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"sortBy": {
"type": "string",
"description": "Root level field name to sort on. Only 'name' is supported on this endpoint."
},
"sortOrder": {
"type": "string",
"description": "Direction to sort 'sortBy' field.",
"enum": [
"ASC",
"DESC"
]
},
"secure": {
"type": "string",
"description": "Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_actions\_certificates
Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------ |
| `status` | string | No | — | Indicates the validity of the certificate in question. |
| `type` | string | No | — | Indicates the type of the certificate. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"status": {
"type": "string",
"description": "Indicates the validity of the certificate in question.",
"enum": [
"Current",
"Upcoming"
]
},
"type": {
"type": "string",
"description": "Indicates the type of the certificate.",
"enum": [
"Client"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_actions\_certificates\_truststore
Retrieves basic info about trusted root CA certificates
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_actions\_drafts
Retrieves all action drafts associated with the filters passed in via query param.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `sortBy` | string | No | — | Root level field name to sort on. |
| `sortOrder` | string | No | — | Direction to sort 'sortBy' field. |
| `category` | string | No | — | Filter by category name. |
| `name` | string | No | — | Filter by partial or complete action name. |
| `ids` | string | No | — | Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. |
| `secure` | string | No | — | Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. |
| `includeAuthActions` | string | No | — | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. |
| `includeConfig` | string | No | — | Return config in response. |
```json theme={null}
{
"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"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"sortBy": {
"type": "string",
"description": "Root level field name to sort on."
},
"sortOrder": {
"type": "string",
"description": "Direction to sort 'sortBy' field.",
"enum": [
"ASC",
"DESC"
]
},
"category": {
"type": "string",
"description": "Filter by category name."
},
"name": {
"type": "string",
"description": "Filter by partial or complete action name."
},
"ids": {
"type": "string",
"description": "Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids."
},
"secure": {
"type": "string",
"description": "Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.",
"enum": [
"true",
"false"
]
},
"includeAuthActions": {
"type": "string",
"description": "Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.",
"enum": [
"true",
"false"
]
},
"includeConfig": {
"type": "string",
"description": "Return config in response.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_actions\_functions\_runtimes
Get action function settings for Action
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_botconnector\_integration\_id\_bot
Get a specific botConnector bot, plus versions, for this integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------------------------------- |
| `integrationId` | string | Yes | — | The integration ID for this group of bots |
| `botId` | string | Yes | — | The botID for this bot |
| `version` | string | No | — | Specific Version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botId": {
"type": "string",
"description": "The botID for this bot"
},
"version": {
"type": "string",
"description": "Specific Version"
}
},
"required": [
"PCID",
"integrationId",
"botId"
]
}
```
***
## genesys-integrations\_get\_botconnector\_integration\_id\_bot\_versions
Get a list of bot versions for a bot
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------- |
| `integrationId` | string | Yes | — | The integration ID for this bot group |
| `botId` | string | Yes | — | The botID for this bot |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID for this bot group"
},
"botId": {
"type": "string",
"description": "The botID for this bot"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID",
"integrationId",
"botId"
]
}
```
***
## genesys-integrations\_get\_botconnector\_integration\_id\_bots
Get a list of botConnector bots for this integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------------------------------- |
| `integrationId` | string | Yes | — | The integration ID for this group of bots |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_botconnector\_integration\_id\_bots\_summaries
Get a summary list of botConnector bots for this integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------- |
| `integrationId` | string | Yes | — | The integration ID for this group of bots |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_clientapps
List permitted client app integrations for the logged in user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
```json theme={null}
{
"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"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_credential
Get a single credential with sensitive fields redacted
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------- |
| `credentialId` | string | Yes | — | Credential ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"credentialId": {
"type": "string",
"description": "Credential ID"
}
},
"required": [
"PCID",
"credentialId"
]
}
```
***
## genesys-integrations\_get\_credentials\_listing
List multiple sets of credentials using cursor-based paging
**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. |
```json theme={null}
{
"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."
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_credentials\_types
List all credential types
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_integration
Get integration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------------------------------- |
| `integrationId` | string | Yes | — | Integration Id |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_integration\_config\_current
Get integration configuration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------- |
| `integrationId` | string | Yes | — | Integration Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "Integration Id"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_integrations
List integrations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `ids` | string\[] | No | — | Comma-separated list of integration IDs to filter by (max 100) |
| `integrationType` | string | No | — | Filter integrations by integration type ID |
| `reportedState` | string | No | — | Filter integrations by reported state (case-insensitive) |
| `credentialId` | string | No | — | Filter integrations by credential ID |
```json theme={null}
{
"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"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of integration IDs to filter by (max 100)"
},
"integrationType": {
"type": "string",
"description": "Filter integrations by integration type ID"
},
"reportedState": {
"type": "string",
"description": "Filter integrations by reported state (case-insensitive)",
"enum": [
"ACTIVE",
"ACTIVATING",
"INACTIVE",
"DEACTIVATING",
"ERROR"
]
},
"credentialId": {
"type": "string",
"description": "Filter integrations by credential ID"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_audioconnector
Get a list of Audio Connector integrations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_audioconnector\_integration\_id
Get an Audio Connector integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------ |
| `integrationId` | string | Yes | — | The integration ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## genesys-integrations\_get\_speech\_dialogflow\_agent
Get details about a Dialogflow agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `agentId` | string | Yes | — | The agent ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent ID"
}
},
"required": [
"PCID",
"agentId"
]
}
```
***
## genesys-integrations\_get\_speech\_dialogflow\_agents
Get a list of Dialogflow agents in the customers' Google accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Filter on agent name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Filter on agent name"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_dialogflowcx\_agent
Get details about a Dialogflow CX agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `agentId` | string | Yes | — | The agent ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent ID"
}
},
"required": [
"PCID",
"agentId"
]
}
```
***
## genesys-integrations\_get\_speech\_dialogflowcx\_agents
Get a list of Dialogflow CX agents in the customers' Google accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Filter on agent name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Filter on agent name"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_lex\_bot\_alias
Get details about a Lex bot alias
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `aliasId` | string | Yes | — | The alias ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"aliasId": {
"type": "string",
"description": "The alias ID"
}
},
"required": [
"PCID",
"aliasId"
]
}
```
***
## genesys-integrations\_get\_speech\_lex\_bot\_bot\_id\_aliases
Get a list of aliases for a bot in the customer's AWS accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------- |
| `botId` | string | Yes | — | The bot ID |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `status` | string | No | — | Filter on alias status |
| `name` | string | No | — | Filter on alias name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"botId": {
"type": "string",
"description": "The bot ID"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"status": {
"type": "string",
"description": "Filter on alias status",
"enum": [
"READY",
"FAILED",
"BUILDING",
"NOT_BUILT"
]
},
"name": {
"type": "string",
"description": "Filter on alias name"
}
},
"required": [
"PCID",
"botId"
]
}
```
***
## genesys-integrations\_get\_speech\_lex\_bots
Get a list of Lex bots in the customers' AWS accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------ |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Filter on bot name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Filter on bot name"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_lexv2bot\_alias
Get details about a Lex V2 bot alias
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `aliasId` | string | Yes | — | The Alias ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"aliasId": {
"type": "string",
"description": "The Alias ID"
}
},
"required": [
"PCID",
"aliasId"
]
}
```
***
## genesys-integrations\_get\_speech\_lexv2bot\_bot\_id\_aliases
Get a list of aliases for a Lex V2 bot
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------- |
| `botId` | string | Yes | — | The Bot ID |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `status` | string | No | — | Filter on alias status |
| `name` | string | No | — | Filter on alias name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"botId": {
"type": "string",
"description": "The Bot ID"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"status": {
"type": "string",
"description": "Filter on alias status",
"enum": [
"Creating",
"Available",
"Deleting",
"Failed"
]
},
"name": {
"type": "string",
"description": "Filter on alias name"
}
},
"required": [
"PCID",
"botId"
]
}
```
***
## genesys-integrations\_get\_speech\_lexv2bots
Get a list of Lex V2 bots
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------ |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Filter on bot name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Filter on bot name"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bot
Get a Nuance bot in the specified Integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botId` | string | Yes | — | The Nuance bot ID to get |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `targetChannel` | string | No | — | Target Channel |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botId": {
"type": "string",
"description": "The Nuance bot ID to get"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"variables",
"transferNodes",
"channels",
"locales"
]
},
"description": "Related resources to expand inline"
},
"targetChannel": {
"type": "string",
"description": "Target Channel",
"enum": [
"digital",
"voice"
]
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botId"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bot\_job
Get the status of an asynchronous Nuance bot GET job
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botId` | string | Yes | — | The Nuance bot ID |
| `jobId` | string | Yes | — | The asynchronous job ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botId": {
"type": "string",
"description": "The Nuance bot ID"
},
"jobId": {
"type": "string",
"description": "The asynchronous job ID"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botId",
"jobId"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bot\_job\_results
Get the result of an asynchronous Nuance bot GET job
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botId` | string | Yes | — | The Nuance bot ID |
| `jobId` | string | Yes | — | The asynchronous job ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botId": {
"type": "string",
"description": "The Nuance bot ID"
},
"jobId": {
"type": "string",
"description": "The asynchronous job ID"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botId",
"jobId"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bots
Get a list of Nuance bots available in the specified Integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | --------------------------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `onlyRegisteredBots` | boolean | No | — | Limit bots to the ones configured for Genesys Cloud usage |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"onlyRegisteredBots": {
"type": "boolean",
"description": "Limit bots to the ones configured for Genesys Cloud usage"
}
},
"required": [
"PCID",
"nuanceIntegrationId"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bots\_job
Get the status of an asynchronous Nuance bots GET job
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `jobId` | string | Yes | — | The asynchronous job ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"jobId": {
"type": "string",
"description": "The asynchronous job ID"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"jobId"
]
}
```
***
## genesys-integrations\_get\_speech\_nuance\_nuance\_integration\_id\_bots\_job\_results
Get the result of an asynchronous Nuance bots GET job
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `jobId` | string | Yes | — | The asynchronous job ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"jobId": {
"type": "string",
"description": "The asynchronous job ID"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"jobId"
]
}
```
***
## genesys-integrations\_get\_speech\_stt\_engine
Get details about a STT engine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------- |
| `engineId` | string | Yes | — | The engine ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engineId": {
"type": "string",
"description": "The engine ID"
}
},
"required": [
"PCID",
"engineId"
]
}
```
***
## genesys-integrations\_get\_speech\_stt\_engines
Get a list of STT engines enabled for org
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Filter on engine name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Filter on engine name"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_tts\_engine
Get details about a TTS engine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------- |
| `engineId` | string | Yes | — | The engine ID |
| `includeVoices` | boolean | No | — | Include voices for the engine |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engineId": {
"type": "string",
"description": "The engine ID"
},
"includeVoices": {
"type": "boolean",
"description": "Include voices for the engine"
}
},
"required": [
"PCID",
"engineId"
]
}
```
***
## genesys-integrations\_get\_speech\_tts\_engine\_voice
Get details about a specific voice for a TTS engine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------- |
| `engineId` | string | Yes | — | The engine ID |
| `voiceId` | string | Yes | — | The voice ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engineId": {
"type": "string",
"description": "The engine ID"
},
"voiceId": {
"type": "string",
"description": "The voice ID"
}
},
"required": [
"PCID",
"engineId",
"voiceId"
]
}
```
***
## genesys-integrations\_get\_speech\_tts\_engine\_voices
Get a list of voices for a TTS engine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------- |
| `engineId` | string | Yes | — | The engine ID |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engineId": {
"type": "string",
"description": "The engine ID"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID",
"engineId"
]
}
```
***
## genesys-integrations\_get\_speech\_tts\_engines
Get a list of TTS engines enabled for org
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------- |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `includeVoices` | boolean | No | — | Include voices for the engine |
| `name` | string | No | — | Filter on engine name |
| `language` | string | No | — | Filter on supported language. If includeVoices=true then the voices are also filtered. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"includeVoices": {
"type": "boolean",
"description": "Include voices for the engine"
},
"name": {
"type": "string",
"description": "Filter on engine name"
},
"language": {
"type": "string",
"description": "Filter on supported language. If includeVoices=true then the voices are also filtered."
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_speech\_tts\_settings
Get TTS settings for an org
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_type
Get integration type.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `typeId` | string | Yes | — | Integration Type Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"typeId": {
"type": "string",
"description": "Integration Type Id"
}
},
"required": [
"PCID",
"typeId"
]
}
```
***
## genesys-integrations\_get\_type\_configschema
Get properties config schema for an integration type.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------- |
| `typeId` | string | Yes | — | Integration Type Id |
| `configType` | string | Yes | — | Config schema type |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"typeId": {
"type": "string",
"description": "Integration Type Id"
},
"configType": {
"type": "string",
"description": "Config schema type",
"enum": [
"properties",
"advanced"
]
}
},
"required": [
"PCID",
"typeId",
"configType"
]
}
```
***
## genesys-integrations\_get\_types
List integration types
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
```json theme={null}
{
"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"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_unifiedcommunications\_clientapp
UC integration client application configuration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `ucIntegrationId` | string | Yes | — | 3rd Party Service Type |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ucIntegrationId": {
"type": "string",
"description": "3rd Party Service Type"
}
},
"required": [
"PCID",
"ucIntegrationId"
]
}
```
***
## genesys-integrations\_get\_unifiedcommunications\_clientapps
List UC integration client application configurations.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
```json theme={null}
{
"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"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_get\_userapps
List permitted user app integrations for the logged in user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `appHost` | string | No | — | The type of UserApp to filter by |
```json theme={null}
{
"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"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"appHost": {
"type": "string",
"description": "The type of UserApp to filter by"
}
},
"required": [
"PCID"
]
}
```
***
## genesys-integrations\_patch\_action
Patch an Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `category` | string | No | — | Category of action, Can be up to 256 characters long |
| `config` | object | No | — | Defines components of the Action Config. |
| `name` | string | No | — | Name of action, Can be up to 256 characters long |
| `version` | integer | Yes | — | Version of this action |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"category": {
"type": "string",
"description": "Category of action, Can be up to 256 characters long"
},
"config": {
"type": "object",
"description": "Defines components of the Action Config.",
"properties": {
"timeoutSeconds": {
"type": "integer",
"description": "Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."
},
"request": {
"type": "object",
"description": "Defines response components of the Action Request."
},
"response": {
"type": "object",
"description": "Defines response components of the Action Request."
}
}
},
"name": {
"type": "string",
"description": "Name of action, Can be up to 256 characters long"
},
"version": {
"type": "integer",
"description": "Version of this action"
}
},
"required": [
"PCID",
"actionId",
"version"
]
}
```
***
## genesys-integrations\_patch\_action\_draft
Update an existing Draft
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `category` | string | No | — | Category of action, Can be up to 256 characters long |
| `config` | object | No | — | Defines components of the Action Config. |
| `contract` | object | No | — | Contract definition. |
| `name` | string | No | — | Name of action, Can be up to 256 characters long |
| `secure` | boolean | No | — | Indication of whether or not the action is designed to accept sensitive data |
| `version` | integer | Yes | — | Version of current Draft |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"category": {
"type": "string",
"description": "Category of action, Can be up to 256 characters long"
},
"config": {
"type": "object",
"description": "Defines components of the Action Config.",
"properties": {
"timeoutSeconds": {
"type": "integer",
"description": "Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."
},
"request": {
"type": "object",
"description": "Defines response components of the Action Request."
},
"response": {
"type": "object",
"description": "Defines response components of the Action Request."
}
}
},
"contract": {
"type": "object",
"description": "Contract definition.",
"properties": {
"input": {
"type": "object",
"description": "The schemas defining all of the expected requests/inputs."
},
"output": {
"type": "object",
"description": "The schemas defining all of the expected responses/outputs."
}
},
"required": [
"input",
"output"
]
},
"name": {
"type": "string",
"description": "Name of action, Can be up to 256 characters long"
},
"secure": {
"type": "boolean",
"description": "Indication of whether or not the action is designed to accept sensitive data"
},
"version": {
"type": "integer",
"description": "Version of current Draft"
}
},
"required": [
"PCID",
"actionId",
"version"
]
}
```
***
## genesys-integrations\_patch\_integration
Update an integration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `integrationId` | string | Yes | — | Integration Id |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `attributes` | object | No | — | Read-only attributes for the integration. |
| `config` | object | No | — | Configuration information for the integration |
| `id` | string | No | — | The globally unique identifier for the object. |
| `integrationType` | object | No | — | Descriptor for a type of Integration. |
| `intendedState` | string | Yes | — | Configured state of the integration. |
| `name` | string | No | — | The name of the integration, used to distinguish this integration from others of the same type. |
| `notes` | string | No | — | Notes about the integration. |
| `reportedState` | object | No | — | Status information for an Integration. |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"attributes": {
"type": "object",
"description": "Read-only attributes for the integration."
},
"config": {
"type": "object",
"description": "Configuration information for the integration",
"properties": {
"current": {
"type": "object",
"description": "Configuration for an Integration"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"integrationType": {
"type": "object",
"description": "Descriptor for a type of Integration.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the integration type."
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "Description of the integration type."
},
"provider": {
"type": "string",
"description": "PureCloud provider of the integration type."
},
"category": {
"type": "string",
"description": "Category describing the integration type."
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "Collection of logos."
},
"configPropertiesSchemaUri": {
"type": "string",
"description": "URI of the schema describing the key-value properties needed to configure an integration of this type."
},
"configAdvancedSchemaUri": {
"type": "string",
"description": "URI of the schema describing the advanced JSON document needed to configure an integration of this type."
},
"helpUri": {
"type": "string",
"description": "URI of a page with more information about the integration type"
},
"termsOfServiceUri": {
"type": "string",
"description": "URI of a page with terms and conditions for the integration type"
},
"vendorName": {
"type": "string",
"description": "Name of the vendor of this integration type"
},
"vendorWebsiteUri": {
"type": "string",
"description": "URI of the vendor's website"
},
"marketplaceUri": {
"type": "string",
"description": "URI of the marketplace listing for this integration type"
},
"faqUri": {
"type": "string",
"description": "URI of frequently asked questions about the integration type"
},
"privacyPolicyUri": {
"type": "string",
"description": "URI of a privacy policy for users of the integration type"
},
"supportContactUri": {
"type": "string",
"description": "URI for vendor support"
},
"salesContactUri": {
"type": "string",
"description": "URI for vendor sales information"
},
"helpLinks": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of links to additional help resources"
},
"credentials": {
"type": "object",
"description": "Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration."
},
"nonInstallable": {
"type": "boolean",
"description": "Indicates if the integration type is installable or not."
},
"maxInstances": {
"type": "integer",
"description": "The maximum number of integration instances allowable for this integration type"
},
"userPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permissions required to permit user access to the integration type."
},
"vendorOAuthClientIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of OAuth Client IDs that must be authorized when the integration is created."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"intendedState": {
"type": "string",
"description": "Configured state of the integration.",
"enum": [
"ENABLED",
"DISABLED",
"DELETED",
"RESTORED"
]
},
"name": {
"type": "string",
"description": "The name of the integration, used to distinguish this integration from others of the same type."
},
"notes": {
"type": "string",
"description": "Notes about the integration."
},
"reportedState": {
"type": "object",
"description": "Status information for an Integration.",
"properties": {
"code": {
"type": "string",
"description": "Machine-readable status as reported by the integration.",
"enum": [
"ACTIVE",
"ACTIVATING",
"INACTIVE",
"DEACTIVATING",
"ERROR"
]
},
"effective": {
"type": "string",
"description": "Localized, human-readable, effective status of the integration."
},
"detail": {
"type": "object",
"description": "The detail value"
},
"lastUpdated": {
"type": "string",
"description": "Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"integrationId",
"intendedState"
]
}
```
***
## genesys-integrations\_post\_action\_draft
Create a new Draft from existing Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `actionId` | string | Yes | — | Action Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## genesys-integrations\_post\_action\_draft\_function\_upload
Create upload presigned URL for draft function package file.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `fileName` | string | Yes | — | Name of the file to upload.File name can only contain letters, numbers, and the following special characters: + - \_ . ' ( ) |
| `signedUrlTimeoutSeconds` | integer | No | — | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 900 seconds |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"fileName": {
"type": "string",
"description": "Name of the file to upload.File name can only contain letters, numbers, and the following special characters: + - _ . ' ( )"
},
"signedUrlTimeoutSeconds": {
"type": "integer",
"description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 900 seconds"
}
},
"required": [
"PCID",
"actionId",
"fileName"
]
}
```
***
## genesys-integrations\_post\_action\_draft\_publish
Publish a Draft and make it the active Action configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | -------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `version` | integer | Yes | — | The current draft version. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"version": {
"type": "integer",
"description": "The current draft version."
}
},
"required": [
"PCID",
"actionId",
"version"
]
}
```
***
## genesys-integrations\_post\_action\_draft\_test
Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `flatten` | boolean | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
| `body` | object | Yes | — | Map of parameters used for variable substitution. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"flatten": {
"type": "boolean",
"description": "Indicates the response should be reformatted, based on Architect's flattening format."
},
"body": {
"type": "object",
"description": "Map of parameters used for variable substitution."
}
},
"required": [
"PCID",
"actionId",
"body"
]
}
```
***
## genesys-integrations\_post\_action\_execute
Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `flatten` | boolean | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
| `body` | object | Yes | — | Map of parameters used for variable substitution. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"flatten": {
"type": "boolean",
"description": "Indicates the response should be reformatted, based on Architect's flattening format."
},
"body": {
"type": "object",
"description": "Map of parameters used for variable substitution."
}
},
"required": [
"PCID",
"actionId",
"body"
]
}
```
***
## genesys-integrations\_post\_action\_test
Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `flatten` | boolean | No | — | Indicates the response should be reformatted, based on Architect's flattening format. |
| `body` | object | Yes | — | Map of parameters used for variable substitution. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"flatten": {
"type": "boolean",
"description": "Indicates the response should be reformatted, based on Architect's flattening format."
},
"body": {
"type": "object",
"description": "Map of parameters used for variable substitution."
}
},
"required": [
"PCID",
"actionId",
"body"
]
}
```
***
## genesys-integrations\_post\_actions
Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `category` | string | Yes | — | Category of action, Can be up to 256 characters long |
| `config` | object | Yes | — | Defines components of the Action Config. |
| `contract` | object | Yes | — | Contract definition. |
| `integrationId` | string | Yes | — | The ID of the integration this action is associated to |
| `name` | string | Yes | — | Name of action, Can be up to 256 characters long |
| `secure` | boolean | No | — | Indication of whether or not the action is designed to accept sensitive data |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "Category of action, Can be up to 256 characters long"
},
"config": {
"type": "object",
"description": "Defines components of the Action Config.",
"properties": {
"timeoutSeconds": {
"type": "integer",
"description": "Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."
},
"request": {
"type": "object",
"description": "Defines response components of the Action Request."
},
"response": {
"type": "object",
"description": "Defines response components of the Action Request."
}
}
},
"contract": {
"type": "object",
"description": "Contract definition.",
"properties": {
"input": {
"type": "object",
"description": "The schemas defining all of the expected requests/inputs."
},
"output": {
"type": "object",
"description": "The schemas defining all of the expected responses/outputs."
}
},
"required": [
"input",
"output"
]
},
"integrationId": {
"type": "string",
"description": "The ID of the integration this action is associated to"
},
"name": {
"type": "string",
"description": "Name of action, Can be up to 256 characters long"
},
"secure": {
"type": "boolean",
"description": "Indication of whether or not the action is designed to accept sensitive data"
}
},
"required": [
"PCID",
"category",
"config",
"contract",
"integrationId",
"name"
]
}
```
***
## genesys-integrations\_post\_actions\_drafts
Create a new Draft
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `category` | string | Yes | — | Category of action, Can be up to 256 characters long |
| `config` | object | Yes | — | Defines components of the Action Config. |
| `contract` | object | Yes | — | Contract definition. |
| `integrationId` | string | Yes | — | The ID of the integration this action is associated to |
| `name` | string | Yes | — | Name of action, Can be up to 256 characters long |
| `secure` | boolean | No | — | Indication of whether or not the action is designed to accept sensitive data |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "Category of action, Can be up to 256 characters long"
},
"config": {
"type": "object",
"description": "Defines components of the Action Config.",
"properties": {
"timeoutSeconds": {
"type": "integer",
"description": "Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."
},
"request": {
"type": "object",
"description": "Defines response components of the Action Request."
},
"response": {
"type": "object",
"description": "Defines response components of the Action Request."
}
}
},
"contract": {
"type": "object",
"description": "Contract definition.",
"properties": {
"input": {
"type": "object",
"description": "The schemas defining all of the expected requests/inputs."
},
"output": {
"type": "object",
"description": "The schemas defining all of the expected responses/outputs."
}
},
"required": [
"input",
"output"
]
},
"integrationId": {
"type": "string",
"description": "The ID of the integration this action is associated to"
},
"name": {
"type": "string",
"description": "Name of action, Can be up to 256 characters long"
},
"secure": {
"type": "boolean",
"description": "Indication of whether or not the action is designed to accept sensitive data"
}
},
"required": [
"PCID",
"category",
"config",
"contract",
"integrationId",
"name"
]
}
```
***
## genesys-integrations\_post\_credentials
Create a set of credentials
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ---------------------------------------------- |
| `credentialFields` | object | No | — | Credential Fields |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `type` | object | Yes | — | The type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"credentialFields": {
"type": "object",
"description": "Credential Fields"
},
"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"
},
"type": {
"type": "object",
"description": "The type value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"properties": {
"type": "object",
"description": "Properties describing credentials of this type."
},
"displayOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order in which properties should be displayed in the UI."
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"description": "Properties that are required fields."
}
}
}
},
"required": [
"PCID",
"type"
]
}
```
***
## genesys-integrations\_post\_integrations
Create an integration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `id` | string | No | — | The globally unique identifier for the object. |
| `integrationType` | object | Yes | — | Descriptor for a type of Integration. |
| `name` | string | Yes | — | The name of the integration, used to distinguish this integration from others of the same type. |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"integrationType": {
"type": "object",
"description": "Descriptor for a type of Integration.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the integration type."
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "Description of the integration type."
},
"provider": {
"type": "string",
"description": "PureCloud provider of the integration type."
},
"category": {
"type": "string",
"description": "Category describing the integration type."
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "Collection of logos."
},
"configPropertiesSchemaUri": {
"type": "string",
"description": "URI of the schema describing the key-value properties needed to configure an integration of this type."
},
"configAdvancedSchemaUri": {
"type": "string",
"description": "URI of the schema describing the advanced JSON document needed to configure an integration of this type."
},
"helpUri": {
"type": "string",
"description": "URI of a page with more information about the integration type"
},
"termsOfServiceUri": {
"type": "string",
"description": "URI of a page with terms and conditions for the integration type"
},
"vendorName": {
"type": "string",
"description": "Name of the vendor of this integration type"
},
"vendorWebsiteUri": {
"type": "string",
"description": "URI of the vendor's website"
},
"marketplaceUri": {
"type": "string",
"description": "URI of the marketplace listing for this integration type"
},
"faqUri": {
"type": "string",
"description": "URI of frequently asked questions about the integration type"
},
"privacyPolicyUri": {
"type": "string",
"description": "URI of a privacy policy for users of the integration type"
},
"supportContactUri": {
"type": "string",
"description": "URI for vendor support"
},
"salesContactUri": {
"type": "string",
"description": "URI for vendor sales information"
},
"helpLinks": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of links to additional help resources"
},
"credentials": {
"type": "object",
"description": "Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration."
},
"nonInstallable": {
"type": "boolean",
"description": "Indicates if the integration type is installable or not."
},
"maxInstances": {
"type": "integer",
"description": "The maximum number of integration instances allowable for this integration type"
},
"userPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permissions required to permit user access to the integration type."
},
"vendorOAuthClientIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of OAuth Client IDs that must be authorized when the integration is created."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"name": {
"type": "string",
"description": "The name of the integration, used to distinguish this integration from others of the same type."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"integrationType",
"name"
]
}
```
***
## genesys-integrations\_post\_speech\_nuance\_nuance\_integration\_id\_bot\_jobs
Get a Nuance bot in the specified Integration asynchronously
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botId` | string | Yes | — | The Nuance bot ID |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `body` | string | No | — | targetChannel |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botId": {
"type": "string",
"description": "The Nuance bot ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"variables",
"transferNodes",
"channels",
"locales"
]
},
"description": "Related resources to expand inline"
},
"body": {
"type": "string",
"description": "targetChannel"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botId"
]
}
```
***
## genesys-integrations\_post\_speech\_nuance\_nuance\_integration\_id\_bots\_jobs
Get a list of Nuance bots in the specified Integration asynchronously
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | --------------------------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
| `onlyRegisteredBots` | boolean | No | — | Limit bots to the ones configured for Genesys Cloud usage |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"onlyRegisteredBots": {
"type": "boolean",
"description": "Limit bots to the ones configured for Genesys Cloud usage"
}
},
"required": [
"PCID",
"nuanceIntegrationId"
]
}
```
***
## genesys-integrations\_post\_speech\_nuance\_nuance\_integration\_id\_bots\_launch\_validate
Try out a single credential for a Nuance bot to know if the secret is correct
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------------------------------------- |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botCredentials` | object | Yes | — | Model for a Nuance bot credentials |
| `botId` | string | Yes | — | The Nuance bot ID |
| `executionHost` | string | Yes | — | The hostname to use when contacting Nuance to execute this bot |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botCredentials": {
"type": "object",
"description": "Model for a Nuance bot credentials",
"properties": {
"appId": {
"type": "string",
"description": "The application ID"
},
"clientId": {
"type": "string",
"description": "The credentials client ID"
},
"clientSecret": {
"type": "string",
"description": "The credentials client secret"
},
"clientSecretProvided": {
"type": "boolean",
"description": "True if the credentials secret is set (but not returned due to security reasons)"
}
},
"required": [
"appId",
"clientId"
]
},
"botId": {
"type": "string",
"description": "The Nuance bot ID"
},
"executionHost": {
"type": "string",
"description": "The hostname to use when contacting Nuance to execute this bot"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botCredentials",
"botId",
"executionHost"
]
}
```
***
## genesys-integrations\_post\_webhook\_events
Invoke Webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------- |
| `tokenId` | string | Yes | — | The token of the webhook to be invoked |
| `body` | object | Yes | — | Webhook Invocation Payload |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tokenId": {
"type": "string",
"description": "The token of the webhook to be invoked"
},
"body": {
"type": "object",
"description": "Webhook Invocation Payload"
}
},
"required": [
"PCID",
"tokenId",
"body"
]
}
```
***
## genesys-integrations\_put\_action\_draft\_function
Update draft function settings.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `actionId` | string | Yes | — | Action Id |
| `dateCreated` | string | No | — | Date and time function was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | Yes | — | Description of the function. Limit 255 characters. |
| `handler` | string | Yes | — | Handler entry point into zip file to execute function. Should be path within upload function package to the invocation module without language extension, followed by a period and then exported invocation method name. e.g. 'src/index.handler' |
| `id` | string | No | — | Function identifier. |
| `name` | string | No | — | Function name. This is automatically created based on the Action Id. |
| `runtime` | string | Yes | — | Runtime required for execution. Valid runtimes change over time as versions are deprecated. Use /api/v2/integrations/actions/functions/runtimes for current list. |
| `timeoutSeconds` | integer | No | — | Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 15. Default value 15 seconds. |
| `zipId` | string | No | — | Zip file identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "Action Id"
},
"dateCreated": {
"type": "string",
"description": "Date and time function was created. 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 function. Limit 255 characters."
},
"handler": {
"type": "string",
"description": "Handler entry point into zip file to execute function. Should be path within upload function package to the invocation module without language extension, followed by a period and then exported invocation method name. e.g. 'src/index.handler'"
},
"id": {
"type": "string",
"description": "Function identifier."
},
"name": {
"type": "string",
"description": "Function name. This is automatically created based on the Action Id."
},
"runtime": {
"type": "string",
"description": "Runtime required for execution. Valid runtimes change over time as versions are deprecated. Use /api/v2/integrations/actions/functions/runtimes for current list."
},
"timeoutSeconds": {
"type": "integer",
"description": "Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 15. Default value 15 seconds."
},
"zipId": {
"type": "string",
"description": "Zip file identifier."
}
},
"required": [
"PCID",
"actionId",
"description",
"handler",
"runtime"
]
}
```
***
## genesys-integrations\_put\_botconnector\_integration\_id\_bots
Set a list of botConnector bots plus versions for this integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------------------------------------- |
| `integrationId` | string | Yes | — | The integration ID for this group of bots |
| `chatBots` | object\[] | Yes | — | A list of botConnector Bots. Max 50 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"chatBots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Botconnector Bot Id - this is configurable by the user when put"
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "An optional description of the bot. This can be up to 256 characters long and must be comprised of displayable characters without leading or trailing whitespace"
},
"versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The name of the version. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"
},
"supportedLanguages": {
"type": "array",
"description": "The supported languages for this bot. EG 'en-us' or 'es', etc; These language codes are W3C language identification tags (ISO 639-1 for the language name and ISO 3166 for the country code)"
},
"intents": {
"type": "array",
"description": "A list of potential intents this bot will return, limit of 50"
}
}
},
"description": "This bots versions, limit of 50 per bot"
},
"botCompositeTag": {
"type": "string",
"description": "A system-generated string that contains metadata about this bot."
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"id",
"versions"
]
},
"description": "A list of botConnector Bots. Max 50"
}
},
"required": [
"PCID",
"integrationId",
"chatBots"
]
}
```
***
## genesys-integrations\_put\_credential
Update a set of credentials
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ---------------------------------------------- |
| `credentialId` | string | Yes | — | Credential ID |
| `credentialFields` | object | No | — | Credential Fields |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `type` | object | Yes | — | The type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"credentialId": {
"type": "string",
"description": "Credential ID"
},
"credentialFields": {
"type": "object",
"description": "Credential Fields"
},
"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"
},
"type": {
"type": "object",
"description": "The type value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"properties": {
"type": "object",
"description": "Properties describing credentials of this type."
},
"displayOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order in which properties should be displayed in the UI."
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"description": "Properties that are required fields."
}
}
}
},
"required": [
"PCID",
"credentialId",
"type"
]
}
```
***
## genesys-integrations\_put\_integration\_config\_current
Update integration configuration.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `integrationId` | string | Yes | — | Integration Id |
| `advanced` | object | Yes | — | Advanced configuration described by the schema in the advancedSchemaUri field. |
| `credentials` | object | Yes | — | Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | Yes | — | The name of the integration, used to distinguish this integration from others of the same type. |
| `notes` | string | Yes | — | Notes about the integration. |
| `properties` | object | Yes | — | Key-value configuration settings described by the schema in the propertiesSchemaUri field. |
| `selfUri` | string | No | — | The URI for this object |
| `version` | integer | Yes | — | Version number required for updates. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"advanced": {
"type": "object",
"description": "Advanced configuration described by the schema in the advancedSchemaUri field."
},
"credentials": {
"type": "object",
"description": "Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the integration, used to distinguish this integration from others of the same type."
},
"notes": {
"type": "string",
"description": "Notes about the integration."
},
"properties": {
"type": "object",
"description": "Key-value configuration settings described by the schema in the propertiesSchemaUri field."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"version": {
"type": "integer",
"description": "Version number required for updates."
}
},
"required": [
"PCID",
"integrationId",
"advanced",
"credentials",
"name",
"notes",
"properties",
"version"
]
}
```
***
## genesys-integrations\_put\_speech\_nuance\_nuance\_integration\_id\_bots\_launch\_settings
Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `nuanceIntegrationId` | string | Yes | — | The integration ID for this group of bots |
| `botExecutionConfigurations` | object\[] | Yes | — | The list of Nuance bots that are configured as available to the Genesys Cloud system |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nuanceIntegrationId": {
"type": "string",
"description": "The integration ID for this group of bots"
},
"botExecutionConfigurations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"botId": {
"type": "string",
"description": "The Nuance bot ID"
},
"executionHost": {
"type": "string",
"description": "The hostname to use when contacting Nuance to execute this bot"
},
"botCredentials": {
"type": "object",
"description": "Model for a Nuance bot credentials"
}
},
"required": [
"botCredentials",
"botId",
"executionHost"
]
},
"description": "The list of Nuance bots that are configured as available to the Genesys Cloud system"
}
},
"required": [
"PCID",
"nuanceIntegrationId",
"botExecutionConfigurations"
]
}
```
***
## genesys-integrations\_put\_speech\_tts\_settings
Update TTS settings for an org
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------- |
| `defaultEngine` | string | Yes | — | ID of the global default TTS engine |
| `languageOverrides` | object\[] | Yes | — | The list of default overrides for specific languages |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"defaultEngine": {
"type": "string",
"description": "ID of the global default TTS engine"
},
"languageOverrides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "The language code of the language being overridden"
},
"engine": {
"type": "string",
"description": "The ID of the TTS engine to use for this language override"
},
"voice": {
"type": "string",
"description": "The ID of the voice to use for this language override. The voice must be supported by the chosen engine."
}
},
"required": [
"engine",
"language",
"voice"
]
},
"description": "The list of default overrides for specific languages"
}
},
"required": [
"PCID",
"defaultEngine",
"languageOverrides"
]
}
```
***
## genesys-integrations\_put\_unifiedcommunication\_thirdpartypresences
Bulk integration presence ingestion
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ---------------------- |
| `ucIntegrationId` | string | Yes | — | UC Integration ID |
| `body` | object\[] | Yes | — | List of User presences |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ucIntegrationId": {
"type": "string",
"description": "UC Integration ID"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Primary Email address of the associated Genesys Cloud user."
},
"presence": {
"type": "string",
"description": "Integration presence value."
},
"message": {
"type": "string",
"description": "Integration presence message."
},
"dateModified": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of presence value change."
}
},
"required": [
"email",
"presence"
]
},
"description": "List of User presences"
}
},
"required": [
"PCID",
"ucIntegrationId",
"body"
]
}
```