Package com.mypurecloud.sdk.v2.api

Class TextbotsApiAsync

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

  • Constructor Details

    • TextbotsApiAsync

      public TextbotsApiAsync()

    • TextbotsApiAsync

      public TextbotsApiAsync(ApiClient apiClient)

  • Method Details

    • getTextbotsBotsSearchAsync

      public Future<BotSearchResponseEntityListing> getTextbotsBotsSearchAsync(GetTextbotsBotsSearchRequest request, AsyncApiCallback<BotSearchResponseEntityListing> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getTextbotsBotsSearchAsync

      public Future<ApiResponse<BotSearchResponseEntityListing>> getTextbotsBotsSearchAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<BotSearchResponseEntityListing>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotflowsSessionTurnsAsync

      public Future<TextBotFlowTurnResponse> postTextbotsBotflowsSessionTurnsAsync(PostTextbotsBotflowsSessionTurnsRequest request, AsyncApiCallback<TextBotFlowTurnResponse> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotflowsSessionTurnsAsync

      public Future<ApiResponse<TextBotFlowTurnResponse>> postTextbotsBotflowsSessionTurnsAsync(ApiRequest<TextBotFlowTurnRequest> request, AsyncApiCallback<ApiResponse<TextBotFlowTurnResponse>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotflowsSessionsAsync

      public Future<TextBotFlowLaunchResponse> postTextbotsBotflowsSessionsAsync(PostTextbotsBotflowsSessionsRequest request, AsyncApiCallback<TextBotFlowLaunchResponse> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotflowsSessionsAsync

      public Future<ApiResponse<TextBotFlowLaunchResponse>> postTextbotsBotflowsSessionsAsync(ApiRequest<TextBotFlowLaunchRequest> request, AsyncApiCallback<ApiResponse<TextBotFlowLaunchResponse>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotsExecuteAsync

      public Future<PostTextResponse> postTextbotsBotsExecuteAsync(PostTextbotsBotsExecuteRequest request, AsyncApiCallback<PostTextResponse> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postTextbotsBotsExecuteAsync

      public Future<ApiResponse<PostTextResponse>> postTextbotsBotsExecuteAsync(ApiRequest<PostTextRequest> request, AsyncApiCallback<ApiResponse<PostTextResponse>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed