Package com.mypurecloud.sdk.v2.api

Class WebChatApi

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

  • Constructor Details

    • WebChatApi

      public WebChatApi()

    • WebChatApi

      public WebChatApi(ApiClient apiClient)

  • Method Details

    • deleteWebchatDeployment

      public void deleteWebchatDeployment(String deploymentId) throws IOException, ApiException
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatDeploymentWithHttpInfo

      public ApiResponse<Void> deleteWebchatDeploymentWithHttpInfo(String deploymentId) throws IOException
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWebchatDeployment

      public void deleteWebchatDeployment(DeleteWebchatDeploymentRequest request) throws IOException, ApiException
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatDeployment

      public ApiResponse<Void> deleteWebchatDeployment(ApiRequest<Void> request) throws IOException
      Deprecated.
      Delete a WebChat deployment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWebchatGuestConversationMember

      public void deleteWebchatGuestConversationMember(String conversationId, String memberId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatGuestConversationMemberWithHttpInfo

      public ApiResponse<Void> deleteWebchatGuestConversationMemberWithHttpInfo(String conversationId, String memberId) throws IOException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWebchatGuestConversationMember

      public void deleteWebchatGuestConversationMember(DeleteWebchatGuestConversationMemberRequest request) throws IOException, ApiException
      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
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatGuestConversationMember

      public ApiResponse<Void> deleteWebchatGuestConversationMember(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWebchatSettings

      public void deleteWebchatSettings() throws IOException, ApiException
      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.
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatSettingsWithHttpInfo

      public ApiResponse<Void> deleteWebchatSettingsWithHttpInfo() throws IOException
      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.
      Throws:
      IOException - if the request fails to be processed

    • deleteWebchatSettings

      public void deleteWebchatSettings(DeleteWebchatSettingsRequest request) throws IOException, ApiException
      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
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWebchatSettings

      public ApiResponse<Void> deleteWebchatSettings(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatDeployment

      public WebChatDeployment getWebchatDeployment(String deploymentId) throws IOException, ApiException
      Deprecated.
      Get a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatDeploymentWithHttpInfo

      public ApiResponse<WebChatDeployment> getWebchatDeploymentWithHttpInfo(String deploymentId) throws IOException
      Deprecated.
      Get a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      Returns:
      WebChatDeployment
      Throws:
      IOException - if the request fails to be processed

    • getWebchatDeployment

      public WebChatDeployment getWebchatDeployment(GetWebchatDeploymentRequest request) throws IOException, ApiException
      Deprecated.
      Get a WebChat deployment
      Parameters:
      request - The request object
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatDeployment

      public ApiResponse<WebChatDeployment> getWebchatDeployment(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a WebChat deployment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatDeployments

      public WebChatDeploymentEntityListing getWebchatDeployments() throws IOException, ApiException
      Deprecated.
      List WebChat deployments
      Returns:
      WebChatDeploymentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatDeploymentsWithHttpInfo

      public ApiResponse<WebChatDeploymentEntityListing> getWebchatDeploymentsWithHttpInfo() throws IOException
      Deprecated.
      List WebChat deployments
      Returns:
      WebChatDeploymentEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getWebchatDeployments

      public WebChatDeploymentEntityListing getWebchatDeployments(GetWebchatDeploymentsRequest request) throws IOException, ApiException
      Deprecated.
      List WebChat deployments
      Parameters:
      request - The request object
      Returns:
      WebChatDeploymentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatDeployments

      public ApiResponse<WebChatDeploymentEntityListing> getWebchatDeployments(ApiRequest<Void> request) throws IOException
      Deprecated.
      List WebChat deployments
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequest

      public WebChatGuestMediaRequest getWebchatGuestConversationMediarequest(String conversationId, String mediaRequestId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      mediaRequestId - mediaRequestId (required)
      Returns:
      WebChatGuestMediaRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequestWithHttpInfo

      public ApiResponse<WebChatGuestMediaRequest> getWebchatGuestConversationMediarequestWithHttpInfo(String conversationId, String mediaRequestId) throws IOException
      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:
      conversationId - conversationId (required)
      mediaRequestId - mediaRequestId (required)
      Returns:
      WebChatGuestMediaRequest
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequest

      public WebChatGuestMediaRequest getWebchatGuestConversationMediarequest(GetWebchatGuestConversationMediarequestRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatGuestMediaRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequest

      public ApiResponse<WebChatGuestMediaRequest> getWebchatGuestConversationMediarequest(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequests

      public WebChatGuestMediaRequestEntityList getWebchatGuestConversationMediarequests(String conversationId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      Returns:
      WebChatGuestMediaRequestEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequestsWithHttpInfo

      public ApiResponse<WebChatGuestMediaRequestEntityList> getWebchatGuestConversationMediarequestsWithHttpInfo(String conversationId) throws IOException
      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:
      conversationId - conversationId (required)
      Returns:
      WebChatGuestMediaRequestEntityList
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequests

      public WebChatGuestMediaRequestEntityList getWebchatGuestConversationMediarequests(GetWebchatGuestConversationMediarequestsRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatGuestMediaRequestEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMediarequests

      public ApiResponse<WebChatGuestMediaRequestEntityList> getWebchatGuestConversationMediarequests(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMember

      public WebChatMemberInfo getWebchatGuestConversationMember(String conversationId, String memberId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Returns:
      WebChatMemberInfo
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMemberWithHttpInfo

      public ApiResponse<WebChatMemberInfo> getWebchatGuestConversationMemberWithHttpInfo(String conversationId, String memberId) throws IOException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Returns:
      WebChatMemberInfo
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMember

      public WebChatMemberInfo getWebchatGuestConversationMember(GetWebchatGuestConversationMemberRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatMemberInfo
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMember

      public ApiResponse<WebChatMemberInfo> getWebchatGuestConversationMember(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMembers

      public WebChatMemberInfoEntityList getWebchatGuestConversationMembers(String conversationId, Integer pageSize, Integer pageNumber, Boolean excludeDisconnectedMembers) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      pageSize - The number of entries to return per page, or omitted for the default. (optional, default to 25)
      pageNumber - The page number to return, or omitted for the first page. (optional, default to 1)
      excludeDisconnectedMembers - If true, the results will not contain members who have a DISCONNECTED state. (optional, default to false)
      Returns:
      WebChatMemberInfoEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMembersWithHttpInfo

      public ApiResponse<WebChatMemberInfoEntityList> getWebchatGuestConversationMembersWithHttpInfo(String conversationId, Integer pageSize, Integer pageNumber, Boolean excludeDisconnectedMembers) throws IOException
      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:
      conversationId - conversationId (required)
      pageSize - The number of entries to return per page, or omitted for the default. (optional, default to 25)
      pageNumber - The page number to return, or omitted for the first page. (optional, default to 1)
      excludeDisconnectedMembers - If true, the results will not contain members who have a DISCONNECTED state. (optional, default to false)
      Returns:
      WebChatMemberInfoEntityList
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMembers

      public WebChatMemberInfoEntityList getWebchatGuestConversationMembers(GetWebchatGuestConversationMembersRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatMemberInfoEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMembers

      public ApiResponse<WebChatMemberInfoEntityList> getWebchatGuestConversationMembers(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessage

      public WebChatMessage getWebchatGuestConversationMessage(String conversationId, String messageId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      messageId - messageId (required)
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessageWithHttpInfo

      public ApiResponse<WebChatMessage> getWebchatGuestConversationMessageWithHttpInfo(String conversationId, String messageId) throws IOException
      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:
      conversationId - conversationId (required)
      messageId - messageId (required)
      Returns:
      WebChatMessage
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessage

      public WebChatMessage getWebchatGuestConversationMessage(GetWebchatGuestConversationMessageRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessage

      public ApiResponse<WebChatMessage> getWebchatGuestConversationMessage(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessages

      public WebChatMessageEntityList getWebchatGuestConversationMessages(String conversationId, String after, String before, String sortOrder, Integer maxResults) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      after - If available, get the messages chronologically after the id of this message (optional)
      before - If available, get the messages chronologically before the id of this message (optional)
      sortOrder - Sort order (optional, default to ascending)
      maxResults - Limit the returned number of messages, up to a maximum of 100 (optional, default to 100)
      Returns:
      WebChatMessageEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessagesWithHttpInfo

      public ApiResponse<WebChatMessageEntityList> getWebchatGuestConversationMessagesWithHttpInfo(String conversationId, String after, String before, String sortOrder, Integer maxResults) throws IOException
      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:
      conversationId - conversationId (required)
      after - If available, get the messages chronologically after the id of this message (optional)
      before - If available, get the messages chronologically before the id of this message (optional)
      sortOrder - Sort order (optional, default to ascending)
      maxResults - Limit the returned number of messages, up to a maximum of 100 (optional, default to 100)
      Returns:
      WebChatMessageEntityList
      Throws:
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessages

      public WebChatMessageEntityList getWebchatGuestConversationMessages(GetWebchatGuestConversationMessagesRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatMessageEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatGuestConversationMessages

      public ApiResponse<WebChatMessageEntityList> getWebchatGuestConversationMessages(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWebchatSettings

      public WebChatSettings getWebchatSettings() throws IOException, ApiException
      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.
      Returns:
      WebChatSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatSettingsWithHttpInfo

      public ApiResponse<WebChatSettings> getWebchatSettingsWithHttpInfo() throws IOException
      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.
      Returns:
      WebChatSettings
      Throws:
      IOException - if the request fails to be processed

    • getWebchatSettings

      public WebChatSettings getWebchatSettings(GetWebchatSettingsRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWebchatSettings

      public ApiResponse<WebChatSettings> getWebchatSettings(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWebchatGuestConversationMediarequest

      public WebChatGuestMediaRequest patchWebchatGuestConversationMediarequest(String conversationId, String mediaRequestId, WebChatGuestMediaRequest body) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      mediaRequestId - mediaRequestId (required)
      body - Request (required)
      Returns:
      WebChatGuestMediaRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWebchatGuestConversationMediarequestWithHttpInfo

      public ApiResponse<WebChatGuestMediaRequest> patchWebchatGuestConversationMediarequestWithHttpInfo(String conversationId, String mediaRequestId, WebChatGuestMediaRequest body) throws IOException
      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:
      conversationId - conversationId (required)
      mediaRequestId - mediaRequestId (required)
      body - Request (required)
      Returns:
      WebChatGuestMediaRequest
      Throws:
      IOException - if the request fails to be processed

    • patchWebchatGuestConversationMediarequest

      public WebChatGuestMediaRequest patchWebchatGuestConversationMediarequest(PatchWebchatGuestConversationMediarequestRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatGuestMediaRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWebchatGuestConversationMediarequest

      public ApiResponse<WebChatGuestMediaRequest> patchWebchatGuestConversationMediarequest(ApiRequest<WebChatGuestMediaRequest> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWebchatDeployments

      public WebChatDeployment postWebchatDeployments(WebChatDeployment body) throws IOException, ApiException
      Deprecated.
      Create WebChat deployment
      Parameters:
      body - Deployment (required)
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatDeploymentsWithHttpInfo

      public ApiResponse<WebChatDeployment> postWebchatDeploymentsWithHttpInfo(WebChatDeployment body) throws IOException
      Deprecated.
      Create WebChat deployment
      Parameters:
      body - Deployment (required)
      Returns:
      WebChatDeployment
      Throws:
      IOException - if the request fails to be processed

    • postWebchatDeployments

      public WebChatDeployment postWebchatDeployments(PostWebchatDeploymentsRequest request) throws IOException, ApiException
      Deprecated.
      Create WebChat deployment
      Parameters:
      request - The request object
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatDeployments

      public ApiResponse<WebChatDeployment> postWebchatDeployments(ApiRequest<WebChatDeployment> request) throws IOException
      Deprecated.
      Create WebChat deployment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberMessages

      public WebChatMessage postWebchatGuestConversationMemberMessages(String conversationId, String memberId, CreateWebChatMessageRequest body) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      body - Message (required)
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberMessagesWithHttpInfo

      public ApiResponse<WebChatMessage> postWebchatGuestConversationMemberMessagesWithHttpInfo(String conversationId, String memberId, CreateWebChatMessageRequest body) throws IOException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      body - Message (required)
      Returns:
      WebChatMessage
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberMessages

      public WebChatMessage postWebchatGuestConversationMemberMessages(PostWebchatGuestConversationMemberMessagesRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberMessages

      public ApiResponse<WebChatMessage> postWebchatGuestConversationMemberMessages(ApiRequest<CreateWebChatMessageRequest> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberTyping

      public WebChatTyping postWebchatGuestConversationMemberTyping(String conversationId, String memberId) throws IOException, ApiException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Returns:
      WebChatTyping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberTypingWithHttpInfo

      public ApiResponse<WebChatTyping> postWebchatGuestConversationMemberTypingWithHttpInfo(String conversationId, String memberId) throws IOException
      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:
      conversationId - conversationId (required)
      memberId - memberId (required)
      Returns:
      WebChatTyping
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberTyping

      public WebChatTyping postWebchatGuestConversationMemberTyping(PostWebchatGuestConversationMemberTypingRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatTyping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversationMemberTyping

      public ApiResponse<WebChatTyping> postWebchatGuestConversationMemberTyping(ApiRequest<Void> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversations

      public CreateWebChatConversationResponse postWebchatGuestConversations(CreateWebChatConversationRequest body) throws IOException, ApiException
      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:
      body - CreateConversationRequest (required)
      Returns:
      CreateWebChatConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversationsWithHttpInfo

      public ApiResponse<CreateWebChatConversationResponse> postWebchatGuestConversationsWithHttpInfo(CreateWebChatConversationRequest body) throws IOException
      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:
      body - CreateConversationRequest (required)
      Returns:
      CreateWebChatConversationResponse
      Throws:
      IOException - if the request fails to be processed

    • postWebchatGuestConversations

      public CreateWebChatConversationResponse postWebchatGuestConversations(PostWebchatGuestConversationsRequest request) throws IOException, ApiException
      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
      Returns:
      CreateWebChatConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWebchatGuestConversations

      public ApiResponse<CreateWebChatConversationResponse> postWebchatGuestConversations(ApiRequest<CreateWebChatConversationRequest> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putWebchatDeployment

      public WebChatDeployment putWebchatDeployment(String deploymentId, WebChatDeployment body) throws IOException, ApiException
      Deprecated.
      Update a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      body - Deployment (required)
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWebchatDeploymentWithHttpInfo

      public ApiResponse<WebChatDeployment> putWebchatDeploymentWithHttpInfo(String deploymentId, WebChatDeployment body) throws IOException
      Deprecated.
      Update a WebChat deployment
      Parameters:
      deploymentId - Deployment Id (required)
      body - Deployment (required)
      Returns:
      WebChatDeployment
      Throws:
      IOException - if the request fails to be processed

    • putWebchatDeployment

      public WebChatDeployment putWebchatDeployment(PutWebchatDeploymentRequest request) throws IOException, ApiException
      Deprecated.
      Update a WebChat deployment
      Parameters:
      request - The request object
      Returns:
      WebChatDeployment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWebchatDeployment

      public ApiResponse<WebChatDeployment> putWebchatDeployment(ApiRequest<WebChatDeployment> request) throws IOException
      Deprecated.
      Update a WebChat deployment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putWebchatSettings

      public WebChatSettings putWebchatSettings(WebChatSettings body) throws IOException, ApiException
      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:
      body - webChatSettings (required)
      Returns:
      WebChatSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWebchatSettingsWithHttpInfo

      public ApiResponse<WebChatSettings> putWebchatSettingsWithHttpInfo(WebChatSettings body) throws IOException
      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:
      body - webChatSettings (required)
      Returns:
      WebChatSettings
      Throws:
      IOException - if the request fails to be processed

    • putWebchatSettings

      public WebChatSettings putWebchatSettings(PutWebchatSettingsRequest request) throws IOException, ApiException
      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
      Returns:
      WebChatSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWebchatSettings

      public ApiResponse<WebChatSettings> putWebchatSettings(ApiRequest<WebChatSettings> request) throws IOException
      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
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed