Genesys Integrations API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Integration. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes
86 operations
across 69 paths,
and defines 123 schemas.
It is described by OpenAPI 2.0, at version v2.
Requests are made against the base URL https://api.mypurecloud.com.
The identity and technical contract details declared by the specification.
ActionContractInput
object
Contract definition.
2 properties
2 required
LexIntent
object
4 properties
3 required
AddressableEntityRef
object
2 properties
DialogflowCXAgentSummary
object
6 properties
DialogflowProject
object
2 properties
JsonSchemaDocument
object
A JSON Schema document.
8 properties
NuanceBot
object
Model for a Nuance bot
13 properties
7 required
DraftValidationResult
object
Validation results
2 properties
UpdateDraftInput
object
Definition of an Action Draft to be created or updated.
6 properties
1 required
FunctionConfig
object
Current action function configuration and zip upload configuration.
5 properties
LexSlot
object
4 properties
2 required
BotConnectorBot
object
A botConnector Bot Instance
6 properties
2 required
LexBot
object
4 properties
ResponseConfig
object
Defines response components of the Action Request.
4 properties
LexV2BotEntityListing
object
10 properties
NuanceBotVariable
object
Model for a Nuance bot variable
6 properties
2 required
NuanceBotEntityListing
object
Model for a paged listing of Nuance bots
10 properties
UserApp
object
Details for a UserApp
5 properties
TestExecutionOperationResult
object
5 properties
BotExecutionConfiguration
object
Model for setting the launch configuration for a Nuance bot available to Genesys Cloud
3 properties
3 required
CredentialInfo
object
6 properties
TtsVoiceEntity
object
7 properties
3 required
DialogflowCXAgentSummaryEntityListing
object
10 properties
BotConnectorBotVersion
object
A version description for a botConnector bot.
3 properties
3 required
UnifiedCommunicationsIntegrationListing
object
10 properties
IntegrationConfiguration
object
Configuration for an Integration
8 properties
6 required
Action
object
9 properties
TtsSettings
object
2 properties
2 required
EffectiveConfiguration
object
Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type.
5 properties
5 required
LexBotEntityListing
object
10 properties
NuanceChannel
object
Model for a Nuance channel
4 properties
2 required
CredentialInfoListing
object
10 properties
FunctionZipConfig
object
Action function zip file upload settings and state.
6 properties
PostActionInput
object
Definition of an Action to be created or updated.
6 properties
5 required
ClientApp
object
Details for a ClientApp
9 properties
1 required
IntegrationTypeEntityListing
object
10 properties
LexV2Slot
object
5 properties
4 required
FlattenedJsonSchemaDocument
object
JSON schema that defines the transformed result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the '…
2 properties
BotConnectorBotVersionSummaryEntityListing
object
10 properties
UnifiedCommunicationsIntegration
object
UC Integration UI configuration data
14 properties
8 required
TrustedCertificateInfo
object
3 properties
FunctionRuntime
object
Action function runtime.
4 properties
DialogflowCXProject
object
2 properties
BotVersionSummary
object
A version summary for a botConnector bot.
5 properties
3 required
DomainEntityRef
object
3 properties
DialogflowCXAgent
object
7 properties
IntegrationStatusInfo
object
Status information for an Integration.
4 properties
TtsVoiceEntityListing
object
10 properties
CredentialType
object
5 properties
LexBotAlias
object
9 properties
1 required
NuanceBotCredentials
object
Model for a Nuance bot credentials
4 properties
2 required
AsyncJob
object
3 properties
FunctionUploadRequest
object
Action function URL upload input.
2 properties
1 required
LanguageOverride
object
3 properties
3 required
NuanceEnvironment
object
Model for a Nuance bot environment
4 properties
3 required
Detail
object
4 properties
SttEngineEntityListing
object
10 properties
NuanceBotTransferNode
object
Model for a Nuance bot transfer node
5 properties
3 required
DialogflowCXEnvironment
object
3 properties
TtsEngineEntity
object
8 properties
2 required
WebhookInvocationResponse
object
1 property
1 required
DialogflowAgentSummaryEntityListing
object
10 properties
LexV2Intent
object
4 properties
3 required
Category
object
List of available Action categories.
1 property
DialogflowParameter
object
2 properties
2 required
DialogflowAgentSummary
object
6 properties
ActionContract
object
This resource contains all of the schemas needed to define the inputs and outputs, of a single Action.
2 properties
LexBotAliasEntityListing
object
10 properties
BotList
object
A list of BotConnectorBots
1 property
1 required
TestExecutionResult
object
4 properties
UserAppConfigurationInfo
object
Configuration information for the integration
2 properties
ActionEntityListing
object
10 properties
ActionOutput
object
Output definition of Action.
6 properties
NuanceBotLaunchSettings
object
Model for setting the launch configuration for Nuance bots available to Genesys Cloud
1 property
1 required
UserAppEntityListing
object
10 properties
UpdateActionInput
object
4 properties
1 required
UCIcon
object
1 property
1 required
AudioConnectorIntegration
object
3 properties
Limit
object
3 properties
CredentialInfoCursorListing
object
4 properties
MessageInfo
object
4 properties
PostInputContract
object
The schemas defining all of the expected requests/inputs.
1 property
1 required
ActionConfig
object
Defines components of the Action Config.
3 properties
LexV2BotAlias
object
10 properties
2 required
NuanceApplication
object
Model for a Nuance bot application
3 properties
3 required
CredentialSpecification
object
Specifies the requirements for a credential that can be provided for configuring an integration
3 properties
AudioConnectorIntegrationEntityListing
object
10 properties
IntegrationType
object
Descriptor for a type of Integration.
24 properties
1 required
DialogflowAgent
object
8 properties
BotSummary
object
A summary description for a botConnector bot
4 properties
2 required
ActionCertificateListing
object
10 properties
TrustedCertificates
object
Information about trusted certificates
2 properties
PublishDraftInput
object
Draft to be published
1 property
1 required
IntegrationEntityListing
object
10 properties
IntegrationConfigurationInfo
object
Configuration information for the integration
1 property
Image
object
2 properties
HelpLink
object
Link to a help or support resource
3 properties
CategoryEntityListing
object
5 properties
TtsEngineEntityListing
object
10 properties
ActionCertificate
object
Details for an mTLS certificate
4 properties
BotIntent
object
A botConnector's bot intention
2 properties
1 required
Function
object
Action function settings.
8 properties
3 required
NuanceOrganization
object
Model for a Nuance bot organization
2 properties
2 required
SttEngineEntity
object
4 properties
ErrorBody
object
11 properties
ActionInput
object
Input requirements of Action.
3 properties
ClientAppEntityListing
object
10 properties
NuanceGeography
object
Model for a Nuance bot geography
2 properties
2 required
ClientAppConfigurationInfo
object
Configuration information for the integration
2 properties
UCThirdPartyPresence
object
Update a Genesys Cloud user's presence from a given 3rd-party integration
4 properties
2 required
LexV2BotAliasEntityListing
object
10 properties
Credential
object
5 properties
1 required
BotConnectorBotSummaryEntityListing
object
10 properties
CreateIntegrationRequest
object
Details for an Integration
4 properties
2 required
LexV2Bot
object
6 properties
2 required
PostOutputContract
object
The schemas defining all of the expected responses/outputs.
1 property
1 required
ComplexVariableInfo
object
Variable type information about a complex type from the bot's definition
2 properties
2 required
RequestConfig
object
Defines response components of the Action Request.
5 properties
FunctionUploadResponse
object
Action function create upload URL response.
3 properties
DialogflowIntent
object
2 properties
2 required
BotSlot
object
Description of a data value returned from an intent
2 properties
2 required
Integration
object
Details for an Integration
9 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Genesys publishes across the network.