Package com.mypurecloud.sdk.v2.model

Class IncomingMessageRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.IncomingMessageRequest

All Implemented Interfaces:

Serializable

public class IncomingMessageRequest
extends Object
implements Serializable

Incoming Message request

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IncomingMessageRequest.ChannelsEnum	Gets or Sets channels
static enum	IncomingMessageRequest.MessagingPlatformTypeEnum	Type of messaging platform being used

Constructor Summary

Constructors

Constructor	Description
IncomingMessageRequest()
IncomingMessageRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
IncomingMessageRequest	automateFlowExecId(String automateFlowExecId)	Execution ID of the Automate Flow.
IncomingMessageRequest	botId(String botId)	The unique id of the bot.
IncomingMessageRequest	botName(String botName)	Name of the bot
IncomingMessageRequest	botSessionId(String botSessionId)	The id of the session.
IncomingMessageRequest	botSessionTimeout(Integer botSessionTimeout)	Timeout duration for bot session in minutes.
IncomingMessageRequest	botVersion(String botVersion)	The version of the bot.
IncomingMessageRequest	channels(List<IncomingMessageRequest.ChannelsEnum> channels)	The channels this bot is utilizing.
IncomingMessageRequest	conversationId(String conversationId)	Genesys conversation ID.
boolean	equals(Object o)
String	getAutomateFlowExecId()
String	getBotId()
String	getBotName()
String	getBotSessionId()
Integer	getBotSessionTimeout()
String	getBotVersion()
List<IncomingMessageRequest.ChannelsEnum>	getChannels()
String	getConversationId()
InputMessage	getInputMessage()
String	getIntegrationId()
String	getLanguageCode()
IncomingMessageRequest.MessagingPlatformTypeEnum	getMessagingPlatformType()
Map<String,String>	getParameters()
int	hashCode()
IncomingMessageRequest	inputMessage(InputMessage inputMessage)	Message received from the user to send to the bot
IncomingMessageRequest	integrationId(String integrationId)	The Integration Id for the bot's configuration
IncomingMessageRequest	languageCode(String languageCode)	Language code for the conversation (e.g., 'en-US').
IncomingMessageRequest	messagingPlatformType(IncomingMessageRequest.MessagingPlatformTypeEnum messagingPlatformType)	Type of messaging platform being used
IncomingMessageRequest	parameters(Map<String,String> parameters)	This is a map of string-string key, value pairs containing optional fields that can be passed to the bot for custom behavior, tracking, etc.
void	setAutomateFlowExecId(String automateFlowExecId)
void	setBotId(String botId)
void	setBotName(String botName)
void	setBotSessionId(String botSessionId)
void	setBotSessionTimeout(Integer botSessionTimeout)
void	setBotVersion(String botVersion)
void	setChannels(List<IncomingMessageRequest.ChannelsEnum> channels)
void	setConversationId(String conversationId)
void	setInputMessage(InputMessage inputMessage)
void	setIntegrationId(String integrationId)
void	setLanguageCode(String languageCode)
void	setMessagingPlatformType(IncomingMessageRequest.MessagingPlatformTypeEnum messagingPlatformType)
void	setParameters(Map<String,String> parameters)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IncomingMessageRequest

public IncomingMessageRequest()

IncomingMessageRequest

public IncomingMessageRequest(Boolean initWithEmptyList)

Method Details

botId

public IncomingMessageRequest botId(String botId)

The unique id of the bot.

getBotId

public String getBotId()

setBotId

public void setBotId(String botId)

botName

public IncomingMessageRequest botName(String botName)

Name of the bot

getBotName

public String getBotName()

setBotName

public void setBotName(String botName)

botVersion

public IncomingMessageRequest botVersion(String botVersion)

The version of the bot.

getBotVersion

public String getBotVersion()

setBotVersion

public void setBotVersion(String botVersion)

integrationId

public IncomingMessageRequest integrationId(String integrationId)

The Integration Id for the bot's configuration

getIntegrationId

public String getIntegrationId()

setIntegrationId

public void setIntegrationId(String integrationId)

botSessionId

public IncomingMessageRequest botSessionId(String botSessionId)

The id of the session. This id will be used for an entire conversation with the bot (a series of back and forth between the bot until the bot has fulfilled its intent).

getBotSessionId

public String getBotSessionId()

setBotSessionId

public void setBotSessionId(String botSessionId)

automateFlowExecId

public IncomingMessageRequest automateFlowExecId(String automateFlowExecId)

Execution ID of the Automate Flow.

getAutomateFlowExecId

public String getAutomateFlowExecId()

setAutomateFlowExecId

public void setAutomateFlowExecId(String automateFlowExecId)

conversationId

public IncomingMessageRequest conversationId(String conversationId)

Genesys conversation ID.

getConversationId

public String getConversationId()

setConversationId

public void setConversationId(String conversationId)

languageCode

public IncomingMessageRequest languageCode(String languageCode)

Language code for the conversation (e.g., 'en-US').

getLanguageCode

public String getLanguageCode()

setLanguageCode

public void setLanguageCode(String languageCode)

inputMessage

public IncomingMessageRequest inputMessage(InputMessage inputMessage)

Message received from the user to send to the bot

getInputMessage

public InputMessage getInputMessage()

setInputMessage

public void setInputMessage(InputMessage inputMessage)

messagingPlatformType

public IncomingMessageRequest messagingPlatformType(IncomingMessageRequest.MessagingPlatformTypeEnum messagingPlatformType)

Type of messaging platform being used

getMessagingPlatformType

public IncomingMessageRequest.MessagingPlatformTypeEnum getMessagingPlatformType()

setMessagingPlatformType

public void setMessagingPlatformType(IncomingMessageRequest.MessagingPlatformTypeEnum messagingPlatformType)

channels

public IncomingMessageRequest channels(List<IncomingMessageRequest.ChannelsEnum> channels)

The channels this bot is utilizing.

getChannels

public List<IncomingMessageRequest.ChannelsEnum> getChannels()

setChannels

public void setChannels(List<IncomingMessageRequest.ChannelsEnum> channels)

botSessionTimeout

public IncomingMessageRequest botSessionTimeout(Integer botSessionTimeout)

Timeout duration for bot session in minutes.

getBotSessionTimeout

public Integer getBotSessionTimeout()

setBotSessionTimeout

public void setBotSessionTimeout(Integer botSessionTimeout)

parameters

public IncomingMessageRequest parameters(Map<String,String> parameters)

This is a map of string-string key, value pairs containing optional fields that can be passed to the bot for custom behavior, tracking, etc.

getParameters

public Map<String,String> getParameters()

setParameters

public void setParameters(Map<String,String> parameters)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object