Package com.mypurecloud.sdk.v2.api

Class WebChatApiAsync

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

  • Constructor Details

    • WebChatApiAsync

      public WebChatApiAsync()

    • WebChatApiAsync

      public WebChatApiAsync(ApiClient apiClient)

  • Method Details

    • deleteWebchatDeploymentAsync

      public Future<Void> deleteWebchatDeploymentAsync(DeleteWebchatDeploymentRequest request, AsyncApiCallback<Void> callback)
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteWebchatDeploymentAsync

      public Future<ApiResponse<Void>> deleteWebchatDeploymentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteWebchatGuestConversationMemberAsync

      public Future<Void> deleteWebchatGuestConversationMemberAsync(DeleteWebchatGuestConversationMemberRequest request, AsyncApiCallback<Void> callback)
      Deprecated.
      Remove a member from a chat conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteWebchatGuestConversationMemberAsync

      public Future<ApiResponse<Void>> deleteWebchatGuestConversationMemberAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Deprecated.
      Remove a member from a chat conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteWebchatSettingsAsync

      public Future<Void> deleteWebchatSettingsAsync(DeleteWebchatSettingsRequest request, AsyncApiCallback<Void> callback)
      Deprecated.
      Remove WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteWebchatSettingsAsync

      public Future<ApiResponse<Void>> deleteWebchatSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Deprecated.
      Remove WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatDeploymentAsync

      public Future<WebChatDeployment> getWebchatDeploymentAsync(GetWebchatDeploymentRequest request, AsyncApiCallback<WebChatDeployment> callback)
      Deprecated.
      Get a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatDeploymentAsync

      public Future<ApiResponse<WebChatDeployment>> getWebchatDeploymentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatDeployment>> callback)
      Deprecated.
      Get a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatDeploymentsAsync

      public Future<WebChatDeploymentEntityListing> getWebchatDeploymentsAsync(GetWebchatDeploymentsRequest request, AsyncApiCallback<WebChatDeploymentEntityListing> callback)
      Deprecated.
      List WebChat deployments
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatDeploymentsAsync

      public Future<ApiResponse<WebChatDeploymentEntityListing>> getWebchatDeploymentsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatDeploymentEntityListing>> callback)
      Deprecated.
      List WebChat deployments
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMediarequestAsync

      public Future<WebChatGuestMediaRequest> getWebchatGuestConversationMediarequestAsync(GetWebchatGuestConversationMediarequestRequest request, AsyncApiCallback<WebChatGuestMediaRequest> callback)
      Deprecated.
      Get a media request in the conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMediarequestAsync

      public Future<ApiResponse<WebChatGuestMediaRequest>> getWebchatGuestConversationMediarequestAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatGuestMediaRequest>> callback)
      Deprecated.
      Get a media request in the conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMediarequestsAsync

      public Future<WebChatGuestMediaRequestEntityList> getWebchatGuestConversationMediarequestsAsync(GetWebchatGuestConversationMediarequestsRequest request, AsyncApiCallback<WebChatGuestMediaRequestEntityList> callback)
      Deprecated.
      Get all media requests to the guest in the conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMediarequestsAsync

      public Future<ApiResponse<WebChatGuestMediaRequestEntityList>> getWebchatGuestConversationMediarequestsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatGuestMediaRequestEntityList>> callback)
      Deprecated.
      Get all media requests to the guest in the conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMemberAsync

      public Future<WebChatMemberInfo> getWebchatGuestConversationMemberAsync(GetWebchatGuestConversationMemberRequest request, AsyncApiCallback<WebChatMemberInfo> callback)
      Deprecated.
      Get a web chat conversation member This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMemberAsync

      public Future<ApiResponse<WebChatMemberInfo>> getWebchatGuestConversationMemberAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatMemberInfo>> callback)
      Deprecated.
      Get a web chat conversation member This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMembersAsync

      public Future<WebChatMemberInfoEntityList> getWebchatGuestConversationMembersAsync(GetWebchatGuestConversationMembersRequest request, AsyncApiCallback<WebChatMemberInfoEntityList> callback)
      Deprecated.
      Get the members of a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMembersAsync

      public Future<ApiResponse<WebChatMemberInfoEntityList>> getWebchatGuestConversationMembersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatMemberInfoEntityList>> callback)
      Deprecated.
      Get the members of a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMessageAsync

      public Future<WebChatMessage> getWebchatGuestConversationMessageAsync(GetWebchatGuestConversationMessageRequest request, AsyncApiCallback<WebChatMessage> callback)
      Deprecated.
      Get a web chat conversation message This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMessageAsync

      public Future<ApiResponse<WebChatMessage>> getWebchatGuestConversationMessageAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatMessage>> callback)
      Deprecated.
      Get a web chat conversation message This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMessagesAsync

      public Future<WebChatMessageEntityList> getWebchatGuestConversationMessagesAsync(GetWebchatGuestConversationMessagesRequest request, AsyncApiCallback<WebChatMessageEntityList> callback)
      Deprecated.
      Get the messages of a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatGuestConversationMessagesAsync

      public Future<ApiResponse<WebChatMessageEntityList>> getWebchatGuestConversationMessagesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatMessageEntityList>> callback)
      Deprecated.
      Get the messages of a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatSettingsAsync

      public Future<WebChatSettings> getWebchatSettingsAsync(GetWebchatSettingsRequest request, AsyncApiCallback<WebChatSettings> callback)
      Deprecated.
      Get WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getWebchatSettingsAsync

      public Future<ApiResponse<WebChatSettings>> getWebchatSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatSettings>> callback)
      Deprecated.
      Get WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchWebchatGuestConversationMediarequestAsync

      public Future<WebChatGuestMediaRequest> patchWebchatGuestConversationMediarequestAsync(PatchWebchatGuestConversationMediarequestRequest request, AsyncApiCallback<WebChatGuestMediaRequest> callback)
      Deprecated.
      Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchWebchatGuestConversationMediarequestAsync

      public Future<ApiResponse<WebChatGuestMediaRequest>> patchWebchatGuestConversationMediarequestAsync(ApiRequest<WebChatGuestMediaRequest> request, AsyncApiCallback<ApiResponse<WebChatGuestMediaRequest>> callback)
      Deprecated.
      Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatDeploymentsAsync

      public Future<WebChatDeployment> postWebchatDeploymentsAsync(PostWebchatDeploymentsRequest request, AsyncApiCallback<WebChatDeployment> callback)
      Deprecated.
      Create WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatDeploymentsAsync

      public Future<ApiResponse<WebChatDeployment>> postWebchatDeploymentsAsync(ApiRequest<WebChatDeployment> request, AsyncApiCallback<ApiResponse<WebChatDeployment>> callback)
      Deprecated.
      Create WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationMemberMessagesAsync

      public Future<WebChatMessage> postWebchatGuestConversationMemberMessagesAsync(PostWebchatGuestConversationMemberMessagesRequest request, AsyncApiCallback<WebChatMessage> callback)
      Deprecated.
      Send a message in a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationMemberMessagesAsync

      public Future<ApiResponse<WebChatMessage>> postWebchatGuestConversationMemberMessagesAsync(ApiRequest<CreateWebChatMessageRequest> request, AsyncApiCallback<ApiResponse<WebChatMessage>> callback)
      Deprecated.
      Send a message in a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationMemberTypingAsync

      public Future<WebChatTyping> postWebchatGuestConversationMemberTypingAsync(PostWebchatGuestConversationMemberTypingRequest request, AsyncApiCallback<WebChatTyping> callback)
      Deprecated.
      Send a typing-indicator in a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationMemberTypingAsync

      public Future<ApiResponse<WebChatTyping>> postWebchatGuestConversationMemberTypingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WebChatTyping>> callback)
      Deprecated.
      Send a typing-indicator in a chat conversation. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationsAsync

      public Future<CreateWebChatConversationResponse> postWebchatGuestConversationsAsync(PostWebchatGuestConversationsRequest request, AsyncApiCallback<CreateWebChatConversationResponse> callback)
      Deprecated.
      Create an ACD chat conversation from an external customer. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postWebchatGuestConversationsAsync

      public Future<ApiResponse<CreateWebChatConversationResponse>> postWebchatGuestConversationsAsync(ApiRequest<CreateWebChatConversationRequest> request, AsyncApiCallback<ApiResponse<CreateWebChatConversationResponse>> callback)
      Deprecated.
      Create an ACD chat conversation from an external customer. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putWebchatDeploymentAsync

      public Future<WebChatDeployment> putWebchatDeploymentAsync(PutWebchatDeploymentRequest request, AsyncApiCallback<WebChatDeployment> callback)
      Deprecated.
      Update a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putWebchatDeploymentAsync

      public Future<ApiResponse<WebChatDeployment>> putWebchatDeploymentAsync(ApiRequest<WebChatDeployment> request, AsyncApiCallback<ApiResponse<WebChatDeployment>> callback)
      Deprecated.
      Update a WebChat deployment
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putWebchatSettingsAsync

      public Future<WebChatSettings> putWebchatSettingsAsync(PutWebchatSettingsRequest request, AsyncApiCallback<WebChatSettings> callback)
      Deprecated.
      Update WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putWebchatSettingsAsync

      public Future<ApiResponse<WebChatSettings>> putWebchatSettingsAsync(ApiRequest<WebChatSettings> request, AsyncApiCallback<ApiResponse<WebChatSettings>> callback)
      Deprecated.
      Update WebChat deployment settings This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed