Package com.mypurecloud.sdk.v2.model

Class OutgoingMessageRequest

java.lang.Object
com.mypurecloud.sdk.v2.model.OutgoingMessageRequest
All Implemented Interfaces:
Serializable
public class OutgoingMessageRequest extends Object implements Serializable
Outgoing Message request
See Also:

  • Constructor Details

    • OutgoingMessageRequest

      public OutgoingMessageRequest()

    • OutgoingMessageRequest

      public OutgoingMessageRequest(Boolean initWithEmptyList)

  • Method Details

    • botId

      public OutgoingMessageRequest botId(String botId)
      The unique id of the bot.

    • getBotId

      public String getBotId()

    • setBotId

      public void setBotId(String botId)

    • botVersion

      public OutgoingMessageRequest botVersion(String botVersion)
      The version of the bot.

    • getBotVersion

      public String getBotVersion()

    • setBotVersion

      public void setBotVersion(String botVersion)

    • botSessionId

      public OutgoingMessageRequest 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)

    • botState

      public OutgoingMessageRequest botState(OutgoingMessageRequest.BotStateEnum botState)
      The state of the bot reported

    • getBotState

      public OutgoingMessageRequest.BotStateEnum getBotState()

    • setBotState

      public void setBotState(OutgoingMessageRequest.BotStateEnum botState)

    • languageCode

      public OutgoingMessageRequest languageCode(String languageCode)
      The language used for this message. 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).

    • getLanguageCode

      public String getLanguageCode()

    • setLanguageCode

      public void setLanguageCode(String languageCode)

    • replyMessages

      public OutgoingMessageRequest replyMessages(List<ReplyMessage> replyMessages)
      This is a list of messages to send back to the user, this field can be null or an empty list.

    • getReplyMessages

      public List<ReplyMessage> getReplyMessages()

    • setReplyMessages

      public void setReplyMessages(List<ReplyMessage> replyMessages)

    • intent

      public OutgoingMessageRequest intent(String intent)
      The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected.

    • getIntent

      public String getIntent()

    • setIntent

      public void setIntent(String intent)

    • confidence

      public OutgoingMessageRequest confidence(Double confidence)
      A value between 0 and 1.0 denoting the confidence of the discovered intent (if found) this is optional and if left null genesys assumes a confidence of 1.0 on success and 0 on fail.

    • getConfidence

      public Double getConfidence()

    • setConfidence

      public void setConfidence(Double confidence)

    • errorInfo

      public OutgoingMessageRequest errorInfo(ErrorInfo errorInfo)
      If the botState is Failed the bot can add this error object with more details about the error.

    • getErrorInfo

      public ErrorInfo getErrorInfo()

    • setErrorInfo

      public void setErrorInfo(ErrorInfo errorInfo)

    • parameters

      public OutgoingMessageRequest parameters(Map<String,String> parameters)
      This is a map of string-string key, value pairs containing optional fields that can be passed from the bot for custom behavior, tracking, etc, which can be used by the flow.

    • getParameters

      public Map<String,String> getParameters()

    • setParameters

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

    • entities

      public OutgoingMessageRequest entities(List<BotEntityValue> entities)
      A set of entity values that go along with the intent.

    • getEntities

      public List<BotEntityValue> getEntities()

    • setEntities

      public void setEntities(List<BotEntityValue> entities)

    • 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