Package com.novomind.ecom.api.iagent.model

Interface ChatBot

All Superinterfaces:
CategoryAssigned, Comparable<com.novomind.ecom.common.api.persistence.Entity>, com.novomind.ecom.common.api.attribute.Described, com.novomind.ecom.common.api.persistence.Entity, MasterEntity, com.novomind.ecom.common.api.attribute.Named, TenantProvider
public interface ChatBot extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, com.novomind.ecom.common.api.attribute.Described, CategoryAssigned, TenantProvider
Represents a chatbot
Since:
12.21

  • Method Summary

    Modifier and Type
    Method
    Description
    Long
    getAgentRoutingTimeout()
    Get the chatbot agentRoutingTimeout in seconds.
    Long
    getBotRoutingTimeout()
    Get the chatbot botRoutingTimeout in seconds Determines the wait time for a chatbot that is no longer reachable before it gets rerouted to an agent.
    Long
    getInactivityTimeout()
    Get the chatbot inactivityTimeout in seconds.
    String
    getKnowledgeBaseAgentName()
    Get the name of the knowledgebase agent used for this chatbot.
    String
    getNickname()
    Get the chatbot nickname.
    String
    getRestUrl()
    Get the chatbot restUrl.
    Long
    getRouteToAgentTimeout()
    Get the chatbot routeToAgentTimeout in seconds If a previous customer chat was assigned to an agent, a following chat from the same customer will get routed to an agent in this time period
    boolean
    isEnabled()
    Get the chatbot enabled value which represents, whether the chatbot is currently activated.
    boolean
    isSendTypingEnabled()
    Get the sendTypingEnabled value which represents, whether the chatbot simulates typing events for compatible messengers.

    Methods inherited from interface com.novomind.ecom.api.iagent.assignment.CategoryAssigned

    getAssignedCategories

    Methods inherited from interface com.novomind.ecom.common.api.attribute.Described

    getDescription

    Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity

    compareTo, getId, isDeleted, isNotDeleted

    Methods inherited from interface com.novomind.ecom.common.api.attribute.Named

    getName

    Methods inherited from interface com.novomind.ecom.api.iagent.provider.TenantProvider

    getTenant

  • Method Details

    • isEnabled

      boolean isEnabled()
      Get the chatbot enabled value which represents, whether the chatbot is currently activated.
      Returns:
      the enabled value as boolean
      Since:
      12.21

    • getNickname

      String getNickname()
      Get the chatbot nickname.
      Returns:
      the nickname as String If no nickname is defined (empty string) the system setting or default nickname will be used.
      Since:
      12.21

    • getRestUrl

      String getRestUrl()
      Get the chatbot restUrl.
      Returns:
      the restUrl as String
      Since:
      12.21

    • getKnowledgeBaseAgentName

      String getKnowledgeBaseAgentName()
      Get the name of the knowledgebase agent used for this chatbot.
      Returns:
      the knowledgeBaseAgentName as String If the returned value is an empty string, the default agent will be used.
      Since:
      12.21

    • getInactivityTimeout

      Long getInactivityTimeout()
      Get the chatbot inactivityTimeout in seconds. The wait time that determines when inactive chatbot chats should be automatically closed.
      Returns:
      the inactivityTimeout as Long or null, if the timeout is inactive
      Since:
      12.21

    • getRouteToAgentTimeout

      Long getRouteToAgentTimeout()
      Get the chatbot routeToAgentTimeout in seconds If a previous customer chat was assigned to an agent, a following chat from the same customer will get routed to an agent in this time period
      Returns:
      the routeToAgentTimeout as Long or null, if the timeout is inactive
      Since:
      12.21

    • getBotRoutingTimeout

      Long getBotRoutingTimeout()
      Get the chatbot botRoutingTimeout in seconds Determines the wait time for a chatbot that is no longer reachable before it gets rerouted to an agent.
      Returns:
      the botRoutingTimeout as Long or null, if the timeout is inactive
      Since:
      12.21

    • getAgentRoutingTimeout

      Long getAgentRoutingTimeout()
      Get the chatbot agentRoutingTimeout in seconds. If no agent accepts the chat which was handed over by the chatbot within the specified timeframe, the chat will be returned to the chatbot.
      Returns:
      the agentRoutingTimeout as Long or null, if the timeout is inactive
      Since:
      12.21

    • isSendTypingEnabled

      boolean isSendTypingEnabled()
      Get the sendTypingEnabled value which represents, whether the chatbot simulates typing events for compatible messengers.
      Returns:
      the sendTypingEnabled value as boolean
      Since:
      12.21