Package com.mypurecloud.sdk.v2.api

Class TextbotsApi

java.lang.Object
com.mypurecloud.sdk.v2.api.TextbotsApi
public class TextbotsApi extends Object

  • Constructor Details

    • TextbotsApi

      public TextbotsApi()

    • TextbotsApi

      public TextbotsApi(ApiClient apiClient)

  • Method Details

    • getTextbotsBotsSearch

      public BotSearchResponseEntityListing getTextbotsBotsSearch(List<String> botType, String botName, List<String> botId, Boolean virtualAgentEnabled, Integer pageSize) throws IOException, ApiException
      Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
      Parameters:
      botType - Bot types (optional)
      botName - Bot name (optional)
      botId - Bot IDs. Maximum of 50 (optional)
      virtualAgentEnabled - Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows (optional)
      pageSize - The maximum results to return. Maximum of 100 (optional, default to 25)
      Returns:
      BotSearchResponseEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getTextbotsBotsSearchWithHttpInfo

      public ApiResponse<BotSearchResponseEntityListing> getTextbotsBotsSearchWithHttpInfo(List<String> botType, String botName, List<String> botId, Boolean virtualAgentEnabled, Integer pageSize) throws IOException
      Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
      Parameters:
      botType - Bot types (optional)
      botName - Bot name (optional)
      botId - Bot IDs. Maximum of 50 (optional)
      virtualAgentEnabled - Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows (optional)
      pageSize - The maximum results to return. Maximum of 100 (optional, default to 25)
      Returns:
      BotSearchResponseEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getTextbotsBotsSearch

      public BotSearchResponseEntityListing getTextbotsBotsSearch(GetTextbotsBotsSearchRequest request) throws IOException, ApiException
      Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
      Parameters:
      request - The request object
      Returns:
      BotSearchResponseEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getTextbotsBotsSearch

      public ApiResponse<BotSearchResponseEntityListing> getTextbotsBotsSearch(ApiRequest<Void> request) throws IOException
      Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessionTurns

      public TextBotFlowTurnResponse postTextbotsBotflowsSessionTurns(String sessionId, TextBotFlowTurnRequest turnRequest) throws IOException, ApiException
      Issue a bot flow turn event Send a turn event to an executing bot flow and produce the next action to take.
      Parameters:
      sessionId - The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions' (required)
      turnRequest - (required)
      Returns:
      TextBotFlowTurnResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessionTurnsWithHttpInfo

      public ApiResponse<TextBotFlowTurnResponse> postTextbotsBotflowsSessionTurnsWithHttpInfo(String sessionId, TextBotFlowTurnRequest turnRequest) throws IOException
      Issue a bot flow turn event Send a turn event to an executing bot flow and produce the next action to take.
      Parameters:
      sessionId - The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions' (required)
      turnRequest - (required)
      Returns:
      TextBotFlowTurnResponse
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessionTurns

      public TextBotFlowTurnResponse postTextbotsBotflowsSessionTurns(PostTextbotsBotflowsSessionTurnsRequest request) throws IOException, ApiException
      Issue a bot flow turn event Send a turn event to an executing bot flow and produce the next action to take.
      Parameters:
      request - The request object
      Returns:
      TextBotFlowTurnResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessionTurns

      public ApiResponse<TextBotFlowTurnResponse> postTextbotsBotflowsSessionTurns(ApiRequest<TextBotFlowTurnRequest> request) throws IOException
      Issue a bot flow turn event Send a turn event to an executing bot flow and produce the next action to take.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessions

      public TextBotFlowLaunchResponse postTextbotsBotflowsSessions(TextBotFlowLaunchRequest launchRequest) throws IOException, ApiException
      Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.
      Parameters:
      launchRequest - (required)
      Returns:
      TextBotFlowLaunchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessionsWithHttpInfo

      public ApiResponse<TextBotFlowLaunchResponse> postTextbotsBotflowsSessionsWithHttpInfo(TextBotFlowLaunchRequest launchRequest) throws IOException
      Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.
      Parameters:
      launchRequest - (required)
      Returns:
      TextBotFlowLaunchResponse
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessions

      public TextBotFlowLaunchResponse postTextbotsBotflowsSessions(PostTextbotsBotflowsSessionsRequest request) throws IOException, ApiException
      Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.
      Parameters:
      request - The request object
      Returns:
      TextBotFlowLaunchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotflowsSessions

      public ApiResponse<TextBotFlowLaunchResponse> postTextbotsBotflowsSessions(ApiRequest<TextBotFlowLaunchRequest> request) throws IOException
      Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotsExecute

      public PostTextResponse postTextbotsBotsExecute(PostTextRequest postTextRequest) throws IOException, ApiException
      Send an intent to a bot to start a dialog/interact with it via text This will either start a bot with the given id or relay a communication to an existing bot session.
      Parameters:
      postTextRequest - (required)
      Returns:
      PostTextResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotsExecuteWithHttpInfo

      public ApiResponse<PostTextResponse> postTextbotsBotsExecuteWithHttpInfo(PostTextRequest postTextRequest) throws IOException
      Send an intent to a bot to start a dialog/interact with it via text This will either start a bot with the given id or relay a communication to an existing bot session.
      Parameters:
      postTextRequest - (required)
      Returns:
      PostTextResponse
      Throws:
      IOException - if the request fails to be processed

    • postTextbotsBotsExecute

      public PostTextResponse postTextbotsBotsExecute(PostTextbotsBotsExecuteRequest request) throws IOException, ApiException
      Send an intent to a bot to start a dialog/interact with it via text This will either start a bot with the given id or relay a communication to an existing bot session.
      Parameters:
      request - The request object
      Returns:
      PostTextResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postTextbotsBotsExecute

      public ApiResponse<PostTextResponse> postTextbotsBotsExecute(ApiRequest<PostTextRequest> request) throws IOException
      Send an intent to a bot to start a dialog/interact with it via text This will either start a bot with the given id or relay a communication to an existing bot session.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed