The identity and technical contract details declared by the specification.
TextBotModeOutputPrompts
object
Prompt information related to a bot flow turn.
1 property
1 required
ConversationContentListPicker
object
List Picker object for presenting multiple sections of selectable items.
4 properties
ConversationPushNotificationMessageLabel
object
A Push notification message label.
2 properties
2 required
ConversationPushProviderIntegration
object
A Push provider integration.
2 properties
2 required
TextBotChannel
object
Channel information relevant to a bot flow.
4 properties
4 required
PostTextResponse
object
10 properties
1 required
ConversationContentInput
object
Single or multiline text input component.
8 properties
2 required
AmazonLexRequest
object
2 properties
Detail
object
4 properties
ConversationContentNotificationTemplate
object
Template notification object.
6 properties
1 required
ConversationContentCard
object
Card content object.
6 properties
2 required
GoogleDialogflowCustomSettings
object
4 properties
TextBotTranscript
object
Data for a single bot flow transcript.
2 properties
1 required
ConversationContentButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
4 properties
2 required
ConversationFormResponseContent
object
Message content element for form responses
2 properties
TextBotFlow
object
Description of the Bot Flow.
1 property
1 required
ConversationContentForm
object
Form content object.
8 properties
1 required
BotSearchResponseEntityListing
object
1 property
BotSearchResponse
object
6 properties
3 required
ConversationMessageEvent
object
Message event element. Examples include: system messages, typing indicators, cobrowse offerings.
5 properties
1 required
ConversationContentListPickerItem
object
Represents a selectable item in a list picker.
4 properties
TextBotTurnReference
object
A reference to a bot flow turn.
1 property
1 required
ConversationContentDatePicker
object
DateTimePicker content object.
9 properties
TextBotUserInputAlternative
object
User input data used in a bot flow turn.
1 property
1 required
ConversationContentDatePickerAvailableTime
object
A datetimepicker available time that a user can take.
2 properties
ConversationContentText
object
Message content element containing text only.
2 properties
1 required
TextBotFlowTurnResponse
object
Information related to a success bot flow turn request.
7 properties
2 required
ConversationNotificationTemplateFooter
object
Template footer object.
1 property
ConversationEventVideo
object
A Video event.
3 properties
1 required
TextBotFlowOutcome
object
Flow Outcome data related to a bot flow which is exiting gracefully.
5 properties
TextBotFlowTurnRequest
object
Settings for a turn request to a bot flow.
5 properties
1 required
ConversationContentQuickReplyV2
object
Quick reply object V2.
2 properties
2 required
TextBotFlowLocation
object
Describes a flow location.
3 properties
3 required
ErrorBody
object
11 properties
ConversationContentWheelPickerItem
object
Represents a selectable item in a Wheel Picker
3 properties
2 required
ConversationContentLocation
object
Location object.
5 properties
TextBotInputOutputData
object
Input/Output data related to a bot flow which is exiting gracefully.
1 property
1 required
ConversationContentReaction
object
User reaction to public message.
2 properties
1 required
ConversationFormResponseComponent
object
A response component from a form
2 properties
2 required
ConversationContentCarousel
object
Carousel content object.
1 property
1 required
ConversationNotificationTemplateParameter
object
Template parameters for placeholders in template.
2 properties
1 required
ConversationContentStory
object
An ephemeral story.
3 properties
ConversationContentInteractiveApplication
object
InteractiveApplication content object.
4 properties
ConversationContentNotificationResponse
object
Inbound response to a notification, such as an Apple Invitations acceptance.
4 properties
2 required
ConversationEventPresence
object
A Presence event.
3 properties
1 required
ConversationContentReceivedReplyMessage
object
ReceivedReplyMessage content object.
5 properties
ConversationContentPaymentRequest
object
Payment Request object used to request payment from a customer.
9 properties
4 required
ConversationMessageContent
object
Message content element. If contentType = "Attachment" only one item is allowed.
20 properties
1 required
TextBotUserInputEvent
object
Settings for an input event to the bot flow indicating user input is available.
2 properties
2 required
TextBotFlowMilestone
object
3 properties
3 required
TextBotFlowLaunchResponse
object
Information related to a successful launch of a bot flow. The ID will be used in subsequent turn requests of the bot flow.
1 property
1 required
GenesysBotConnector
object
1 property
ConversationFormPageComponent
object
Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.
5 properties
ConversationContentWheelPicker
object
Wheel Picker object for representing single selection of selectable items.
2 properties
1 required
Limit
object
3 properties
TextBotFlowLaunchRequest
object
Settings for launching an instance of a bot flow.
6 properties
3 required
NuanceMixDlgSettings
object
2 properties
ConversationNotificationTemplateBody
object
Template body object.
2 properties
1 required
TextBotTextModeConstraints
object
Mode constraints to observe when operating on a bot flow.
2 properties
1 required
TextBotExitAction
object
Settings for a next-action of exiting the bot flow. Any output variables are available in the details.
6 properties
1 required
ConversationContentPaymentResponse
object
Payment response object representing the status of a payment transaction.
3 properties
2 required
ConversationContentCardAction
object
A card action that a user can take.
4 properties
ConversationFormPage
object
Form page object.
3 properties
2 required
PostTextMessage
object
3 properties
1 required
ConversationNotificationTemplateHeader
object
Template header object.
4 properties
1 required
ConversationPushFailedMessageReferences
object
References of failed messages requiring a push.
1 property
1 required
ConversationContentAttachment
object
Attachment object.
8 properties
1 required
ConversationContentQuickReply
object
Quick reply object.
5 properties
2 required
ConversationEventCoBrowse
object
A CoBrowse event.
3 properties
1 required
TextBotModeConstraints
object
Mode constraints to observe when operating on a bot flow.
1 property
TextBotsRichMediaInputEvent
object
RichMedia Input to the bot.
2 properties
TextBotWaitForInputAction
object
Settings for a next-action of waiting for additional user input and sending the data as an input action to the bot flow.
1 property
1 required
TextBotErrorInputEvent
object
Settings for an input event to the bot flow indicating an error has occurred.
2 properties
2 required
ConversationNotificationTemplateButton
object
Template button object
7 properties
2 required
TextBotPromptSegment
object
Data for a single bot flow prompt segment.
4 properties
2 required
ConversationContentRequiredContactField
object
Contact fields a merchant requires to complete a payment request.
1 property
1 required
ConversationContentListPickerSection
object
List Picker object for presenting a section of selectable items.
3 properties
ConversationContentIntroduction
object
Introduction content object.
4 properties
2 required
TextBotOutputPrompts
object
Prompt information related to a bot flow turn.
2 properties
1 required
TextBotDisconnectAction
object
Settings for a next-action of disconnecting, including the reason code for the disconnect.
4 properties
1 required
ConversationContentLineItem
object
Item included in an order.
4 properties
2 required
PostTextRequest
object
14 properties
4 required
ConversationContentPush
object
A Push object
7 properties
7 required
ConversationEventTyping
object
A Typing event.
2 properties
1 required
TextBotUserAgent
object
Information about the caller executing a bot flow.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Genesys publishes across the network.
