Class ConversationsApi

java.lang.Object
com.mypurecloud.sdk.v2.api.ConversationsApi

public class ConversationsApi extends Object
  • Constructor Details

    • ConversationsApi

      public ConversationsApi()
    • ConversationsApi

      public ConversationsApi(ApiClient apiClient)
  • Method Details

    • deleteAnalyticsConversationsAggregatesJob

      public void deleteAnalyticsConversationsAggregatesJob(String jobId) throws IOException, ApiException
      Delete/cancel an async request for conversation aggregates
      Parameters:
      jobId - jobId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsAggregatesJobWithHttpInfo

      public ApiResponse<Void> deleteAnalyticsConversationsAggregatesJobWithHttpInfo(String jobId) throws IOException
      Delete/cancel an async request for conversation aggregates
      Parameters:
      jobId - jobId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsAggregatesJob

      public void deleteAnalyticsConversationsAggregatesJob(DeleteAnalyticsConversationsAggregatesJobRequest request) throws IOException, ApiException
      Delete/cancel an async request for conversation aggregates
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsAggregatesJob

      public ApiResponse<Void> deleteAnalyticsConversationsAggregatesJob(ApiRequest<Void> request) throws IOException
      Delete/cancel an async request for conversation aggregates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsDetailsJob

      public void deleteAnalyticsConversationsDetailsJob(String jobId) throws IOException, ApiException
      Delete/cancel an async details job
      Parameters:
      jobId - jobId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsDetailsJobWithHttpInfo

      public ApiResponse<Void> deleteAnalyticsConversationsDetailsJobWithHttpInfo(String jobId) throws IOException
      Delete/cancel an async details job
      Parameters:
      jobId - jobId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsDetailsJob

      public void deleteAnalyticsConversationsDetailsJob(DeleteAnalyticsConversationsDetailsJobRequest request) throws IOException, ApiException
      Delete/cancel an async details job
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteAnalyticsConversationsDetailsJob

      public ApiResponse<Void> deleteAnalyticsConversationsDetailsJob(ApiRequest<Void> request) throws IOException
      Delete/cancel an async details job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversation

      public void deleteConversation(String conversationId) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversation ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationWithHttpInfo

      public ApiResponse<Void> deleteConversationWithHttpInfo(String conversationId) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversation ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversation

      public void deleteConversation(DeleteConversationRequest request) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversation

      public ApiResponse<Void> deleteConversation(ApiRequest<Void> request) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationCustomattribute

      public void deleteConversationCustomattribute(String conversationId, String attributesId) throws IOException, ApiException
      Delete a custom attributes record.
      Parameters:
      conversationId - conversation ID (required)
      attributesId - attributesId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationCustomattributeWithHttpInfo

      public ApiResponse<Void> deleteConversationCustomattributeWithHttpInfo(String conversationId, String attributesId) throws IOException
      Delete a custom attributes record.
      Parameters:
      conversationId - conversation ID (required)
      attributesId - attributesId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationCustomattribute

      public void deleteConversationCustomattribute(DeleteConversationCustomattributeRequest request) throws IOException, ApiException
      Delete a custom attributes record.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationCustomattribute

      public ApiResponse<Void> deleteConversationCustomattribute(ApiRequest<Void> request) throws IOException
      Delete a custom attributes record.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationParticipantCode

      public void deleteConversationParticipantCode(String conversationId, String participantId, String addCommunicationCode) throws IOException, ApiException
      Delete a code used to add a communication to this participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      addCommunicationCode - addCommunicationCode (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationParticipantCodeWithHttpInfo

      public ApiResponse<Void> deleteConversationParticipantCodeWithHttpInfo(String conversationId, String participantId, String addCommunicationCode) throws IOException
      Delete a code used to add a communication to this participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      addCommunicationCode - addCommunicationCode (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationParticipantCode

      public void deleteConversationParticipantCode(DeleteConversationParticipantCodeRequest request) throws IOException, ApiException
      Delete a code used to add a communication to this participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationParticipantCode

      public ApiResponse<Void> deleteConversationParticipantCode(ApiRequest<Void> request) throws IOException
      Delete a code used to add a communication to this participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationParticipantFlaggedreason

      public void deleteConversationParticipantFlaggedreason(String conversationId, String participantId) throws IOException, ApiException
      Remove flagged reason from conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationParticipantFlaggedreasonWithHttpInfo

      public ApiResponse<Void> deleteConversationParticipantFlaggedreasonWithHttpInfo(String conversationId, String participantId) throws IOException
      Remove flagged reason from conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationParticipantFlaggedreason

      public void deleteConversationParticipantFlaggedreason(DeleteConversationParticipantFlaggedreasonRequest request) throws IOException, ApiException
      Remove flagged reason from conversation participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationParticipantFlaggedreason

      public ApiResponse<Void> deleteConversationParticipantFlaggedreason(ApiRequest<Void> request) throws IOException
      Remove flagged reason from conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantCommunicationPostflowaction

      public void deleteConversationsCallParticipantCommunicationPostflowaction(String conversationId, String participantId, String communicationId) throws IOException, ApiException
      Remove mandatory post call actions.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantCommunicationPostflowactionWithHttpInfo

      public ApiResponse<Void> deleteConversationsCallParticipantCommunicationPostflowactionWithHttpInfo(String conversationId, String participantId, String communicationId) throws IOException
      Remove mandatory post call actions.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantCommunicationPostflowaction

      public void deleteConversationsCallParticipantCommunicationPostflowaction(DeleteConversationsCallParticipantCommunicationPostflowactionRequest request) throws IOException, ApiException
      Remove mandatory post call actions.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantCommunicationPostflowaction

      public ApiResponse<Void> deleteConversationsCallParticipantCommunicationPostflowaction(ApiRequest<Void> request) throws IOException
      Remove mandatory post call actions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantConsult

      public void deleteConversationsCallParticipantConsult(String conversationId, String participantId) throws IOException, ApiException
      Cancel the transfer
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantConsultWithHttpInfo

      public ApiResponse<Void> deleteConversationsCallParticipantConsultWithHttpInfo(String conversationId, String participantId) throws IOException
      Cancel the transfer
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantConsult

      public void deleteConversationsCallParticipantConsult(DeleteConversationsCallParticipantConsultRequest request) throws IOException, ApiException
      Cancel the transfer
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsCallParticipantConsult

      public ApiResponse<Void> deleteConversationsCallParticipantConsult(ApiRequest<Void> request) throws IOException
      Cancel the transfer
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsEmailMessagesDraftAttachment

      public void deleteConversationsEmailMessagesDraftAttachment(String conversationId, String attachmentId) throws IOException, ApiException
      Delete attachment from draft
      Parameters:
      conversationId - conversationId (required)
      attachmentId - attachmentId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsEmailMessagesDraftAttachmentWithHttpInfo

      public ApiResponse<Void> deleteConversationsEmailMessagesDraftAttachmentWithHttpInfo(String conversationId, String attachmentId) throws IOException
      Delete attachment from draft
      Parameters:
      conversationId - conversationId (required)
      attachmentId - attachmentId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsEmailMessagesDraftAttachment

      public void deleteConversationsEmailMessagesDraftAttachment(DeleteConversationsEmailMessagesDraftAttachmentRequest request) throws IOException, ApiException
      Delete attachment from draft
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsEmailMessagesDraftAttachment

      public ApiResponse<Void> deleteConversationsEmailMessagesDraftAttachment(ApiRequest<Void> request) throws IOException
      Delete attachment from draft
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagesCachedmediaCachedMediaItemId

      public void deleteConversationsMessagesCachedmediaCachedMediaItemId(String cachedMediaItemId) throws IOException, ApiException
      Remove a cached media item asychronously
      Parameters:
      cachedMediaItemId - cachedMediaItemId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagesCachedmediaCachedMediaItemIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagesCachedmediaCachedMediaItemIdWithHttpInfo(String cachedMediaItemId) throws IOException
      Remove a cached media item asychronously
      Parameters:
      cachedMediaItemId - cachedMediaItemId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagesCachedmediaCachedMediaItemId

      public void deleteConversationsMessagesCachedmediaCachedMediaItemId(DeleteConversationsMessagesCachedmediaCachedMediaItemIdRequest request) throws IOException, ApiException
      Remove a cached media item asychronously
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagesCachedmediaCachedMediaItemId

      public ApiResponse<Void> deleteConversationsMessagesCachedmediaCachedMediaItemId(ApiRequest<Void> request) throws IOException
      Remove a cached media item asychronously
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsAppleIntegrationId

      public void deleteConversationsMessagingIntegrationsAppleIntegrationId(String integrationId) throws IOException, ApiException
      Delete an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsAppleIntegrationId

      public void deleteConversationsMessagingIntegrationsAppleIntegrationId(DeleteConversationsMessagingIntegrationsAppleIntegrationIdRequest request) throws IOException, ApiException
      Delete an Apple messaging integration
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsAppleIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsAppleIntegrationId(ApiRequest<Void> request) throws IOException
      Delete an Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsFacebookIntegrationId

      public void deleteConversationsMessagingIntegrationsFacebookIntegrationId(String integrationId) throws IOException, ApiException
      Delete a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsFacebookIntegrationId

      public void deleteConversationsMessagingIntegrationsFacebookIntegrationId(DeleteConversationsMessagingIntegrationsFacebookIntegrationIdRequest request) throws IOException, ApiException
      Delete a Facebook messaging integration
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsFacebookIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsFacebookIntegrationId(ApiRequest<Void> request) throws IOException
      Delete a Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsInstagramIntegrationId

      public void deleteConversationsMessagingIntegrationsInstagramIntegrationId(String integrationId) throws IOException, ApiException
      Delete Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsInstagramIntegrationId

      public void deleteConversationsMessagingIntegrationsInstagramIntegrationId(DeleteConversationsMessagingIntegrationsInstagramIntegrationIdRequest request) throws IOException, ApiException
      Delete Instagram messaging integration
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsInstagramIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsInstagramIntegrationId(ApiRequest<Void> request) throws IOException
      Delete Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public void deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(String integrationId) throws IOException, ApiException
      Delete an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public void deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(DeleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdRequest request) throws IOException, ApiException
      Delete an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(ApiRequest<Void> request) throws IOException
      Delete an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenIntegrationId

      public void deleteConversationsMessagingIntegrationsOpenIntegrationId(String integrationId) throws IOException, ApiException
      Delete an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenIntegrationId

      public void deleteConversationsMessagingIntegrationsOpenIntegrationId(DeleteConversationsMessagingIntegrationsOpenIntegrationIdRequest request) throws IOException, ApiException
      Delete an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsOpenIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsOpenIntegrationId(ApiRequest<Void> request) throws IOException
      Delete an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsTwitterIntegrationId

      public void deleteConversationsMessagingIntegrationsTwitterIntegrationId(String integrationId) throws IOException, ApiException
      Delete Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsTwitterIntegrationId

      public void deleteConversationsMessagingIntegrationsTwitterIntegrationId(DeleteConversationsMessagingIntegrationsTwitterIntegrationIdRequest request) throws IOException, ApiException
      Delete Twitter messaging integration
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsTwitterIntegrationId

      public ApiResponse<Void> deleteConversationsMessagingIntegrationsTwitterIntegrationId(ApiRequest<Void> request) throws IOException
      Delete Twitter messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration deleteConversationsMessagingIntegrationsWhatsappIntegrationId(String integrationId) throws IOException, ApiException
      Delete a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIntegration> deleteConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Delete a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration deleteConversationsMessagingIntegrationsWhatsappIntegrationId(DeleteConversationsMessagingIntegrationsWhatsappIntegrationIdRequest request) throws IOException, ApiException
      Delete a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingIntegrationsWhatsappIntegrationId

      public ApiResponse<WhatsAppIntegration> deleteConversationsMessagingIntegrationsWhatsappIntegrationId(ApiRequest<Void> request) throws IOException
      Delete a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSetting

      public void deleteConversationsMessagingSetting(String messageSettingId) throws IOException, ApiException
      Delete a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSettingWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingSettingWithHttpInfo(String messageSettingId) throws IOException
      Delete a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSetting

      public void deleteConversationsMessagingSetting(DeleteConversationsMessagingSettingRequest request) throws IOException, ApiException
      Delete a messaging setting
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSetting

      public ApiResponse<Void> deleteConversationsMessagingSetting(ApiRequest<Void> request) throws IOException
      Delete a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSettingsDefault

      public void deleteConversationsMessagingSettingsDefault() throws IOException, ApiException
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingSettingsDefaultWithHttpInfo() throws IOException
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSettingsDefault

      public void deleteConversationsMessagingSettingsDefault(DeleteConversationsMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSettingsDefault

      public ApiResponse<Void> deleteConversationsMessagingSettingsDefault(ApiRequest<Void> request) throws IOException
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSupportedcontentSupportedContentId

      public void deleteConversationsMessagingSupportedcontentSupportedContentId(String supportedContentId) throws IOException, ApiException
      Delete a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<Void> deleteConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId) throws IOException
      Delete a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSupportedcontentSupportedContentId

      public void deleteConversationsMessagingSupportedcontentSupportedContentId(DeleteConversationsMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Delete a supported content profile
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteConversationsMessagingSupportedcontentSupportedContentId

      public ApiResponse<Void> deleteConversationsMessagingSupportedcontentSupportedContentId(ApiRequest<Void> request) throws IOException
      Delete a supported content profile
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationDetails

      public AnalyticsConversationWithoutAttributes getAnalyticsConversationDetails(String conversationId) throws IOException, ApiException
      Get a conversation by id
      Parameters:
      conversationId - conversationId (required)
      Returns:
      AnalyticsConversationWithoutAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationDetailsWithHttpInfo

      public ApiResponse<AnalyticsConversationWithoutAttributes> getAnalyticsConversationDetailsWithHttpInfo(String conversationId) throws IOException
      Get a conversation by id
      Parameters:
      conversationId - conversationId (required)
      Returns:
      AnalyticsConversationWithoutAttributes
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationDetails

      Get a conversation by id
      Parameters:
      request - The request object
      Returns:
      AnalyticsConversationWithoutAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationDetails

      public ApiResponse<AnalyticsConversationWithoutAttributes> getAnalyticsConversationDetails(ApiRequest<Void> request) throws IOException
      Get a conversation by id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJob

      public AsyncQueryStatus getAnalyticsConversationsAggregatesJob(String jobId) throws IOException, ApiException
      Get status for async query for conversation aggregates
      Parameters:
      jobId - jobId (required)
      Returns:
      AsyncQueryStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJobWithHttpInfo

      public ApiResponse<AsyncQueryStatus> getAnalyticsConversationsAggregatesJobWithHttpInfo(String jobId) throws IOException
      Get status for async query for conversation aggregates
      Parameters:
      jobId - jobId (required)
      Returns:
      AsyncQueryStatus
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJob

      public AsyncQueryStatus getAnalyticsConversationsAggregatesJob(GetAnalyticsConversationsAggregatesJobRequest request) throws IOException, ApiException
      Get status for async query for conversation aggregates
      Parameters:
      request - The request object
      Returns:
      AsyncQueryStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJob

      public ApiResponse<AsyncQueryStatus> getAnalyticsConversationsAggregatesJob(ApiRequest<Void> request) throws IOException
      Get status for async query for conversation aggregates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJobResults

      public ConversationAsyncAggregateQueryResponse getAnalyticsConversationsAggregatesJobResults(String jobId, String cursor) throws IOException, ApiException
      Fetch a page of results for an async aggregates query
      Parameters:
      jobId - jobId (required)
      cursor - Cursor token to retrieve next page (optional)
      Returns:
      ConversationAsyncAggregateQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJobResultsWithHttpInfo

      public ApiResponse<ConversationAsyncAggregateQueryResponse> getAnalyticsConversationsAggregatesJobResultsWithHttpInfo(String jobId, String cursor) throws IOException
      Fetch a page of results for an async aggregates query
      Parameters:
      jobId - jobId (required)
      cursor - Cursor token to retrieve next page (optional)
      Returns:
      ConversationAsyncAggregateQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJobResults

      public ConversationAsyncAggregateQueryResponse getAnalyticsConversationsAggregatesJobResults(GetAnalyticsConversationsAggregatesJobResultsRequest request) throws IOException, ApiException
      Fetch a page of results for an async aggregates query
      Parameters:
      request - The request object
      Returns:
      ConversationAsyncAggregateQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsAggregatesJobResults

      public ApiResponse<ConversationAsyncAggregateQueryResponse> getAnalyticsConversationsAggregatesJobResults(ApiRequest<Void> request) throws IOException
      Fetch a page of results for an async aggregates query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetails

      public AnalyticsConversationWithoutAttributesMultiGetResponse getAnalyticsConversationsDetails(List<String> id) throws IOException, ApiException
      Gets multiple conversations by id
      Parameters:
      id - Comma-separated conversation ids (optional)
      Returns:
      AnalyticsConversationWithoutAttributesMultiGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsWithHttpInfo

      public ApiResponse<AnalyticsConversationWithoutAttributesMultiGetResponse> getAnalyticsConversationsDetailsWithHttpInfo(List<String> id) throws IOException
      Gets multiple conversations by id
      Parameters:
      id - Comma-separated conversation ids (optional)
      Returns:
      AnalyticsConversationWithoutAttributesMultiGetResponse
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetails

      Gets multiple conversations by id
      Parameters:
      request - The request object
      Returns:
      AnalyticsConversationWithoutAttributesMultiGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetails

      public ApiResponse<AnalyticsConversationWithoutAttributesMultiGetResponse> getAnalyticsConversationsDetails(ApiRequest<Void> request) throws IOException
      Gets multiple conversations by id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJob

      public AsyncQueryStatus getAnalyticsConversationsDetailsJob(String jobId) throws IOException, ApiException
      Get status for async query for conversation details
      Parameters:
      jobId - jobId (required)
      Returns:
      AsyncQueryStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobWithHttpInfo

      public ApiResponse<AsyncQueryStatus> getAnalyticsConversationsDetailsJobWithHttpInfo(String jobId) throws IOException
      Get status for async query for conversation details
      Parameters:
      jobId - jobId (required)
      Returns:
      AsyncQueryStatus
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJob

      public AsyncQueryStatus getAnalyticsConversationsDetailsJob(GetAnalyticsConversationsDetailsJobRequest request) throws IOException, ApiException
      Get status for async query for conversation details
      Parameters:
      request - The request object
      Returns:
      AsyncQueryStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJob

      public ApiResponse<AsyncQueryStatus> getAnalyticsConversationsDetailsJob(ApiRequest<Void> request) throws IOException
      Get status for async query for conversation details
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobResults

      public AnalyticsConversationAsyncQueryResponse getAnalyticsConversationsDetailsJobResults(String jobId, String cursor, Integer pageSize) throws IOException, ApiException
      Fetch a page of results for an async details job
      Parameters:
      jobId - jobId (required)
      cursor - Indicates where to resume query results (not required for first page) (optional)
      pageSize - The desired maximum number of results (optional)
      Returns:
      AnalyticsConversationAsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobResultsWithHttpInfo

      public ApiResponse<AnalyticsConversationAsyncQueryResponse> getAnalyticsConversationsDetailsJobResultsWithHttpInfo(String jobId, String cursor, Integer pageSize) throws IOException
      Fetch a page of results for an async details job
      Parameters:
      jobId - jobId (required)
      cursor - Indicates where to resume query results (not required for first page) (optional)
      pageSize - The desired maximum number of results (optional)
      Returns:
      AnalyticsConversationAsyncQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobResults

      Fetch a page of results for an async details job
      Parameters:
      request - The request object
      Returns:
      AnalyticsConversationAsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobResults

      public ApiResponse<AnalyticsConversationAsyncQueryResponse> getAnalyticsConversationsDetailsJobResults(ApiRequest<Void> request) throws IOException
      Fetch a page of results for an async details job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobsAvailability

      public DataAvailabilityResponse getAnalyticsConversationsDetailsJobsAvailability() throws IOException, ApiException
      Lookup the datalake availability date and time
      Returns:
      DataAvailabilityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobsAvailabilityWithHttpInfo

      public ApiResponse<DataAvailabilityResponse> getAnalyticsConversationsDetailsJobsAvailabilityWithHttpInfo() throws IOException
      Lookup the datalake availability date and time
      Returns:
      DataAvailabilityResponse
      Throws:
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobsAvailability

      public DataAvailabilityResponse getAnalyticsConversationsDetailsJobsAvailability(GetAnalyticsConversationsDetailsJobsAvailabilityRequest request) throws IOException, ApiException
      Lookup the datalake availability date and time
      Parameters:
      request - The request object
      Returns:
      DataAvailabilityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getAnalyticsConversationsDetailsJobsAvailability

      public ApiResponse<DataAvailabilityResponse> getAnalyticsConversationsDetailsJobsAvailability(ApiRequest<Void> request) throws IOException
      Lookup the datalake availability date and time
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversation

      public Conversation getConversation(String conversationId) throws IOException, ApiException
      Get conversation
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationWithHttpInfo

      public ApiResponse<Conversation> getConversationWithHttpInfo(String conversationId) throws IOException
      Get conversation
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • getConversation

      public Conversation getConversation(GetConversationRequest request) throws IOException, ApiException
      Get conversation
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversation

      public ApiResponse<Conversation> getConversation(ApiRequest<Void> request) throws IOException
      Get conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationAssistantCopilotcontext

      public CopilotContextValues getConversationAssistantCopilotcontext(String conversationId) throws IOException, ApiException
      Get copilot context values for a conversation. getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conversationId - Conversation ID. (required)
      Returns:
      CopilotContextValues
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationAssistantCopilotcontextWithHttpInfo

      public ApiResponse<CopilotContextValues> getConversationAssistantCopilotcontextWithHttpInfo(String conversationId) throws IOException
      Get copilot context values for a conversation. getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conversationId - Conversation ID. (required)
      Returns:
      CopilotContextValues
      Throws:
      IOException - if the request fails to be processed
    • getConversationAssistantCopilotcontext

      public CopilotContextValues getConversationAssistantCopilotcontext(GetConversationAssistantCopilotcontextRequest request) throws IOException, ApiException
      Get copilot context values for a conversation. getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      CopilotContextValues
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationAssistantCopilotcontext

      public ApiResponse<CopilotContextValues> getConversationAssistantCopilotcontext(ApiRequest<Void> request) throws IOException
      Get copilot context values for a conversation. getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklist

      public AgentChecklistResponse getConversationCommunicationAgentchecklist(String conversationId, String communicationId, String agentChecklistId) throws IOException, ApiException
      Get checklist info for a single checklist.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistWithHttpInfo

      public ApiResponse<AgentChecklistResponse> getConversationCommunicationAgentchecklistWithHttpInfo(String conversationId, String communicationId, String agentChecklistId) throws IOException
      Get checklist info for a single checklist.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      Returns:
      AgentChecklistResponse
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklist

      public AgentChecklistResponse getConversationCommunicationAgentchecklist(GetConversationCommunicationAgentchecklistRequest request) throws IOException, ApiException
      Get checklist info for a single checklist.
      Parameters:
      request - The request object
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklist

      public ApiResponse<AgentChecklistResponse> getConversationCommunicationAgentchecklist(ApiRequest<Void> request) throws IOException
      Get checklist info for a single checklist.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistJob

      public ChecklistInferenceJobResponse getConversationCommunicationAgentchecklistJob(String conversationId, String communicationId, String agentChecklistId, String jobId) throws IOException, ApiException
      Get inference job status
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      jobId - Inference Job ID (required)
      Returns:
      ChecklistInferenceJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistJobWithHttpInfo

      public ApiResponse<ChecklistInferenceJobResponse> getConversationCommunicationAgentchecklistJobWithHttpInfo(String conversationId, String communicationId, String agentChecklistId, String jobId) throws IOException
      Get inference job status
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      jobId - Inference Job ID (required)
      Returns:
      ChecklistInferenceJobResponse
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistJob

      public ChecklistInferenceJobResponse getConversationCommunicationAgentchecklistJob(GetConversationCommunicationAgentchecklistJobRequest request) throws IOException, ApiException
      Get inference job status
      Parameters:
      request - The request object
      Returns:
      ChecklistInferenceJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistJob

      public ApiResponse<ChecklistInferenceJobResponse> getConversationCommunicationAgentchecklistJob(ApiRequest<Void> request) throws IOException
      Get inference job status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklists

      public AgentChecklistResponseList getConversationCommunicationAgentchecklists(String conversationId, String communicationId) throws IOException, ApiException
      Get information of all checklists associated with a conversation.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      Returns:
      AgentChecklistResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklistsWithHttpInfo

      public ApiResponse<AgentChecklistResponseList> getConversationCommunicationAgentchecklistsWithHttpInfo(String conversationId, String communicationId) throws IOException
      Get information of all checklists associated with a conversation.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      Returns:
      AgentChecklistResponseList
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklists

      public AgentChecklistResponseList getConversationCommunicationAgentchecklists(GetConversationCommunicationAgentchecklistsRequest request) throws IOException, ApiException
      Get information of all checklists associated with a conversation.
      Parameters:
      request - The request object
      Returns:
      AgentChecklistResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationAgentchecklists

      public ApiResponse<AgentChecklistResponseList> getConversationCommunicationAgentchecklists(ApiRequest<Void> request) throws IOException
      Get information of all checklists associated with a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessage

      public InternalMessageData getConversationCommunicationInternalmessage(String conversationId, String communicationId, String messageId) throws IOException, ApiException
      Get message
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      messageId - messageId (required)
      Returns:
      InternalMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessageWithHttpInfo

      public ApiResponse<InternalMessageData> getConversationCommunicationInternalmessageWithHttpInfo(String conversationId, String communicationId, String messageId) throws IOException
      Get message
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      messageId - messageId (required)
      Returns:
      InternalMessageData
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessage

      public InternalMessageData getConversationCommunicationInternalmessage(GetConversationCommunicationInternalmessageRequest request) throws IOException, ApiException
      Get message
      Parameters:
      request - The request object
      Returns:
      InternalMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessage

      public ApiResponse<InternalMessageData> getConversationCommunicationInternalmessage(ApiRequest<Void> request) throws IOException
      Get message
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessages

      public InternalMessageDataEntityListing getConversationCommunicationInternalmessages(String conversationId, String communicationId, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get messages for communication
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      pageSize - Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      InternalMessageDataEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessagesWithHttpInfo

      public ApiResponse<InternalMessageDataEntityListing> getConversationCommunicationInternalmessagesWithHttpInfo(String conversationId, String communicationId, Integer pageSize, Integer pageNumber) throws IOException
      Get messages for communication
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      pageSize - Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      InternalMessageDataEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessages

      public InternalMessageDataEntityListing getConversationCommunicationInternalmessages(GetConversationCommunicationInternalmessagesRequest request) throws IOException, ApiException
      Get messages for communication
      Parameters:
      request - The request object
      Returns:
      InternalMessageDataEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCommunicationInternalmessages

      public ApiResponse<InternalMessageDataEntityListing> getConversationCommunicationInternalmessages(ApiRequest<Void> request) throws IOException
      Get messages for communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCustomattribute

      public CustomAttributes getConversationCustomattribute(String conversationId, String attributesId) throws IOException, ApiException
      Get custom attributes by id
      Parameters:
      conversationId - conversation ID (required)
      attributesId - attributesId (required)
      Returns:
      CustomAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCustomattributeWithHttpInfo

      public ApiResponse<CustomAttributes> getConversationCustomattributeWithHttpInfo(String conversationId, String attributesId) throws IOException
      Get custom attributes by id
      Parameters:
      conversationId - conversation ID (required)
      attributesId - attributesId (required)
      Returns:
      CustomAttributes
      Throws:
      IOException - if the request fails to be processed
    • getConversationCustomattribute

      public CustomAttributes getConversationCustomattribute(GetConversationCustomattributeRequest request) throws IOException, ApiException
      Get custom attributes by id
      Parameters:
      request - The request object
      Returns:
      CustomAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCustomattribute

      public ApiResponse<CustomAttributes> getConversationCustomattribute(ApiRequest<Void> request) throws IOException
      Get custom attributes by id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationCustomattributes

      public CustomAttributesListing getConversationCustomattributes(String conversationId) throws IOException, ApiException
      Get a list of custom attributes for a conversation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      CustomAttributesListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCustomattributesWithHttpInfo

      public ApiResponse<CustomAttributesListing> getConversationCustomattributesWithHttpInfo(String conversationId) throws IOException
      Get a list of custom attributes for a conversation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      CustomAttributesListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationCustomattributes

      public CustomAttributesListing getConversationCustomattributes(GetConversationCustomattributesRequest request) throws IOException, ApiException
      Get a list of custom attributes for a conversation.
      Parameters:
      request - The request object
      Returns:
      CustomAttributesListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationCustomattributes

      public ApiResponse<CustomAttributesListing> getConversationCustomattributes(ApiRequest<Void> request) throws IOException
      Get a list of custom attributes for a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsession

      public SecureSession getConversationParticipantSecureivrsession(String conversationId, String participantId, String secureSessionId) throws IOException, ApiException
      Fetch info on a secure session
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      secureSessionId - secure IVR session ID (required)
      Returns:
      SecureSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsessionWithHttpInfo

      public ApiResponse<SecureSession> getConversationParticipantSecureivrsessionWithHttpInfo(String conversationId, String participantId, String secureSessionId) throws IOException
      Fetch info on a secure session
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      secureSessionId - secure IVR session ID (required)
      Returns:
      SecureSession
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsession

      public SecureSession getConversationParticipantSecureivrsession(GetConversationParticipantSecureivrsessionRequest request) throws IOException, ApiException
      Fetch info on a secure session
      Parameters:
      request - The request object
      Returns:
      SecureSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsession

      public ApiResponse<SecureSession> getConversationParticipantSecureivrsession(ApiRequest<Void> request) throws IOException
      Fetch info on a secure session
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsessions

      public SecureSessionEntityListing getConversationParticipantSecureivrsessions(String conversationId, String participantId) throws IOException, ApiException
      Get a list of secure sessions for this participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Returns:
      SecureSessionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsessionsWithHttpInfo

      public ApiResponse<SecureSessionEntityListing> getConversationParticipantSecureivrsessionsWithHttpInfo(String conversationId, String participantId) throws IOException
      Get a list of secure sessions for this participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Returns:
      SecureSessionEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsessions

      public SecureSessionEntityListing getConversationParticipantSecureivrsessions(GetConversationParticipantSecureivrsessionsRequest request) throws IOException, ApiException
      Get a list of secure sessions for this participant.
      Parameters:
      request - The request object
      Returns:
      SecureSessionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantSecureivrsessions

      public ApiResponse<SecureSessionEntityListing> getConversationParticipantSecureivrsessions(ApiRequest<Void> request) throws IOException
      Get a list of secure sessions for this participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantWrapup

      public AssignedWrapupCode getConversationParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      provisional - Indicates if the wrap-up code is provisional. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      provisional - Indicates if the wrap-up code is provisional. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantWrapup

      public AssignedWrapupCode getConversationParticipantWrapup(GetConversationParticipantWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationParticipantWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantWrapupcodes

      public List<WrapupCode> getConversationParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationParticipantWrapupcodes

      public List<WrapupCode> getConversationParticipantWrapupcodes(GetConversationParticipantWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationSecureattributes

      public ConversationSecureAttributes getConversationSecureattributes(String conversationId) throws IOException, ApiException
      Get the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      ConversationSecureAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSecureattributesWithHttpInfo

      public ApiResponse<ConversationSecureAttributes> getConversationSecureattributesWithHttpInfo(String conversationId) throws IOException
      Get the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      ConversationSecureAttributes
      Throws:
      IOException - if the request fails to be processed
    • getConversationSecureattributes

      public ConversationSecureAttributes getConversationSecureattributes(GetConversationSecureattributesRequest request) throws IOException, ApiException
      Get the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      ConversationSecureAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSecureattributes

      public ApiResponse<ConversationSecureAttributes> getConversationSecureattributes(ApiRequest<Void> request) throws IOException
      Get the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationSuggestion

      public Suggestion getConversationSuggestion(String conversationId, String suggestionId) throws IOException, ApiException
      Get Suggestion.
      Parameters:
      conversationId - Conversation ID (required)
      suggestionId - Suggestion ID (required)
      Returns:
      Suggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSuggestionWithHttpInfo

      public ApiResponse<Suggestion> getConversationSuggestionWithHttpInfo(String conversationId, String suggestionId) throws IOException
      Get Suggestion.
      Parameters:
      conversationId - Conversation ID (required)
      suggestionId - Suggestion ID (required)
      Returns:
      Suggestion
      Throws:
      IOException - if the request fails to be processed
    • getConversationSuggestion

      public Suggestion getConversationSuggestion(GetConversationSuggestionRequest request) throws IOException, ApiException
      Get Suggestion.
      Parameters:
      request - The request object
      Returns:
      Suggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSuggestion

      public ApiResponse<Suggestion> getConversationSuggestion(ApiRequest<Void> request) throws IOException
      Get Suggestion.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationSuggestions

      public SuggestionListing getConversationSuggestions(String conversationId, String before, String after, String pageSize, String type, String state) throws IOException, ApiException
      Get all suggestions for a conversation.
      Parameters:
      conversationId - Conversation ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      type - Suggestion type to filter by. (optional)
      state - Suggestion state to filter Copilot suggestions. (optional)
      Returns:
      SuggestionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSuggestionsWithHttpInfo

      public ApiResponse<SuggestionListing> getConversationSuggestionsWithHttpInfo(String conversationId, String before, String after, String pageSize, String type, String state) throws IOException
      Get all suggestions for a conversation.
      Parameters:
      conversationId - Conversation ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      type - Suggestion type to filter by. (optional)
      state - Suggestion state to filter Copilot suggestions. (optional)
      Returns:
      SuggestionListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationSuggestions

      public SuggestionListing getConversationSuggestions(GetConversationSuggestionsRequest request) throws IOException, ApiException
      Get all suggestions for a conversation.
      Parameters:
      request - The request object
      Returns:
      SuggestionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSuggestions

      public ApiResponse<SuggestionListing> getConversationSuggestions(ApiRequest<Void> request) throws IOException
      Get all suggestions for a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationSummaries

      public ConversationSummariesGetResponse getConversationSummaries(String conversationId) throws IOException, ApiException
      Get the summaries of the conversation.
      Parameters:
      conversationId - Conversation ID (required)
      Returns:
      ConversationSummariesGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSummariesWithHttpInfo

      public ApiResponse<ConversationSummariesGetResponse> getConversationSummariesWithHttpInfo(String conversationId) throws IOException
      Get the summaries of the conversation.
      Parameters:
      conversationId - Conversation ID (required)
      Returns:
      ConversationSummariesGetResponse
      Throws:
      IOException - if the request fails to be processed
    • getConversationSummaries

      Get the summaries of the conversation.
      Parameters:
      request - The request object
      Returns:
      ConversationSummariesGetResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationSummaries

      public ApiResponse<ConversationSummariesGetResponse> getConversationSummaries(ApiRequest<Void> request) throws IOException
      Get the summaries of the conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversations

      public ConversationEntityListing getConversations(String communicationType) throws IOException, ApiException
      Get active conversations for the logged in user
      Parameters:
      communicationType - Call or Chat communication filtering (optional)
      Returns:
      ConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsWithHttpInfo

      public ApiResponse<ConversationEntityListing> getConversationsWithHttpInfo(String communicationType) throws IOException
      Get active conversations for the logged in user
      Parameters:
      communicationType - Call or Chat communication filtering (optional)
      Returns:
      ConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversations

      Get active conversations for the logged in user
      Parameters:
      request - The request object
      Returns:
      ConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversations

      public ApiResponse<ConversationEntityListing> getConversations(ApiRequest<Void> request) throws IOException
      Get active conversations for the logged in user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCall

      public CallConversation getConversationsCall(String conversationId) throws IOException, ApiException
      Get call conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CallConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallWithHttpInfo

      public ApiResponse<CallConversation> getConversationsCallWithHttpInfo(String conversationId) throws IOException
      Get call conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CallConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCall

      public CallConversation getConversationsCall(GetConversationsCallRequest request) throws IOException, ApiException
      Get call conversation
      Parameters:
      request - The request object
      Returns:
      CallConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCall

      public ApiResponse<CallConversation> getConversationsCall(ApiRequest<Void> request) throws IOException
      Get call conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCallParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCallParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCallParticipantCommunicationWrapup(GetConversationsCallParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCallParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapup

      public AssignedWrapupCode getConversationsCallParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCallParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapup

      public AssignedWrapupCode getConversationsCallParticipantWrapup(GetConversationsCallParticipantWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCallParticipantWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapupcodes

      public List<WrapupCode> getConversationsCallParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsCallParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapupcodes

      public List<WrapupCode> getConversationsCallParticipantWrapupcodes(GetConversationsCallParticipantWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsCallParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallback

      public CallbackConversation getConversationsCallback(String conversationId) throws IOException, ApiException
      Get callback conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CallbackConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackWithHttpInfo

      public ApiResponse<CallbackConversation> getConversationsCallbackWithHttpInfo(String conversationId) throws IOException
      Get callback conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CallbackConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallback

      public CallbackConversation getConversationsCallback(GetConversationsCallbackRequest request) throws IOException, ApiException
      Get callback conversation
      Parameters:
      request - The request object
      Returns:
      CallbackConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallback

      public ApiResponse<CallbackConversation> getConversationsCallback(ApiRequest<Void> request) throws IOException
      Get callback conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCallbackParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCallbackParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCallbackParticipantCommunicationWrapup(GetConversationsCallbackParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCallbackParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapup

      public AssignedWrapupCode getConversationsCallbackParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCallbackParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapup

      public AssignedWrapupCode getConversationsCallbackParticipantWrapup(GetConversationsCallbackParticipantWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCallbackParticipantWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapupcodes

      public List<WrapupCode> getConversationsCallbackParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsCallbackParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapupcodes

      public List<WrapupCode> getConversationsCallbackParticipantWrapupcodes(GetConversationsCallbackParticipantWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbackParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsCallbackParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbacks

      public CallbackConversationEntityListing getConversationsCallbacks() throws IOException, ApiException
      Get the logged-in user's active conversations and their Callback participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?
      Returns:
      CallbackConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbacksWithHttpInfo

      public ApiResponse<CallbackConversationEntityListing> getConversationsCallbacksWithHttpInfo() throws IOException
      Get the logged-in user's active conversations and their Callback participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?
      Returns:
      CallbackConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallbacks

      Get the logged-in user's active conversations and their Callback participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?
      Parameters:
      request - The request object
      Returns:
      CallbackConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallbacks

      public ApiResponse<CallbackConversationEntityListing> getConversationsCallbacks(ApiRequest<Void> request) throws IOException
      Get the logged-in user's active conversations and their Callback participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCalls

      public CallConversationEntityListing getConversationsCalls() throws IOException, ApiException
      Get the logged-in user's active conversations and their Call participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?
      Returns:
      CallConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallsWithHttpInfo

      public ApiResponse<CallConversationEntityListing> getConversationsCallsWithHttpInfo() throws IOException
      Get the logged-in user's active conversations and their Call participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?
      Returns:
      CallConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCalls

      Get the logged-in user's active conversations and their Call participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?
      Parameters:
      request - The request object
      Returns:
      CallConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCalls

      public ApiResponse<CallConversationEntityListing> getConversationsCalls(ApiRequest<Void> request) throws IOException
      Get the logged-in user's active conversations and their Call participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallsHistory

      public CallHistoryConversationEntityListing getConversationsCallsHistory(Integer pageSize, Integer pageNumber, String interval, List<String> expand) throws IOException, ApiException
      Get call history
      Parameters:
      pageSize - Page size, maximum 50 (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      interval - Interval string; format is ISO-8601. Separate start and end times with forward slash '/' (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      CallHistoryConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallsHistoryWithHttpInfo

      public ApiResponse<CallHistoryConversationEntityListing> getConversationsCallsHistoryWithHttpInfo(Integer pageSize, Integer pageNumber, String interval, List<String> expand) throws IOException
      Get call history
      Parameters:
      pageSize - Page size, maximum 50 (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      interval - Interval string; format is ISO-8601. Separate start and end times with forward slash '/' (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      CallHistoryConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallsHistory

      Get call history
      Parameters:
      request - The request object
      Returns:
      CallHistoryConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallsHistory

      public ApiResponse<CallHistoryConversationEntityListing> getConversationsCallsHistory(ApiRequest<Void> request) throws IOException
      Get call history
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallsMaximumconferenceparties

      public MaxParticipants getConversationsCallsMaximumconferenceparties() throws IOException, ApiException
      Get the maximum number of participants that this user can have on a conference
      Returns:
      MaxParticipants
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallsMaximumconferencepartiesWithHttpInfo

      public ApiResponse<MaxParticipants> getConversationsCallsMaximumconferencepartiesWithHttpInfo() throws IOException
      Get the maximum number of participants that this user can have on a conference
      Returns:
      MaxParticipants
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCallsMaximumconferenceparties

      public MaxParticipants getConversationsCallsMaximumconferenceparties(GetConversationsCallsMaximumconferencepartiesRequest request) throws IOException, ApiException
      Get the maximum number of participants that this user can have on a conference
      Parameters:
      request - The request object
      Returns:
      MaxParticipants
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCallsMaximumconferenceparties

      public ApiResponse<MaxParticipants> getConversationsCallsMaximumconferenceparties(ApiRequest<Void> request) throws IOException
      Get the maximum number of participants that this user can have on a conference
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChat

      public ChatConversation getConversationsChat(String conversationId) throws IOException, ApiException
      Deprecated.
      Get 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)
      Returns:
      ChatConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatWithHttpInfo

      public ApiResponse<ChatConversation> getConversationsChatWithHttpInfo(String conversationId) throws IOException
      Deprecated.
      Get 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)
      Returns:
      ChatConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChat

      public ChatConversation getConversationsChat(GetConversationsChatRequest request) throws IOException, ApiException
      Deprecated.
      Get 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:
      ChatConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChat

      public ApiResponse<ChatConversation> getConversationsChat(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get 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
    • getConversationsChatMessage

      public WebChatMessage getConversationsChatMessage(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/. The current user must be involved with the conversation to get its messages.
      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
    • getConversationsChatMessageWithHttpInfo

      public ApiResponse<WebChatMessage> getConversationsChatMessageWithHttpInfo(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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      conversationId - conversationId (required)
      messageId - messageId (required)
      Returns:
      WebChatMessage
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatMessage

      public WebChatMessage getConversationsChatMessage(GetConversationsChatMessageRequest 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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      request - The request object
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatMessage

      public ApiResponse<WebChatMessage> getConversationsChatMessage(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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatMessages

      public WebChatMessageEntityList getConversationsChatMessages(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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      conversationId - conversationId (required)
      after - If specified, get the messages chronologically after the id of this message (optional)
      before - If specified, 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
    • getConversationsChatMessagesWithHttpInfo

      public ApiResponse<WebChatMessageEntityList> getConversationsChatMessagesWithHttpInfo(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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      conversationId - conversationId (required)
      after - If specified, get the messages chronologically after the id of this message (optional)
      before - If specified, 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
    • getConversationsChatMessages

      public WebChatMessageEntityList getConversationsChatMessages(GetConversationsChatMessagesRequest 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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      request - The request object
      Returns:
      WebChatMessageEntityList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatMessages

      public ApiResponse<WebChatMessageEntityList> getConversationsChatMessages(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/. The current user must be involved with the conversation to get its messages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsChatParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsChatParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsChatParticipantCommunicationWrapup(GetConversationsChatParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. 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:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsChatParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. 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
    • getConversationsChatParticipantWrapup

      public AssignedWrapupCode getConversationsChatParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation participant. 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)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsChatParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Deprecated.
      Get the wrap-up for this conversation participant. 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)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapup

      public AssignedWrapupCode getConversationsChatParticipantWrapup(GetConversationsChatParticipantWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation participant. 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:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsChatParticipantWrapup(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the wrap-up for this conversation participant. 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
    • getConversationsChatParticipantWrapupcodes

      public List<WrapupCode> getConversationsChatParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsChatParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapupcodes

      public List<WrapupCode> getConversationsChatParticipantWrapupcodes(GetConversationsChatParticipantWrapupcodesRequest request) throws IOException, ApiException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsChatParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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
    • getConversationsChats

      public ChatConversationEntityListing getConversationsChats() throws IOException, ApiException
      Deprecated.
      Get active chat conversations for the logged in user This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
      Returns:
      ChatConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChatsWithHttpInfo

      public ApiResponse<ChatConversationEntityListing> getConversationsChatsWithHttpInfo() throws IOException
      Deprecated.
      Get active chat conversations for the logged in user This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
      Returns:
      ChatConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsChats

      Deprecated.
      Get active chat conversations for the logged in user 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:
      ChatConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsChats

      public ApiResponse<ChatConversationEntityListing> getConversationsChats(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get active chat conversations for the logged in user 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
    • getConversationsCobrowsesession

      public CobrowseConversation getConversationsCobrowsesession(String conversationId) throws IOException, ApiException
      Get cobrowse conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CobrowseConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionWithHttpInfo

      public ApiResponse<CobrowseConversation> getConversationsCobrowsesessionWithHttpInfo(String conversationId) throws IOException
      Get cobrowse conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      CobrowseConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesession

      public CobrowseConversation getConversationsCobrowsesession(GetConversationsCobrowsesessionRequest request) throws IOException, ApiException
      Get cobrowse conversation
      Parameters:
      request - The request object
      Returns:
      CobrowseConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesession

      public ApiResponse<CobrowseConversation> getConversationsCobrowsesession(ApiRequest<Void> request) throws IOException
      Get cobrowse conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCobrowsesessionParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCobrowsesessionParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsCobrowsesessionParticipantCommunicationWrapup(GetConversationsCobrowsesessionParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. 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:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCobrowsesessionParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. 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
    • getConversationsCobrowsesessionParticipantWrapup

      public AssignedWrapupCode getConversationsCobrowsesessionParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation participant. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsCobrowsesessionParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Deprecated.
      Get the wrap-up for this conversation participant. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapup

      public AssignedWrapupCode getConversationsCobrowsesessionParticipantWrapup(GetConversationsCobrowsesessionParticipantWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation participant. 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:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsCobrowsesessionParticipantWrapup(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the wrap-up for this conversation participant. 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
    • getConversationsCobrowsesessionParticipantWrapupcodes

      public List<WrapupCode> getConversationsCobrowsesessionParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Deprecated.
      Get list of wrapup codes for this conversation participant This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsCobrowsesessionParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Deprecated.
      Get list of wrapup codes for this conversation participant This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapupcodes

      public List<WrapupCode> getConversationsCobrowsesessionParticipantWrapupcodes(GetConversationsCobrowsesessionParticipantWrapupcodesRequest request) throws IOException, ApiException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsCobrowsesessionParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get list of wrapup codes for this conversation participant 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
    • getConversationsCobrowsesessions

      public CobrowseConversationEntityListing getConversationsCobrowsesessions() throws IOException, ApiException
      Get active cobrowse conversations for the logged in user
      Returns:
      CobrowseConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessionsWithHttpInfo

      public ApiResponse<CobrowseConversationEntityListing> getConversationsCobrowsesessionsWithHttpInfo() throws IOException
      Get active cobrowse conversations for the logged in user
      Returns:
      CobrowseConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessions

      Get active cobrowse conversations for the logged in user
      Parameters:
      request - The request object
      Returns:
      CobrowseConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCobrowsesessions

      public ApiResponse<CobrowseConversationEntityListing> getConversationsCobrowsesessions(ApiRequest<Void> request) throws IOException
      Get active cobrowse conversations for the logged in user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchema

      public ConversationDataSchema getConversationsCustomattributesSchema(String schemaId) throws IOException, ApiException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaWithHttpInfo

      public ApiResponse<ConversationDataSchema> getConversationsCustomattributesSchemaWithHttpInfo(String schemaId) throws IOException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      ConversationDataSchema
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchema

      public ConversationDataSchema getConversationsCustomattributesSchema(GetConversationsCustomattributesSchemaRequest request) throws IOException, ApiException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchema

      public ApiResponse<ConversationDataSchema> getConversationsCustomattributesSchema(ApiRequest<Void> request) throws IOException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersion

      public ConversationDataSchema getConversationsCustomattributesSchemaVersion(String schemaId, String versionId) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersionWithHttpInfo

      public ApiResponse<ConversationDataSchema> getConversationsCustomattributesSchemaVersionWithHttpInfo(String schemaId, String versionId) throws IOException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      ConversationDataSchema
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersion

      public ConversationDataSchema getConversationsCustomattributesSchemaVersion(GetConversationsCustomattributesSchemaVersionRequest request) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersion

      public ApiResponse<ConversationDataSchema> getConversationsCustomattributesSchemaVersion(ApiRequest<Void> request) throws IOException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersions

      public ConversationDataSchemaListing getConversationsCustomattributesSchemaVersions(String schemaId) throws IOException, ApiException
      Get all versions of a CCA schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      ConversationDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersionsWithHttpInfo

      public ApiResponse<ConversationDataSchemaListing> getConversationsCustomattributesSchemaVersionsWithHttpInfo(String schemaId) throws IOException
      Get all versions of a CCA schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      ConversationDataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersions

      public ConversationDataSchemaListing getConversationsCustomattributesSchemaVersions(GetConversationsCustomattributesSchemaVersionsRequest request) throws IOException, ApiException
      Get all versions of a CCA schema
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemaVersions

      public ApiResponse<ConversationDataSchemaListing> getConversationsCustomattributesSchemaVersions(ApiRequest<Void> request) throws IOException
      Get all versions of a CCA schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemas

      public ConversationDataSchemaListing getConversationsCustomattributesSchemas() throws IOException, ApiException
      Get a list of schemas.
      Returns:
      ConversationDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasWithHttpInfo

      public ApiResponse<ConversationDataSchemaListing> getConversationsCustomattributesSchemasWithHttpInfo() throws IOException
      Get a list of schemas.
      Returns:
      ConversationDataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemas

      public ConversationDataSchemaListing getConversationsCustomattributesSchemas(GetConversationsCustomattributesSchemasRequest request) throws IOException, ApiException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemas

      public ApiResponse<ConversationDataSchemaListing> getConversationsCustomattributesSchemas(ApiRequest<Void> request) throws IOException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretype

      public Coretype getConversationsCustomattributesSchemasCoretype(String coreTypeName) throws IOException, ApiException
      Get the core types from which all schemas are built.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretypeWithHttpInfo

      public ApiResponse<Coretype> getConversationsCustomattributesSchemasCoretypeWithHttpInfo(String coreTypeName) throws IOException
      Get the core types from which all schemas are built.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretype

      public Coretype getConversationsCustomattributesSchemasCoretype(GetConversationsCustomattributesSchemasCoretypeRequest request) throws IOException, ApiException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretype

      public ApiResponse<Coretype> getConversationsCustomattributesSchemasCoretype(ApiRequest<Void> request) throws IOException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretypes

      public CoretypeListing getConversationsCustomattributesSchemasCoretypes() throws IOException, ApiException
      Get the list of core types enabled for a specific namespace.
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretypesWithHttpInfo

      public ApiResponse<CoretypeListing> getConversationsCustomattributesSchemasCoretypesWithHttpInfo() throws IOException
      Get the list of core types enabled for a specific namespace.
      Returns:
      CoretypeListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretypes

      public CoretypeListing getConversationsCustomattributesSchemasCoretypes(GetConversationsCustomattributesSchemasCoretypesRequest request) throws IOException, ApiException
      Get the list of core types enabled for a specific namespace.
      Parameters:
      request - The request object
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasCoretypes

      public ApiResponse<CoretypeListing> getConversationsCustomattributesSchemasCoretypes(ApiRequest<Void> request) throws IOException
      Get the list of core types enabled for a specific namespace.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasLimits

      public SchemaQuantityLimits getConversationsCustomattributesSchemasLimits() throws IOException, ApiException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasLimitsWithHttpInfo

      public ApiResponse<SchemaQuantityLimits> getConversationsCustomattributesSchemasLimitsWithHttpInfo() throws IOException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasLimits

      public SchemaQuantityLimits getConversationsCustomattributesSchemasLimits(GetConversationsCustomattributesSchemasLimitsRequest request) throws IOException, ApiException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsCustomattributesSchemasLimits

      public ApiResponse<SchemaQuantityLimits> getConversationsCustomattributesSchemasLimits(ApiRequest<Void> request) throws IOException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmail

      public EmailConversation getConversationsEmail(String conversationId) throws IOException, ApiException
      Get email conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailWithHttpInfo

      public ApiResponse<EmailConversation> getConversationsEmailWithHttpInfo(String conversationId) throws IOException
      Get email conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmail

      public EmailConversation getConversationsEmail(GetConversationsEmailRequest request) throws IOException, ApiException
      Get email conversation
      Parameters:
      request - The request object
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmail

      public ApiResponse<EmailConversation> getConversationsEmail(ApiRequest<Void> request) throws IOException
      Get email conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessage

      public EmailMessage getConversationsEmailMessage(String conversationId, String messageId) throws IOException, ApiException
      Get conversation message
      Parameters:
      conversationId - conversationId (required)
      messageId - messageId (required)
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessageWithHttpInfo

      public ApiResponse<EmailMessage> getConversationsEmailMessageWithHttpInfo(String conversationId, String messageId) throws IOException
      Get conversation message
      Parameters:
      conversationId - conversationId (required)
      messageId - messageId (required)
      Returns:
      EmailMessage
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessage

      public EmailMessage getConversationsEmailMessage(GetConversationsEmailMessageRequest request) throws IOException, ApiException
      Get conversation message
      Parameters:
      request - The request object
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessage

      public ApiResponse<EmailMessage> getConversationsEmailMessage(ApiRequest<Void> request) throws IOException
      Get conversation message
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessages

      public EmailMessagePreviewListing getConversationsEmailMessages(String conversationId, Boolean includeAgentlessStitchedMessages) throws IOException, ApiException
      Get conversation messages
      Parameters:
      conversationId - conversationId (required)
      includeAgentlessStitchedMessages - Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message. (optional, default to false)
      Returns:
      EmailMessagePreviewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessagesWithHttpInfo

      public ApiResponse<EmailMessagePreviewListing> getConversationsEmailMessagesWithHttpInfo(String conversationId, Boolean includeAgentlessStitchedMessages) throws IOException
      Get conversation messages
      Parameters:
      conversationId - conversationId (required)
      includeAgentlessStitchedMessages - Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message. (optional, default to false)
      Returns:
      EmailMessagePreviewListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessages

      public EmailMessagePreviewListing getConversationsEmailMessages(GetConversationsEmailMessagesRequest request) throws IOException, ApiException
      Get conversation messages
      Parameters:
      request - The request object
      Returns:
      EmailMessagePreviewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessages

      public ApiResponse<EmailMessagePreviewListing> getConversationsEmailMessages(ApiRequest<Void> request) throws IOException
      Get conversation messages
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessagesDraft

      public EmailMessage getConversationsEmailMessagesDraft(String conversationId) throws IOException, ApiException
      Get conversation draft reply
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessagesDraftWithHttpInfo

      public ApiResponse<EmailMessage> getConversationsEmailMessagesDraftWithHttpInfo(String conversationId) throws IOException
      Get conversation draft reply
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailMessage
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailMessagesDraft

      public EmailMessage getConversationsEmailMessagesDraft(GetConversationsEmailMessagesDraftRequest request) throws IOException, ApiException
      Get conversation draft reply
      Parameters:
      request - The request object
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailMessagesDraft

      public ApiResponse<EmailMessage> getConversationsEmailMessagesDraft(ApiRequest<Void> request) throws IOException
      Get conversation draft reply
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsEmailParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsEmailParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsEmailParticipantCommunicationWrapup(GetConversationsEmailParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsEmailParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapup

      public AssignedWrapupCode getConversationsEmailParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsEmailParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapup

      public AssignedWrapupCode getConversationsEmailParticipantWrapup(GetConversationsEmailParticipantWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsEmailParticipantWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapupcodes

      public List<WrapupCode> getConversationsEmailParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsEmailParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapupcodes

      public List<WrapupCode> getConversationsEmailParticipantWrapupcodes(GetConversationsEmailParticipantWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsEmailParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailSettings

      public EmailsSettings getConversationsEmailSettings(String conversationId) throws IOException, ApiException
      Get emails settings for a given conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailsSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailSettingsWithHttpInfo

      public ApiResponse<EmailsSettings> getConversationsEmailSettingsWithHttpInfo(String conversationId) throws IOException
      Get emails settings for a given conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      EmailsSettings
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmailSettings

      public EmailsSettings getConversationsEmailSettings(GetConversationsEmailSettingsRequest request) throws IOException, ApiException
      Get emails settings for a given conversation
      Parameters:
      request - The request object
      Returns:
      EmailsSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailSettings

      public ApiResponse<EmailsSettings> getConversationsEmailSettings(ApiRequest<Void> request) throws IOException
      Get emails settings for a given conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmails

      public EmailConversationEntityListing getConversationsEmails() throws IOException, ApiException
      Get the logged-in user's active conversations and their Email participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?
      Returns:
      EmailConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmailsWithHttpInfo

      public ApiResponse<EmailConversationEntityListing> getConversationsEmailsWithHttpInfo() throws IOException
      Get the logged-in user's active conversations and their Email participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?
      Returns:
      EmailConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsEmails

      Get the logged-in user's active conversations and their Email participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?
      Parameters:
      request - The request object
      Returns:
      EmailConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsEmails

      public ApiResponse<EmailConversationEntityListing> getConversationsEmails(ApiRequest<Void> request) throws IOException
      Get the logged-in user's active conversations and their Email participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsInternalmessage

      public InternalMessageConversation getConversationsInternalmessage(String conversationId) throws IOException, ApiException
      Get internal message conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      InternalMessageConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsInternalmessageWithHttpInfo

      public ApiResponse<InternalMessageConversation> getConversationsInternalmessageWithHttpInfo(String conversationId) throws IOException
      Get internal message conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      InternalMessageConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsInternalmessage

      public InternalMessageConversation getConversationsInternalmessage(GetConversationsInternalmessageRequest request) throws IOException, ApiException
      Get internal message conversation
      Parameters:
      request - The request object
      Returns:
      InternalMessageConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsInternalmessage

      public ApiResponse<InternalMessageConversation> getConversationsInternalmessage(ApiRequest<Void> request) throws IOException
      Get internal message conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsInternalmessages

      public InternalMessageConversationEntityListing getConversationsInternalmessages() throws IOException, ApiException
      Get the logged-in user's active conversations and their InternalMessage participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?
      Returns:
      InternalMessageConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsInternalmessagesWithHttpInfo

      public ApiResponse<InternalMessageConversationEntityListing> getConversationsInternalmessagesWithHttpInfo() throws IOException
      Get the logged-in user's active conversations and their InternalMessage participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?
      Returns:
      InternalMessageConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsInternalmessages

      Get the logged-in user's active conversations and their InternalMessage participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?
      Parameters:
      request - The request object
      Returns:
      InternalMessageConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsInternalmessages

      public ApiResponse<InternalMessageConversationEntityListing> getConversationsInternalmessages(ApiRequest<Void> request) throws IOException
      Get the logged-in user's active conversations and their InternalMessage participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsKeyconfiguration

      public ConversationEncryptionConfiguration getConversationsKeyconfiguration(String keyconfigurationsId) throws IOException, ApiException
      Get the encryption key configurations
      Parameters:
      keyconfigurationsId - Key Configurations Id (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsKeyconfigurationWithHttpInfo

      public ApiResponse<ConversationEncryptionConfiguration> getConversationsKeyconfigurationWithHttpInfo(String keyconfigurationsId) throws IOException
      Get the encryption key configurations
      Parameters:
      keyconfigurationsId - Key Configurations Id (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsKeyconfiguration

      Get the encryption key configurations
      Parameters:
      request - The request object
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsKeyconfiguration

      public ApiResponse<ConversationEncryptionConfiguration> getConversationsKeyconfiguration(ApiRequest<Void> request) throws IOException
      Get the encryption key configurations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsKeyconfigurations

      public ConversationEncryptionConfigurationListing getConversationsKeyconfigurations() throws IOException, ApiException
      Get a list of key configurations data
      Returns:
      ConversationEncryptionConfigurationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsKeyconfigurationsWithHttpInfo

      public ApiResponse<ConversationEncryptionConfigurationListing> getConversationsKeyconfigurationsWithHttpInfo() throws IOException
      Get a list of key configurations data
      Returns:
      ConversationEncryptionConfigurationListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsKeyconfigurations

      Get a list of key configurations data
      Parameters:
      request - The request object
      Returns:
      ConversationEncryptionConfigurationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsKeyconfigurations

      public ApiResponse<ConversationEncryptionConfigurationListing> getConversationsKeyconfigurations(ApiRequest<Void> request) throws IOException
      Get a list of key configurations data
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessage

      public MessageConversation getConversationsMessage(String conversationId) throws IOException, ApiException
      Get message conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      MessageConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageWithHttpInfo

      public ApiResponse<MessageConversation> getConversationsMessageWithHttpInfo(String conversationId) throws IOException
      Get message conversation
      Parameters:
      conversationId - conversationId (required)
      Returns:
      MessageConversation
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessage

      public MessageConversation getConversationsMessage(GetConversationsMessageRequest request) throws IOException, ApiException
      Get message conversation
      Parameters:
      request - The request object
      Returns:
      MessageConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessage

      public ApiResponse<MessageConversation> getConversationsMessage(ApiRequest<Void> request) throws IOException
      Get message conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMedia

      public MessageMediaListing getConversationsMessageCommunicationMessagesMedia(String conversationId, String communicationId, String status, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get message media list by status
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      status - The status on which to filter the response. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      MessageMediaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMediaWithHttpInfo

      public ApiResponse<MessageMediaListing> getConversationsMessageCommunicationMessagesMediaWithHttpInfo(String conversationId, String communicationId, String status, Integer pageNumber, Integer pageSize) throws IOException
      Get message media list by status
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      status - The status on which to filter the response. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      MessageMediaListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMedia

      public MessageMediaListing getConversationsMessageCommunicationMessagesMedia(GetConversationsMessageCommunicationMessagesMediaRequest request) throws IOException, ApiException
      Get message media list by status
      Parameters:
      request - The request object
      Returns:
      MessageMediaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMedia

      public ApiResponse<MessageMediaListing> getConversationsMessageCommunicationMessagesMedia(ApiRequest<Void> request) throws IOException
      Get message media list by status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMediaMediaId

      public MessageMediaData getConversationsMessageCommunicationMessagesMediaMediaId(String conversationId, String communicationId, String mediaId) throws IOException, ApiException
      Get media See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      mediaId - mediaId (required)
      Returns:
      MessageMediaData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMediaMediaIdWithHttpInfo

      public ApiResponse<MessageMediaData> getConversationsMessageCommunicationMessagesMediaMediaIdWithHttpInfo(String conversationId, String communicationId, String mediaId) throws IOException
      Get media See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      mediaId - mediaId (required)
      Returns:
      MessageMediaData
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMediaMediaId

      public MessageMediaData getConversationsMessageCommunicationMessagesMediaMediaId(GetConversationsMessageCommunicationMessagesMediaMediaIdRequest request) throws IOException, ApiException
      Get media See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      request - The request object
      Returns:
      MessageMediaData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageCommunicationMessagesMediaMediaId

      public ApiResponse<MessageMediaData> getConversationsMessageCommunicationMessagesMediaMediaId(ApiRequest<Void> request) throws IOException
      Get media See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageDetails

      public MessageData getConversationsMessageDetails(String messageId, Boolean useNormalizedMessage) throws IOException, ApiException
      Get message
      Parameters:
      messageId - messageId (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageDetailsWithHttpInfo

      public ApiResponse<MessageData> getConversationsMessageDetailsWithHttpInfo(String messageId, Boolean useNormalizedMessage) throws IOException
      Get message
      Parameters:
      messageId - messageId (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageDetails

      public MessageData getConversationsMessageDetails(GetConversationsMessageDetailsRequest request) throws IOException, ApiException
      Get message
      Parameters:
      request - The request object
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageDetails

      public ApiResponse<MessageData> getConversationsMessageDetails(ApiRequest<Void> request) throws IOException
      Get message
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageMessage

      public MessageData getConversationsMessageMessage(String conversationId, String messageId, Boolean useNormalizedMessage) throws IOException, ApiException
      Get conversation message
      Parameters:
      conversationId - conversationId (required)
      messageId - messageId (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageMessageWithHttpInfo

      public ApiResponse<MessageData> getConversationsMessageMessageWithHttpInfo(String conversationId, String messageId, Boolean useNormalizedMessage) throws IOException
      Get conversation message
      Parameters:
      conversationId - conversationId (required)
      messageId - messageId (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageMessage

      public MessageData getConversationsMessageMessage(GetConversationsMessageMessageRequest request) throws IOException, ApiException
      Get conversation message
      Parameters:
      request - The request object
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageMessage

      public ApiResponse<MessageData> getConversationsMessageMessage(ApiRequest<Void> request) throws IOException
      Get conversation message
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsMessageParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsMessageParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsMessageParticipantCommunicationWrapup(GetConversationsMessageParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsMessageParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapup

      public AssignedWrapupCode getConversationsMessageParticipantWrapup(String conversationId, String participantId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsMessageParticipantWrapupWithHttpInfo(String conversationId, String participantId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapup

      public AssignedWrapupCode getConversationsMessageParticipantWrapup(GetConversationsMessageParticipantWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsMessageParticipantWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapupcodes

      public List<WrapupCode> getConversationsMessageParticipantWrapupcodes(String conversationId, String participantId) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> getConversationsMessageParticipantWrapupcodesWithHttpInfo(String conversationId, String participantId) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapupcodes

      public List<WrapupCode> getConversationsMessageParticipantWrapupcodes(GetConversationsMessageParticipantWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessageParticipantWrapupcodes

      public ApiResponse<List<WrapupCode>> getConversationsMessageParticipantWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes for this conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessages

      public MessageConversationEntityListing getConversationsMessages() throws IOException, ApiException
      Get the logged-in user's active conversations and their Message participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?
      Returns:
      MessageConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagesWithHttpInfo

      public ApiResponse<MessageConversationEntityListing> getConversationsMessagesWithHttpInfo() throws IOException
      Get the logged-in user's active conversations and their Message participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?
      Returns:
      MessageConversationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessages

      Get the logged-in user's active conversations and their Message participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?
      Parameters:
      request - The request object
      Returns:
      MessageConversationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessages

      public ApiResponse<MessageConversationEntityListing> getConversationsMessages(ApiRequest<Void> request) throws IOException
      Get the logged-in user's active conversations and their Message participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmedia

      public CachedMediaItemEntityListing getConversationsMessagesCachedmedia(Integer pageSize, Integer pageNumber, String url) throws IOException, ApiException
      Get a list of cached media items
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      url - URL to search for (optional)
      Returns:
      CachedMediaItemEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmediaWithHttpInfo

      public ApiResponse<CachedMediaItemEntityListing> getConversationsMessagesCachedmediaWithHttpInfo(Integer pageSize, Integer pageNumber, String url) throws IOException
      Get a list of cached media items
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      url - URL to search for (optional)
      Returns:
      CachedMediaItemEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmedia

      public CachedMediaItemEntityListing getConversationsMessagesCachedmedia(GetConversationsMessagesCachedmediaRequest request) throws IOException, ApiException
      Get a list of cached media items
      Parameters:
      request - The request object
      Returns:
      CachedMediaItemEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmedia

      public ApiResponse<CachedMediaItemEntityListing> getConversationsMessagesCachedmedia(ApiRequest<Void> request) throws IOException
      Get a list of cached media items
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmediaCachedMediaItemId

      public CachedMediaItem getConversationsMessagesCachedmediaCachedMediaItemId(String cachedMediaItemId) throws IOException, ApiException
      Get a cached media item
      Parameters:
      cachedMediaItemId - cachedMediaItemId (required)
      Returns:
      CachedMediaItem
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmediaCachedMediaItemIdWithHttpInfo

      public ApiResponse<CachedMediaItem> getConversationsMessagesCachedmediaCachedMediaItemIdWithHttpInfo(String cachedMediaItemId) throws IOException
      Get a cached media item
      Parameters:
      cachedMediaItemId - cachedMediaItemId (required)
      Returns:
      CachedMediaItem
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmediaCachedMediaItemId

      public CachedMediaItem getConversationsMessagesCachedmediaCachedMediaItemId(GetConversationsMessagesCachedmediaCachedMediaItemIdRequest request) throws IOException, ApiException
      Get a cached media item
      Parameters:
      request - The request object
      Returns:
      CachedMediaItem
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagesCachedmediaCachedMediaItemId

      public ApiResponse<CachedMediaItem> getConversationsMessagesCachedmediaCachedMediaItemId(ApiRequest<Void> request) throws IOException
      Get a cached media item
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookApp

      public FacebookAppCredentials getConversationsMessagingFacebookApp() throws IOException, ApiException
      Get Genesys Facebook App Id
      Returns:
      FacebookAppCredentials
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookAppWithHttpInfo

      public ApiResponse<FacebookAppCredentials> getConversationsMessagingFacebookAppWithHttpInfo() throws IOException
      Get Genesys Facebook App Id
      Returns:
      FacebookAppCredentials
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookApp

      public FacebookAppCredentials getConversationsMessagingFacebookApp(GetConversationsMessagingFacebookAppRequest request) throws IOException, ApiException
      Get Genesys Facebook App Id
      Parameters:
      request - The request object
      Returns:
      FacebookAppCredentials
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookApp

      public ApiResponse<FacebookAppCredentials> getConversationsMessagingFacebookApp(ApiRequest<Void> request) throws IOException
      Get Genesys Facebook App Id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookPermissions

      public FacebookPermissionEntityListing getConversationsMessagingFacebookPermissions() throws IOException, ApiException
      Get a list of Facebook Permissions
      Returns:
      FacebookPermissionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookPermissionsWithHttpInfo

      public ApiResponse<FacebookPermissionEntityListing> getConversationsMessagingFacebookPermissionsWithHttpInfo() throws IOException
      Get a list of Facebook Permissions
      Returns:
      FacebookPermissionEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookPermissions

      public FacebookPermissionEntityListing getConversationsMessagingFacebookPermissions(GetConversationsMessagingFacebookPermissionsRequest request) throws IOException, ApiException
      Get a list of Facebook Permissions
      Parameters:
      request - The request object
      Returns:
      FacebookPermissionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingFacebookPermissions

      public ApiResponse<FacebookPermissionEntityListing> getConversationsMessagingFacebookPermissions(ApiRequest<Void> request) throws IOException
      Get a list of Facebook Permissions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public AppleIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(String integrationId) throws IOException, ApiException
      Get Apple messaging integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdWithHttpInfo

      public ApiResponse<AppleIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get Apple messaging integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public AppleIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdRequest request) throws IOException, ApiException
      Get Apple messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public ApiResponse<AppleIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(ApiRequest<Void> request) throws IOException
      Get Apple messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public FacebookIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(String integrationId) throws IOException, ApiException
      Get Facebook messaging integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdWithHttpInfo

      public ApiResponse<FacebookIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get Facebook messaging integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public FacebookIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdRequest request) throws IOException, ApiException
      Get Facebook messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public ApiResponse<FacebookIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(ApiRequest<Void> request) throws IOException
      Get Facebook messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public InstagramIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(String integrationId) throws IOException, ApiException
      Get an Instagram integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdWithHttpInfo

      public ApiResponse<InstagramIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get an Instagram integration identity resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public InstagramIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdRequest request) throws IOException, ApiException
      Get an Instagram integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public ApiResponse<InstagramIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(ApiRequest<Void> request) throws IOException
      Get an Instagram integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public OpenMessagingIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(String integrationId) throws IOException, ApiException
      Get an open messaging integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdWithHttpInfo

      public ApiResponse<OpenMessagingIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get an open messaging integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public OpenMessagingIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdRequest request) throws IOException, ApiException
      Get an open messaging integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public ApiResponse<OpenMessagingIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(ApiRequest<Void> request) throws IOException
      Get an open messaging integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public TwitterIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(String integrationId) throws IOException, ApiException
      Get X (Formally Twitter) messaging integration identity resolution settings
      Parameters:
      integrationId - Integration Id (required)
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdWithHttpInfo

      public ApiResponse<TwitterIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get X (Formally Twitter) messaging integration identity resolution settings
      Parameters:
      integrationId - Integration Id (required)
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public TwitterIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdRequest request) throws IOException, ApiException
      Get X (Formally Twitter) messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public ApiResponse<TwitterIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(ApiRequest<Void> request) throws IOException
      Get X (Formally Twitter) messaging integration identity resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public WhatsAppIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(String integrationId) throws IOException, ApiException
      Get a whatsApp integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdWithHttpInfo(String integrationId) throws IOException
      Get a whatsApp integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public WhatsAppIdentityResolutionConfig getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(GetConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdRequest request) throws IOException, ApiException
      Get a whatsApp integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public ApiResponse<WhatsAppIdentityResolutionConfig> getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(ApiRequest<Void> request) throws IOException
      Get a whatsApp integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationTwitterOauthSettings

      public TwitterOAuthSettings getConversationsMessagingIntegrationTwitterOauthSettings(String integrationId) throws IOException, ApiException
      Get twitter oauth settings to patch an integration
      Parameters:
      integrationId - Integration Id of an existing integration that needs to be patched with new oauth settings (required)
      Returns:
      TwitterOAuthSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationTwitterOauthSettingsWithHttpInfo

      public ApiResponse<TwitterOAuthSettings> getConversationsMessagingIntegrationTwitterOauthSettingsWithHttpInfo(String integrationId) throws IOException
      Get twitter oauth settings to patch an integration
      Parameters:
      integrationId - Integration Id of an existing integration that needs to be patched with new oauth settings (required)
      Returns:
      TwitterOAuthSettings
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationTwitterOauthSettings

      public TwitterOAuthSettings getConversationsMessagingIntegrationTwitterOauthSettings(GetConversationsMessagingIntegrationTwitterOauthSettingsRequest request) throws IOException, ApiException
      Get twitter oauth settings to patch an integration
      Parameters:
      request - The request object
      Returns:
      TwitterOAuthSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationTwitterOauthSettings

      public ApiResponse<TwitterOAuthSettings> getConversationsMessagingIntegrationTwitterOauthSettings(ApiRequest<Void> request) throws IOException
      Get twitter oauth settings to patch an integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrations

      public MessagingIntegrationEntityListing getConversationsMessagingIntegrations(Integer pageSize, Integer pageNumber, List<String> expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      MessagingIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWithHttpInfo

      public ApiResponse<MessagingIntegrationEntityListing> getConversationsMessagingIntegrationsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      MessagingIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrations

      public MessagingIntegrationEntityListing getConversationsMessagingIntegrations(GetConversationsMessagingIntegrationsRequest request) throws IOException, ApiException
      Get a list of Integrations
      Parameters:
      request - The request object
      Returns:
      MessagingIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrations

      public ApiResponse<MessagingIntegrationEntityListing> getConversationsMessagingIntegrations(ApiRequest<Void> request) throws IOException
      Get a list of Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsApple

      public AppleIntegrationEntityListing getConversationsMessagingIntegrationsApple(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Apple Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      AppleIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsAppleWithHttpInfo

      public ApiResponse<AppleIntegrationEntityListing> getConversationsMessagingIntegrationsAppleWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Apple Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      AppleIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsApple

      public AppleIntegrationEntityListing getConversationsMessagingIntegrationsApple(GetConversationsMessagingIntegrationsAppleRequest request) throws IOException, ApiException
      Get a list of Apple Integrations
      Parameters:
      request - The request object
      Returns:
      AppleIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsApple

      public ApiResponse<AppleIntegrationEntityListing> getConversationsMessagingIntegrationsApple(ApiRequest<Void> request) throws IOException
      Get a list of Apple Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsAppleIntegrationId

      public AppleIntegration getConversationsMessagingIntegrationsAppleIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo

      public ApiResponse<AppleIntegration> getConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      AppleIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsAppleIntegrationId

      public AppleIntegration getConversationsMessagingIntegrationsAppleIntegrationId(GetConversationsMessagingIntegrationsAppleIntegrationIdRequest request) throws IOException, ApiException
      Get an Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsAppleIntegrationId

      public ApiResponse<AppleIntegration> getConversationsMessagingIntegrationsAppleIntegrationId(ApiRequest<Void> request) throws IOException
      Get an Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebook

      public FacebookIntegrationEntityListing getConversationsMessagingIntegrationsFacebook(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Facebook Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      FacebookIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebookWithHttpInfo

      public ApiResponse<FacebookIntegrationEntityListing> getConversationsMessagingIntegrationsFacebookWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Facebook Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      FacebookIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebook

      public FacebookIntegrationEntityListing getConversationsMessagingIntegrationsFacebook(GetConversationsMessagingIntegrationsFacebookRequest request) throws IOException, ApiException
      Get a list of Facebook Integrations
      Parameters:
      request - The request object
      Returns:
      FacebookIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebook

      public ApiResponse<FacebookIntegrationEntityListing> getConversationsMessagingIntegrationsFacebook(ApiRequest<Void> request) throws IOException
      Get a list of Facebook Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebookIntegrationId

      public FacebookIntegration getConversationsMessagingIntegrationsFacebookIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo

      public ApiResponse<FacebookIntegration> getConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      FacebookIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebookIntegrationId

      public FacebookIntegration getConversationsMessagingIntegrationsFacebookIntegrationId(GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest request) throws IOException, ApiException
      Get a Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsFacebookIntegrationId

      public ApiResponse<FacebookIntegration> getConversationsMessagingIntegrationsFacebookIntegrationId(ApiRequest<Void> request) throws IOException
      Get a Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagram

      public InstagramIntegrationEntityListing getConversationsMessagingIntegrationsInstagram(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Instagram Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      InstagramIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagramWithHttpInfo

      public ApiResponse<InstagramIntegrationEntityListing> getConversationsMessagingIntegrationsInstagramWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Instagram Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      InstagramIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagram

      public InstagramIntegrationEntityListing getConversationsMessagingIntegrationsInstagram(GetConversationsMessagingIntegrationsInstagramRequest request) throws IOException, ApiException
      Get a list of Instagram Integrations
      Parameters:
      request - The request object
      Returns:
      InstagramIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagram

      public ApiResponse<InstagramIntegrationEntityListing> getConversationsMessagingIntegrationsInstagram(ApiRequest<Void> request) throws IOException
      Get a list of Instagram Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagramIntegrationId

      public InstagramIntegration getConversationsMessagingIntegrationsInstagramIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo

      public ApiResponse<InstagramIntegration> getConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      InstagramIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagramIntegrationId

      public InstagramIntegration getConversationsMessagingIntegrationsInstagramIntegrationId(GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest request) throws IOException, ApiException
      Get Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsInstagramIntegrationId

      public ApiResponse<InstagramIntegration> getConversationsMessagingIntegrationsInstagramIntegrationId(ApiRequest<Void> request) throws IOException
      Get Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpen

      public OpenIntegrationEntityListing getConversationsMessagingIntegrationsOpen(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Open messaging integrations See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      OpenIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenWithHttpInfo

      public ApiResponse<OpenIntegrationEntityListing> getConversationsMessagingIntegrationsOpenWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Open messaging integrations See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      OpenIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpen

      public OpenIntegrationEntityListing getConversationsMessagingIntegrationsOpen(GetConversationsMessagingIntegrationsOpenRequest request) throws IOException, ApiException
      Get a list of Open messaging integrations See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      OpenIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpen

      public ApiResponse<OpenIntegrationEntityListing> getConversationsMessagingIntegrationsOpen(ApiRequest<Void> request) throws IOException
      Get a list of Open messaging integrations See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public GoogleBusinessProfileOpenIntegration getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo

      public ApiResponse<GoogleBusinessProfileOpenIntegration> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public GoogleBusinessProfileOpenIntegration getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(GetConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdRequest request) throws IOException, ApiException
      Get an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public ApiResponse<GoogleBusinessProfileOpenIntegration> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(ApiRequest<Void> request) throws IOException
      Get an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings

      public GoogleOAuthSettingsResponse getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings() throws IOException, ApiException
      Get Google Business Profile OAuth 2 settings See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Returns:
      GoogleOAuthSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettingsWithHttpInfo

      public ApiResponse<GoogleOAuthSettingsResponse> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettingsWithHttpInfo() throws IOException
      Get Google Business Profile OAuth 2 settings See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Returns:
      GoogleOAuthSettingsResponse
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings

      public GoogleOAuthSettingsResponse getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings(GetConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettingsRequest request) throws IOException, ApiException
      Get Google Business Profile OAuth 2 settings See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleOAuthSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings

      public ApiResponse<GoogleOAuthSettingsResponse> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings(ApiRequest<Void> request) throws IOException
      Get Google Business Profile OAuth 2 settings See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken

      public GoogleAuthToken getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken(String tokenId) throws IOException, ApiException
      Get a Google Auth Token See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      tokenId - Token ID (required)
      Returns:
      GoogleAuthToken
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenWithHttpInfo

      public ApiResponse<GoogleAuthToken> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenWithHttpInfo(String tokenId) throws IOException
      Get a Google Auth Token See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      tokenId - Token ID (required)
      Returns:
      GoogleAuthToken
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken

      public GoogleAuthToken getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken(GetConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenRequest request) throws IOException, ApiException
      Get a Google Auth Token See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleAuthToken
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken

      public ApiResponse<GoogleAuthToken> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken(ApiRequest<Void> request) throws IOException
      Get a Google Auth Token See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts

      public GoogleBusinessProfileAccountListing getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts(String tokenId) throws IOException, ApiException
      Get Google Business Profile accounts See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      tokenId - Token ID (required)
      Returns:
      GoogleBusinessProfileAccountListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccountsWithHttpInfo

      public ApiResponse<GoogleBusinessProfileAccountListing> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccountsWithHttpInfo(String tokenId) throws IOException
      Get Google Business Profile accounts See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      tokenId - Token ID (required)
      Returns:
      GoogleBusinessProfileAccountListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts

      public GoogleBusinessProfileAccountListing getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts(GetConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccountsRequest request) throws IOException, ApiException
      Get Google Business Profile accounts See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleBusinessProfileAccountListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts

      public ApiResponse<GoogleBusinessProfileAccountListing> getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts(ApiRequest<Void> request) throws IOException
      Get Google Business Profile accounts See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenIntegrationId

      public OpenIntegration getConversationsMessagingIntegrationsOpenIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo

      public ApiResponse<OpenIntegration> getConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      OpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenIntegrationId

      public OpenIntegration getConversationsMessagingIntegrationsOpenIntegrationId(GetConversationsMessagingIntegrationsOpenIntegrationIdRequest request) throws IOException, ApiException
      Get an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsOpenIntegrationId

      public ApiResponse<OpenIntegration> getConversationsMessagingIntegrationsOpenIntegrationId(ApiRequest<Void> request) throws IOException
      Get an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitter

      public TwitterIntegrationEntityListing getConversationsMessagingIntegrationsTwitter(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of Twitter Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      TwitterIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterWithHttpInfo

      public ApiResponse<TwitterIntegrationEntityListing> getConversationsMessagingIntegrationsTwitterWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of Twitter Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      TwitterIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitter

      public TwitterIntegrationEntityListing getConversationsMessagingIntegrationsTwitter(GetConversationsMessagingIntegrationsTwitterRequest request) throws IOException, ApiException
      Get a list of Twitter Integrations
      Parameters:
      request - The request object
      Returns:
      TwitterIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitter

      public ApiResponse<TwitterIntegrationEntityListing> getConversationsMessagingIntegrationsTwitter(ApiRequest<Void> request) throws IOException
      Get a list of Twitter Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterIntegrationId

      public TwitterIntegration getConversationsMessagingIntegrationsTwitterIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo

      public ApiResponse<TwitterIntegration> getConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      TwitterIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterIntegrationId

      public TwitterIntegration getConversationsMessagingIntegrationsTwitterIntegrationId(GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest request) throws IOException, ApiException
      Get Twitter messaging integration
      Parameters:
      request - The request object
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterIntegrationId

      public ApiResponse<TwitterIntegration> getConversationsMessagingIntegrationsTwitterIntegrationId(ApiRequest<Void> request) throws IOException
      Get Twitter messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterOauthSettings

      public TwitterSignupOAuthSettings getConversationsMessagingIntegrationsTwitterOauthSettings() throws IOException, ApiException
      Get twitter oauth settings
      Returns:
      TwitterSignupOAuthSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterOauthSettingsWithHttpInfo

      public ApiResponse<TwitterSignupOAuthSettings> getConversationsMessagingIntegrationsTwitterOauthSettingsWithHttpInfo() throws IOException
      Get twitter oauth settings
      Returns:
      TwitterSignupOAuthSettings
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterOauthSettings

      public TwitterSignupOAuthSettings getConversationsMessagingIntegrationsTwitterOauthSettings(GetConversationsMessagingIntegrationsTwitterOauthSettingsRequest request) throws IOException, ApiException
      Get twitter oauth settings
      Parameters:
      request - The request object
      Returns:
      TwitterSignupOAuthSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsTwitterOauthSettings

      public ApiResponse<TwitterSignupOAuthSettings> getConversationsMessagingIntegrationsTwitterOauthSettings(ApiRequest<Void> request) throws IOException
      Get twitter oauth settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsapp

      public WhatsAppIntegrationEntityListing getConversationsMessagingIntegrationsWhatsapp(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException, ApiException
      Get a list of WhatsApp Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      WhatsAppIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsappWithHttpInfo

      public ApiResponse<WhatsAppIntegrationEntityListing> getConversationsMessagingIntegrationsWhatsappWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String supportedContentId, String messagingSettingId) throws IOException
      Get a list of WhatsApp Integrations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Expand instructions for the return value. (optional)
      supportedContentId - Filter integrations returned based on the supported content ID (optional)
      messagingSettingId - Filter integrations returned based on the setting ID (optional)
      Returns:
      WhatsAppIntegrationEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsapp

      public WhatsAppIntegrationEntityListing getConversationsMessagingIntegrationsWhatsapp(GetConversationsMessagingIntegrationsWhatsappRequest request) throws IOException, ApiException
      Get a list of WhatsApp Integrations
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegrationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsapp

      public ApiResponse<WhatsAppIntegrationEntityListing> getConversationsMessagingIntegrationsWhatsapp(ApiRequest<Void> request) throws IOException
      Get a list of WhatsApp Integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration getConversationsMessagingIntegrationsWhatsappIntegrationId(String integrationId, String expand) throws IOException, ApiException
      Get a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIntegration> getConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo(String integrationId, String expand) throws IOException
      Get a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      expand - Expand instructions for the return value. (optional)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration getConversationsMessagingIntegrationsWhatsappIntegrationId(GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest request) throws IOException, ApiException
      Get a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingIntegrationsWhatsappIntegrationId

      public ApiResponse<WhatsAppIntegration> getConversationsMessagingIntegrationsWhatsappIntegrationId(ApiRequest<Void> request) throws IOException
      Get a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingOauthAppleCallback

      public OAuthAppleAuthorizationResponse getConversationsMessagingOauthAppleCallback(String code, String state, String error) throws IOException, ApiException
      Call Authentication provider callback to validate state and code
      Parameters:
      code - The authorization code to be sent to the authentication server during the token request. (required)
      state - The state/nonce value generated by Genesys Auth-Client Service. (required)
      error - Error parameter from OAuth provider (optional)
      Returns:
      OAuthAppleAuthorizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingOauthAppleCallbackWithHttpInfo

      public ApiResponse<OAuthAppleAuthorizationResponse> getConversationsMessagingOauthAppleCallbackWithHttpInfo(String code, String state, String error) throws IOException
      Call Authentication provider callback to validate state and code
      Parameters:
      code - The authorization code to be sent to the authentication server during the token request. (required)
      state - The state/nonce value generated by Genesys Auth-Client Service. (required)
      error - Error parameter from OAuth provider (optional)
      Returns:
      OAuthAppleAuthorizationResponse
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingOauthAppleCallback

      public OAuthAppleAuthorizationResponse getConversationsMessagingOauthAppleCallback(GetConversationsMessagingOauthAppleCallbackRequest request) throws IOException, ApiException
      Call Authentication provider callback to validate state and code
      Parameters:
      request - The request object
      Returns:
      OAuthAppleAuthorizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingOauthAppleCallback

      public ApiResponse<OAuthAppleAuthorizationResponse> getConversationsMessagingOauthAppleCallback(ApiRequest<Void> request) throws IOException
      Call Authentication provider callback to validate state and code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSetting

      public MessagingSetting getConversationsMessagingSetting(String messageSettingId) throws IOException, ApiException
      Get a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingWithHttpInfo

      public ApiResponse<MessagingSetting> getConversationsMessagingSettingWithHttpInfo(String messageSettingId) throws IOException
      Get a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSetting

      public MessagingSetting getConversationsMessagingSetting(GetConversationsMessagingSettingRequest request) throws IOException, ApiException
      Get a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSetting

      public ApiResponse<MessagingSetting> getConversationsMessagingSetting(ApiRequest<Void> request) throws IOException
      Get a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSettings

      public MessagingConfigListing getConversationsMessagingSettings(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a list of messaging settings
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      MessagingConfigListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingsWithHttpInfo

      public ApiResponse<MessagingConfigListing> getConversationsMessagingSettingsWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a list of messaging settings
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      MessagingConfigListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSettings

      public MessagingConfigListing getConversationsMessagingSettings(GetConversationsMessagingSettingsRequest request) throws IOException, ApiException
      Get a list of messaging settings
      Parameters:
      request - The request object
      Returns:
      MessagingConfigListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSettings

      public ApiResponse<MessagingConfigListing> getConversationsMessagingSettings(ApiRequest<Void> request) throws IOException
      Get a list of messaging settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingsDefault

      public MessagingSetting getConversationsMessagingSettingsDefault() throws IOException, ApiException
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<MessagingSetting> getConversationsMessagingSettingsDefaultWithHttpInfo() throws IOException
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingsDefault

      public MessagingSetting getConversationsMessagingSettingsDefault(GetConversationsMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSettingsDefault

      public ApiResponse<MessagingSetting> getConversationsMessagingSettingsDefault(ApiRequest<Void> request) throws IOException
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontent

      public SupportedContentListing getConversationsMessagingSupportedcontent(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a list of Supported Content profiles
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SupportedContentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentWithHttpInfo

      public ApiResponse<SupportedContentListing> getConversationsMessagingSupportedcontentWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a list of Supported Content profiles
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SupportedContentListing
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontent

      public SupportedContentListing getConversationsMessagingSupportedcontent(GetConversationsMessagingSupportedcontentRequest request) throws IOException, ApiException
      Get a list of Supported Content profiles
      Parameters:
      request - The request object
      Returns:
      SupportedContentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontent

      public ApiResponse<SupportedContentListing> getConversationsMessagingSupportedcontent(ApiRequest<Void> request) throws IOException
      Get a list of Supported Content profiles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentDefault

      public SupportedContent getConversationsMessagingSupportedcontentDefault() throws IOException, ApiException
      Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentDefaultWithHttpInfo

      public ApiResponse<SupportedContent> getConversationsMessagingSupportedcontentDefaultWithHttpInfo() throws IOException
      Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentDefault

      public SupportedContent getConversationsMessagingSupportedcontentDefault(GetConversationsMessagingSupportedcontentDefaultRequest request) throws IOException, ApiException
      Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentDefault

      public ApiResponse<SupportedContent> getConversationsMessagingSupportedcontentDefault(ApiRequest<Void> request) throws IOException
      Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentSupportedContentId

      public SupportedContent getConversationsMessagingSupportedcontentSupportedContentId(String supportedContentId) throws IOException, ApiException
      Get a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<SupportedContent> getConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId) throws IOException
      Get a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentSupportedContentId

      public SupportedContent getConversationsMessagingSupportedcontentSupportedContentId(GetConversationsMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Get a supported content profile
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingSupportedcontentSupportedContentId

      public ApiResponse<SupportedContent> getConversationsMessagingSupportedcontentSupportedContentId(ApiRequest<Void> request) throws IOException
      Get a supported content profile
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingThreadingtimeline

      public ConversationThreadingWindow getConversationsMessagingThreadingtimeline() throws IOException, ApiException
      Get conversation threading window timeline for each messaging type Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
      Returns:
      ConversationThreadingWindow
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingThreadingtimelineWithHttpInfo

      public ApiResponse<ConversationThreadingWindow> getConversationsMessagingThreadingtimelineWithHttpInfo() throws IOException
      Get conversation threading window timeline for each messaging type Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
      Returns:
      ConversationThreadingWindow
      Throws:
      IOException - if the request fails to be processed
    • getConversationsMessagingThreadingtimeline

      public ConversationThreadingWindow getConversationsMessagingThreadingtimeline(GetConversationsMessagingThreadingtimelineRequest request) throws IOException, ApiException
      Get conversation threading window timeline for each messaging type Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
      Parameters:
      request - The request object
      Returns:
      ConversationThreadingWindow
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsMessagingThreadingtimeline

      public ApiResponse<ConversationThreadingWindow> getConversationsMessagingThreadingtimeline(ApiRequest<Void> request) throws IOException
      Get conversation threading window timeline for each messaging type Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsScreenshareParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsScreenshareParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsScreenshareParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsScreenshareParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsScreenshareParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsScreenshareParticipantCommunicationWrapup(GetConversationsScreenshareParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Get the wrap-up for this conversation communication. 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:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsScreenshareParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsScreenshareParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the wrap-up for this conversation communication. 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
    • getConversationsSettings

      public Settings getConversationsSettings() throws IOException, ApiException
      Get Settings
      Returns:
      Settings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsSettingsWithHttpInfo

      public ApiResponse<Settings> getConversationsSettingsWithHttpInfo() throws IOException
      Get Settings
      Returns:
      Settings
      Throws:
      IOException - if the request fails to be processed
    • getConversationsSettings

      public Settings getConversationsSettings(GetConversationsSettingsRequest request) throws IOException, ApiException
      Get Settings
      Parameters:
      request - The request object
      Returns:
      Settings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsSettings

      public ApiResponse<Settings> getConversationsSettings(ApiRequest<Void> request) throws IOException
      Get Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsSocialParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsSocialParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsSocialParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsSocialParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsSocialParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsSocialParticipantCommunicationWrapup(GetConversationsSocialParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsSocialParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsSocialParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideoDetails

      public VideoConferenceDetails getConversationsVideoDetails(String conferenceId) throws IOException, ApiException
      Get video conference details (e.g. the current number of active participants). getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conferenceId - conferenceId (required)
      Returns:
      VideoConferenceDetails
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideoDetailsWithHttpInfo

      public ApiResponse<VideoConferenceDetails> getConversationsVideoDetailsWithHttpInfo(String conferenceId) throws IOException
      Get video conference details (e.g. the current number of active participants). getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conferenceId - conferenceId (required)
      Returns:
      VideoConferenceDetails
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideoDetails

      public VideoConferenceDetails getConversationsVideoDetails(GetConversationsVideoDetailsRequest request) throws IOException, ApiException
      Get video conference details (e.g. the current number of active participants). getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      VideoConferenceDetails
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideoDetails

      public ApiResponse<VideoConferenceDetails> getConversationsVideoDetails(ApiRequest<Void> request) throws IOException
      Get video conference details (e.g. the current number of active participants). getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideoParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsVideoParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideoParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<AssignedWrapupCode> getConversationsVideoParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, Boolean provisional) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      provisional - Indicates whether or not to fetch provisional wrap-up code. (optional, default to false)
      Returns:
      AssignedWrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideoParticipantCommunicationWrapup

      public AssignedWrapupCode getConversationsVideoParticipantCommunicationWrapup(GetConversationsVideoParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AssignedWrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideoParticipantCommunicationWrapup

      public ApiResponse<AssignedWrapupCode> getConversationsVideoParticipantCommunicationWrapup(ApiRequest<Void> request) throws IOException
      Get the wrap-up for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideosMeeting

      public MeetingIdRecord getConversationsVideosMeeting(String meetingId) throws IOException, ApiException
      Gets a record for a given meetingId
      Parameters:
      meetingId - meetingId (required)
      Returns:
      MeetingIdRecord
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideosMeetingWithHttpInfo

      public ApiResponse<MeetingIdRecord> getConversationsVideosMeetingWithHttpInfo(String meetingId) throws IOException
      Gets a record for a given meetingId
      Parameters:
      meetingId - meetingId (required)
      Returns:
      MeetingIdRecord
      Throws:
      IOException - if the request fails to be processed
    • getConversationsVideosMeeting

      public MeetingIdRecord getConversationsVideosMeeting(GetConversationsVideosMeetingRequest request) throws IOException, ApiException
      Gets a record for a given meetingId
      Parameters:
      request - The request object
      Returns:
      MeetingIdRecord
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getConversationsVideosMeeting

      public ApiResponse<MeetingIdRecord> getConversationsVideosMeeting(ApiRequest<Void> request) throws IOException
      Gets a record for a given meetingId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationCustomattributes

      public void patchConversationCustomattributes(String conversationId, CustomAttributesPatchRequest body) throws IOException, ApiException
      Update a single custom attributes record by amending the data with only the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationCustomattributesWithHttpInfo

      public ApiResponse<Void> patchConversationCustomattributesWithHttpInfo(String conversationId, CustomAttributesPatchRequest body) throws IOException
      Update a single custom attributes record by amending the data with only the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationCustomattributes

      public void patchConversationCustomattributes(PatchConversationCustomattributesRequest request) throws IOException, ApiException
      Update a single custom attributes record by amending the data with only the provided fields.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationCustomattributes

      public ApiResponse<Void> patchConversationCustomattributes(ApiRequest<CustomAttributesPatchRequest> request) throws IOException
      Update a single custom attributes record by amending the data with only the provided fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationCustomattributesBulk

      public CustomAttributesBulkUpdateResponseMap patchConversationCustomattributesBulk(String conversationId, List<CustomAttributesPatchRequest> body) throws IOException, ApiException
      Update a list of custom attributes record by amending the data with only the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationCustomattributesBulkWithHttpInfo

      public ApiResponse<CustomAttributesBulkUpdateResponseMap> patchConversationCustomattributesBulkWithHttpInfo(String conversationId, List<CustomAttributesPatchRequest> body) throws IOException
      Update a list of custom attributes record by amending the data with only the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      IOException - if the request fails to be processed
    • patchConversationCustomattributesBulk

      Update a list of custom attributes record by amending the data with only the provided fields.
      Parameters:
      request - The request object
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationCustomattributesBulk

      public ApiResponse<CustomAttributesBulkUpdateResponseMap> patchConversationCustomattributesBulk(ApiRequest<List<CustomAttributesPatchRequest>> request) throws IOException
      Update a list of custom attributes record by amending the data with only the provided fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationParticipant

      public void patchConversationParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Update a participant. Update conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Update request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Update a participant. Update conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Update request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationParticipant

      public void patchConversationParticipant(PatchConversationParticipantRequest request) throws IOException, ApiException
      Update a participant. Update conversation participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationParticipant

      public ApiResponse<Void> patchConversationParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update a participant. Update conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationParticipantAttributes

      public void patchConversationParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Participant attributes (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationParticipantAttributesWithHttpInfo

      public ApiResponse<Void> patchConversationParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Participant attributes (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationParticipantAttributes

      public void patchConversationParticipantAttributes(PatchConversationParticipantAttributesRequest request) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationParticipantAttributes

      public ApiResponse<Void> patchConversationParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationRecordingstate

      public void patchConversationRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversation ID (required)
      body - SetRecordingState (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationRecordingstateWithHttpInfo

      public ApiResponse<Void> patchConversationRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversation ID (required)
      body - SetRecordingState (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationRecordingstate

      public void patchConversationRecordingstate(PatchConversationRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationRecordingstate

      public ApiResponse<Void> patchConversationRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSecureattributes

      public String patchConversationSecureattributes(String conversationId, ConversationSecureAttributes body) throws IOException, ApiException
      Update the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Secure Attributes (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSecureattributesWithHttpInfo

      public ApiResponse<String> patchConversationSecureattributesWithHttpInfo(String conversationId, ConversationSecureAttributes body) throws IOException
      Update the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Secure Attributes (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSecureattributes

      public String patchConversationSecureattributes(PatchConversationSecureattributesRequest request) throws IOException, ApiException
      Update the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSecureattributes

      public ApiResponse<String> patchConversationSecureattributes(ApiRequest<ConversationSecureAttributes> request) throws IOException
      Update the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSummaryEngagements

      public void patchConversationSummaryEngagements(String conversationId, String summaryId, EngagementRequest body) throws IOException, ApiException
      Update agent's engagement for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSummaryEngagementsWithHttpInfo

      public ApiResponse<Void> patchConversationSummaryEngagementsWithHttpInfo(String conversationId, String summaryId, EngagementRequest body) throws IOException
      Update agent's engagement for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSummaryEngagements

      public void patchConversationSummaryEngagements(PatchConversationSummaryEngagementsRequest request) throws IOException, ApiException
      Update agent's engagement for the summary.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSummaryEngagements

      public ApiResponse<Void> patchConversationSummaryEngagements(ApiRequest<EngagementRequest> request) throws IOException
      Update agent's engagement for the summary.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSummaryFeedback

      public void patchConversationSummaryFeedback(String conversationId, String summaryId, FeedbackUpdateRequest body) throws IOException, ApiException
      Update the feedback for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSummaryFeedbackWithHttpInfo

      public ApiResponse<Void> patchConversationSummaryFeedbackWithHttpInfo(String conversationId, String summaryId, FeedbackUpdateRequest body) throws IOException
      Update the feedback for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationSummaryFeedback

      public void patchConversationSummaryFeedback(PatchConversationSummaryFeedbackRequest request) throws IOException, ApiException
      Update the feedback for the summary.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationSummaryFeedback

      public ApiResponse<Void> patchConversationSummaryFeedback(ApiRequest<FeedbackUpdateRequest> request) throws IOException
      Update the feedback for the summary.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationUtilizationlabel

      public String patchConversationUtilizationlabel(String conversationId, ConversationUtilizationLabelUpdate body) throws IOException, ApiException
      Update the utilization label on a conversation. When there is no value provided, the system default label is applied
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Utilization Label (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationUtilizationlabelWithHttpInfo

      public ApiResponse<String> patchConversationUtilizationlabelWithHttpInfo(String conversationId, ConversationUtilizationLabelUpdate body) throws IOException
      Update the utilization label on a conversation. When there is no value provided, the system default label is applied
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Utilization Label (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • patchConversationUtilizationlabel

      public String patchConversationUtilizationlabel(PatchConversationUtilizationlabelRequest request) throws IOException, ApiException
      Update the utilization label on a conversation. When there is no value provided, the system default label is applied
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationUtilizationlabel

      public ApiResponse<String> patchConversationUtilizationlabel(ApiRequest<ConversationUtilizationLabelUpdate> request) throws IOException
      Update the utilization label on a conversation. When there is no value provided, the system default label is applied
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsAftercallworkConversationIdParticipantCommunication

      public AfterCallWorkUpdate patchConversationsAftercallworkConversationIdParticipantCommunication(String conversationId, String participantId, String communicationId, AfterCallWorkUpdate body) throws IOException, ApiException
      Update after-call work for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - AfterCallWorkUpdate (required)
      Returns:
      AfterCallWorkUpdate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsAftercallworkConversationIdParticipantCommunicationWithHttpInfo

      public ApiResponse<AfterCallWorkUpdate> patchConversationsAftercallworkConversationIdParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, AfterCallWorkUpdate body) throws IOException
      Update after-call work for this conversation communication.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - AfterCallWorkUpdate (required)
      Returns:
      AfterCallWorkUpdate
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsAftercallworkConversationIdParticipantCommunication

      public AfterCallWorkUpdate patchConversationsAftercallworkConversationIdParticipantCommunication(PatchConversationsAftercallworkConversationIdParticipantCommunicationRequest request) throws IOException, ApiException
      Update after-call work for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      AfterCallWorkUpdate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsAftercallworkConversationIdParticipantCommunication

      public ApiResponse<AfterCallWorkUpdate> patchConversationsAftercallworkConversationIdParticipantCommunication(ApiRequest<AfterCallWorkUpdate> request) throws IOException
      Update after-call work for this conversation communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCall

      public Conversation patchConversationsCall(String conversationId, Conversation body) throws IOException, ApiException
      Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallWithHttpInfo

      public ApiResponse<Conversation> patchConversationsCallWithHttpInfo(String conversationId, Conversation body) throws IOException
      Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCall

      public Conversation patchConversationsCall(PatchConversationsCallRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCall

      public ApiResponse<Conversation> patchConversationsCall(ApiRequest<Conversation> request) throws IOException
      Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallConference

      public void patchConversationsCallConference(String conversationId, UpdateConferenceRequest body) throws IOException, ApiException
      Update a conversation by merging in other conversations to create a conference
      Parameters:
      conversationId - conversationId (required)
      body - UpdateConferenceRequest (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallConferenceWithHttpInfo

      public ApiResponse<Void> patchConversationsCallConferenceWithHttpInfo(String conversationId, UpdateConferenceRequest body) throws IOException
      Update a conversation by merging in other conversations to create a conference
      Parameters:
      conversationId - conversationId (required)
      body - UpdateConferenceRequest (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallConference

      public void patchConversationsCallConference(PatchConversationsCallConferenceRequest request) throws IOException, ApiException
      Update a conversation by merging in other conversations to create a conference
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallConference

      public ApiResponse<Void> patchConversationsCallConference(ApiRequest<UpdateConferenceRequest> request) throws IOException
      Update a conversation by merging in other conversations to create a conference
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipant

      public void patchConversationsCallParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsCallParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipant

      public void patchConversationsCallParticipant(PatchConversationsCallParticipantRequest request) throws IOException, ApiException
      Update conversation participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipant

      public ApiResponse<Void> patchConversationsCallParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantAttributes

      public ParticipantAttributes patchConversationsCallParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsCallParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantAttributes

      public ParticipantAttributes patchConversationsCallParticipantAttributes(PatchConversationsCallParticipantAttributesRequest request) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsCallParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunication

      public Empty patchConversationsCallParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsCallParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunication

      public Empty patchConversationsCallParticipantCommunication(PatchConversationsCallParticipantCommunicationRequest request) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunication

      public ApiResponse<Empty> patchConversationsCallParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunicationPostflowaction

      public void patchConversationsCallParticipantCommunicationPostflowaction(String conversationId, String participantId, String communicationId, MandatoryPostCallActionInput body) throws IOException, ApiException
      Set mandatory post call actions. If both values are null or blank error will occur.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Action (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunicationPostflowactionWithHttpInfo

      public ApiResponse<Void> patchConversationsCallParticipantCommunicationPostflowactionWithHttpInfo(String conversationId, String participantId, String communicationId, MandatoryPostCallActionInput body) throws IOException
      Set mandatory post call actions. If both values are null or blank error will occur.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Action (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunicationPostflowaction

      public void patchConversationsCallParticipantCommunicationPostflowaction(PatchConversationsCallParticipantCommunicationPostflowactionRequest request) throws IOException, ApiException
      Set mandatory post call actions. If both values are null or blank error will occur.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantCommunicationPostflowaction

      public ApiResponse<Void> patchConversationsCallParticipantCommunicationPostflowaction(ApiRequest<MandatoryPostCallActionInput> request) throws IOException
      Set mandatory post call actions. If both values are null or blank error will occur.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantConsult

      public ConsultTransferResponse patchConversationsCallParticipantConsult(String conversationId, String participantId, ConsultTransferUpdate body) throws IOException, ApiException
      Change who can speak
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - new speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantConsultWithHttpInfo

      public ApiResponse<ConsultTransferResponse> patchConversationsCallParticipantConsultWithHttpInfo(String conversationId, String participantId, ConsultTransferUpdate body) throws IOException
      Change who can speak
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - new speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantConsult

      public ConsultTransferResponse patchConversationsCallParticipantConsult(PatchConversationsCallParticipantConsultRequest request) throws IOException, ApiException
      Change who can speak
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantConsult

      public ApiResponse<ConsultTransferResponse> patchConversationsCallParticipantConsult(ApiRequest<ConsultTransferUpdate> request) throws IOException
      Change who can speak
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantUserUserId

      public void patchConversationsCallParticipantUserUserId(String conversationId, String participantId, String userId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant on behalf of a user
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      userId - userId (required)
      body - Participant request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantUserUserIdWithHttpInfo

      public ApiResponse<Void> patchConversationsCallParticipantUserUserIdWithHttpInfo(String conversationId, String participantId, String userId, MediaParticipantRequest body) throws IOException
      Update conversation participant on behalf of a user
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      userId - userId (required)
      body - Participant request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantUserUserId

      public void patchConversationsCallParticipantUserUserId(PatchConversationsCallParticipantUserUserIdRequest request) throws IOException, ApiException
      Update conversation participant on behalf of a user
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallParticipantUserUserId

      public ApiResponse<Void> patchConversationsCallParticipantUserUserId(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant on behalf of a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallback

      public Conversation patchConversationsCallback(String conversationId, Conversation body) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackWithHttpInfo

      public ApiResponse<Conversation> patchConversationsCallbackWithHttpInfo(String conversationId, Conversation body) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallback

      public Conversation patchConversationsCallback(PatchConversationsCallbackRequest request) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallback

      public ApiResponse<Conversation> patchConversationsCallback(ApiRequest<Conversation> request) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipant

      public void patchConversationsCallbackParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsCallbackParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipant

      public void patchConversationsCallbackParticipant(PatchConversationsCallbackParticipantRequest request) throws IOException, ApiException
      Update conversation participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipant

      public ApiResponse<Void> patchConversationsCallbackParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantAttributes

      public ParticipantAttributes patchConversationsCallbackParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsCallbackParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantAttributes

      public ParticipantAttributes patchConversationsCallbackParticipantAttributes(PatchConversationsCallbackParticipantAttributesRequest request) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsCallbackParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantCommunication

      public Empty patchConversationsCallbackParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsCallbackParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Update conversation participant's communication by disconnecting it.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantCommunication

      public Empty patchConversationsCallbackParticipantCommunication(PatchConversationsCallbackParticipantCommunicationRequest request) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbackParticipantCommunication

      public ApiResponse<Empty> patchConversationsCallbackParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant's communication by disconnecting it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbacks

      public PatchCallbackResponse patchConversationsCallbacks(PatchCallbackRequest body) throws IOException, ApiException
      Update a scheduled callback
      Parameters:
      body - PatchCallbackRequest (required)
      Returns:
      PatchCallbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbacksWithHttpInfo

      public ApiResponse<PatchCallbackResponse> patchConversationsCallbacksWithHttpInfo(PatchCallbackRequest body) throws IOException
      Update a scheduled callback
      Parameters:
      body - PatchCallbackRequest (required)
      Returns:
      PatchCallbackResponse
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCallbacks

      public PatchCallbackResponse patchConversationsCallbacks(PatchConversationsCallbacksRequest request) throws IOException, ApiException
      Update a scheduled callback
      Parameters:
      request - The request object
      Returns:
      PatchCallbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCallbacks

      public ApiResponse<PatchCallbackResponse> patchConversationsCallbacks(ApiRequest<PatchCallbackRequest> request) throws IOException
      Update a scheduled callback
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsChat

      public Conversation patchConversationsChat(String conversationId, Conversation body) throws IOException, ApiException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatWithHttpInfo

      public ApiResponse<Conversation> patchConversationsChatWithHttpInfo(String conversationId, Conversation body) throws IOException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsChat

      public Conversation patchConversationsChat(PatchConversationsChatRequest request) throws IOException, ApiException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChat

      public ApiResponse<Conversation> patchConversationsChat(ApiRequest<Conversation> request) throws IOException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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
    • patchConversationsChatParticipant

      public void patchConversationsChatParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Deprecated.
      Update conversation participant 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)
      participantId - participantId (required)
      body - Update request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsChatParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Deprecated.
      Update conversation participant 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)
      participantId - participantId (required)
      body - Update request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsChatParticipant

      public void patchConversationsChatParticipant(PatchConversationsChatParticipantRequest request) throws IOException, ApiException
      Deprecated.
      Update conversation participant 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
    • patchConversationsChatParticipant

      public ApiResponse<Void> patchConversationsChatParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Deprecated.
      Update conversation participant 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
    • patchConversationsChatParticipantAttributes

      public ParticipantAttributes patchConversationsChatParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Deprecated.
      Update the attributes on a conversation participant. 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)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsChatParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Deprecated.
      Update the attributes on a conversation participant. 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)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantAttributes

      public ParticipantAttributes patchConversationsChatParticipantAttributes(PatchConversationsChatParticipantAttributesRequest request) throws IOException, ApiException
      Deprecated.
      Update the attributes on a conversation participant. 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:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsChatParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Deprecated.
      Update the attributes on a conversation participant. 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
    • patchConversationsChatParticipantCommunication

      public Empty patchConversationsChatParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsChatParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantCommunication

      public Empty patchConversationsChatParticipantCommunication(PatchConversationsChatParticipantCommunicationRequest request) throws IOException, ApiException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. 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:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsChatParticipantCommunication

      public ApiResponse<Empty> patchConversationsChatParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. 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
    • patchConversationsCobrowsesession

      public Conversation patchConversationsCobrowsesession(String conversationId, Conversation body) throws IOException, ApiException
      Deprecated.
      Update a conversation by disconnecting all of the participants This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionWithHttpInfo

      public ApiResponse<Conversation> patchConversationsCobrowsesessionWithHttpInfo(String conversationId, Conversation body) throws IOException
      Deprecated.
      Update a conversation by disconnecting all of the participants This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesession

      public Conversation patchConversationsCobrowsesession(PatchConversationsCobrowsesessionRequest request) throws IOException, ApiException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesession

      public ApiResponse<Conversation> patchConversationsCobrowsesession(ApiRequest<Conversation> request) throws IOException
      Deprecated.
      Update a conversation by disconnecting all of the participants 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
    • patchConversationsCobrowsesessionParticipant

      public void patchConversationsCobrowsesessionParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Deprecated.
      Update conversation participant This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsCobrowsesessionParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Deprecated.
      Update conversation participant This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipant

      public void patchConversationsCobrowsesessionParticipant(PatchConversationsCobrowsesessionParticipantRequest request) throws IOException, ApiException
      Deprecated.
      Update conversation participant This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipant

      public ApiResponse<Void> patchConversationsCobrowsesessionParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Deprecated.
      Update conversation participant 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
    • patchConversationsCobrowsesessionParticipantAttributes

      public ParticipantAttributes patchConversationsCobrowsesessionParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Deprecated.
      Update the attributes on a conversation participant. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsCobrowsesessionParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Deprecated.
      Update the attributes on a conversation participant. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantAttributes

      public ParticipantAttributes patchConversationsCobrowsesessionParticipantAttributes(PatchConversationsCobrowsesessionParticipantAttributesRequest request) throws IOException, ApiException
      Deprecated.
      Update the attributes on a conversation participant. 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:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsCobrowsesessionParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Deprecated.
      Update the attributes on a conversation participant. 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
    • patchConversationsCobrowsesessionParticipantCommunication

      public Empty patchConversationsCobrowsesessionParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsCobrowsesessionParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Deprecated.
      Update conversation participant's communication by disconnecting it. This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantCommunication

      public Empty patchConversationsCobrowsesessionParticipantCommunication(PatchConversationsCobrowsesessionParticipantCommunicationRequest request) throws IOException, ApiException
      Deprecated.
      Update conversation participant's communication by disconnecting it. 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:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsCobrowsesessionParticipantCommunication

      public ApiResponse<Empty> patchConversationsCobrowsesessionParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Deprecated.
      Update conversation participant's communication by disconnecting it. 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
    • patchConversationsEmail

      public Conversation patchConversationsEmail(String conversationId, Conversation body) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailWithHttpInfo

      public ApiResponse<Conversation> patchConversationsEmailWithHttpInfo(String conversationId, Conversation body) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmail

      public Conversation patchConversationsEmail(PatchConversationsEmailRequest request) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmail

      public ApiResponse<Conversation> patchConversationsEmail(ApiRequest<Conversation> request) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailMessagesDraft

      public EmailMessage patchConversationsEmailMessagesDraft(String conversationId, Boolean autoFill, Boolean discard, DraftManipulationRequest body) throws IOException, ApiException
      Reset conversation draft to its initial state and/or auto-fill draft content
      Parameters:
      conversationId - conversationId (required)
      autoFill - autoFill (optional)
      discard - discard (optional)
      body - Draft Manipulation Request (optional)
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailMessagesDraftWithHttpInfo

      public ApiResponse<EmailMessage> patchConversationsEmailMessagesDraftWithHttpInfo(String conversationId, Boolean autoFill, Boolean discard, DraftManipulationRequest body) throws IOException
      Reset conversation draft to its initial state and/or auto-fill draft content
      Parameters:
      conversationId - conversationId (required)
      autoFill - autoFill (optional)
      discard - discard (optional)
      body - Draft Manipulation Request (optional)
      Returns:
      EmailMessage
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailMessagesDraft

      public EmailMessage patchConversationsEmailMessagesDraft(PatchConversationsEmailMessagesDraftRequest request) throws IOException, ApiException
      Reset conversation draft to its initial state and/or auto-fill draft content
      Parameters:
      request - The request object
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailMessagesDraft

      public ApiResponse<EmailMessage> patchConversationsEmailMessagesDraft(ApiRequest<DraftManipulationRequest> request) throws IOException
      Reset conversation draft to its initial state and/or auto-fill draft content
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipant

      public void patchConversationsEmailParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Update request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsEmailParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Update request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipant

      public void patchConversationsEmailParticipant(PatchConversationsEmailParticipantRequest request) throws IOException, ApiException
      Update conversation participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipant

      public ApiResponse<Void> patchConversationsEmailParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantAttributes

      public ParticipantAttributes patchConversationsEmailParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsEmailParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Participant attributes (required)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantAttributes

      public ParticipantAttributes patchConversationsEmailParticipantAttributes(PatchConversationsEmailParticipantAttributesRequest request) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsEmailParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantCommunication

      public Empty patchConversationsEmailParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsEmailParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantCommunication

      public Empty patchConversationsEmailParticipantCommunication(PatchConversationsEmailParticipantCommunicationRequest request) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantCommunication

      public ApiResponse<Empty> patchConversationsEmailParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantParkingstate

      public void patchConversationsEmailParticipantParkingstate(String conversationId, String participantId, ParkingStateRequest body) throws IOException, ApiException
      Update conversation by setting its parking state
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Parking update request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantParkingstateWithHttpInfo

      public ApiResponse<Void> patchConversationsEmailParticipantParkingstateWithHttpInfo(String conversationId, String participantId, ParkingStateRequest body) throws IOException
      Update conversation by setting its parking state
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Parking update request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantParkingstate

      public void patchConversationsEmailParticipantParkingstate(PatchConversationsEmailParticipantParkingstateRequest request) throws IOException, ApiException
      Update conversation by setting its parking state
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsEmailParticipantParkingstate

      public ApiResponse<Void> patchConversationsEmailParticipantParkingstate(ApiRequest<ParkingStateRequest> request) throws IOException
      Update conversation by setting its parking state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessage

      public Conversation patchConversationsMessage(String conversationId, Conversation body) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageWithHttpInfo

      public ApiResponse<Conversation> patchConversationsMessageWithHttpInfo(String conversationId, Conversation body) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessage

      public Conversation patchConversationsMessage(PatchConversationsMessageRequest request) throws IOException, ApiException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessage

      public ApiResponse<Conversation> patchConversationsMessage(ApiRequest<Conversation> request) throws IOException
      Update a conversation by disconnecting all of the participants
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipant

      public void patchConversationsMessageParticipant(String conversationId, String participantId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantWithHttpInfo

      public ApiResponse<Void> patchConversationsMessageParticipantWithHttpInfo(String conversationId, String participantId, MediaParticipantRequest body) throws IOException
      Update conversation participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipant

      public void patchConversationsMessageParticipant(PatchConversationsMessageParticipantRequest request) throws IOException, ApiException
      Update conversation participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipant

      public ApiResponse<Void> patchConversationsMessageParticipant(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantAttributes

      public ParticipantAttributes patchConversationsMessageParticipantAttributes(String conversationId, String participantId, ParticipantAttributes body) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantAttributesWithHttpInfo

      public ApiResponse<ParticipantAttributes> patchConversationsMessageParticipantAttributesWithHttpInfo(String conversationId, String participantId, ParticipantAttributes body) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Returns:
      ParticipantAttributes
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantAttributes

      public ParticipantAttributes patchConversationsMessageParticipantAttributes(PatchConversationsMessageParticipantAttributesRequest request) throws IOException, ApiException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      ParticipantAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantAttributes

      public ApiResponse<ParticipantAttributes> patchConversationsMessageParticipantAttributes(ApiRequest<ParticipantAttributes> request) throws IOException
      Update the attributes on a conversation participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantCommunication

      public Empty patchConversationsMessageParticipantCommunication(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantCommunicationWithHttpInfo

      public ApiResponse<Empty> patchConversationsMessageParticipantCommunicationWithHttpInfo(String conversationId, String participantId, String communicationId, MediaParticipantRequest body) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Participant (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantCommunication

      public Empty patchConversationsMessageParticipantCommunication(PatchConversationsMessageParticipantCommunicationRequest request) throws IOException, ApiException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantCommunication

      public ApiResponse<Empty> patchConversationsMessageParticipantCommunication(ApiRequest<MediaParticipantRequest> request) throws IOException
      Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantParkingstate

      public void patchConversationsMessageParticipantParkingstate(String conversationId, String participantId, ParkingStateRequest body) throws IOException, ApiException
      Update conversation by setting its parking state
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Parking update request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantParkingstateWithHttpInfo

      public ApiResponse<Void> patchConversationsMessageParticipantParkingstateWithHttpInfo(String conversationId, String participantId, ParkingStateRequest body) throws IOException
      Update conversation by setting its parking state
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Parking update request (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantParkingstate

      public void patchConversationsMessageParticipantParkingstate(PatchConversationsMessageParticipantParkingstateRequest request) throws IOException, ApiException
      Update conversation by setting its parking state
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessageParticipantParkingstate

      public ApiResponse<Void> patchConversationsMessageParticipantParkingstate(ApiRequest<ParkingStateRequest> request) throws IOException
      Update conversation by setting its parking state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsAppleIntegrationId

      public AppleIntegration patchConversationsMessagingIntegrationsAppleIntegrationId(String integrationId, AppleIntegrationUpdateRequest body) throws IOException, ApiException
      Update an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - AppleIntegrationUpdateRequest (required)
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo

      public ApiResponse<AppleIntegration> patchConversationsMessagingIntegrationsAppleIntegrationIdWithHttpInfo(String integrationId, AppleIntegrationUpdateRequest body) throws IOException
      Update an Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - AppleIntegrationUpdateRequest (required)
      Returns:
      AppleIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsAppleIntegrationId

      public AppleIntegration patchConversationsMessagingIntegrationsAppleIntegrationId(PatchConversationsMessagingIntegrationsAppleIntegrationIdRequest request) throws IOException, ApiException
      Update an Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsAppleIntegrationId

      public ApiResponse<AppleIntegration> patchConversationsMessagingIntegrationsAppleIntegrationId(ApiRequest<AppleIntegrationUpdateRequest> request) throws IOException
      Update an Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsFacebookIntegrationId

      public FacebookIntegration patchConversationsMessagingIntegrationsFacebookIntegrationId(String integrationId, FacebookIntegrationUpdateRequest body) throws IOException, ApiException
      Update Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - FacebookIntegrationUpdateRequest (required)
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo

      public ApiResponse<FacebookIntegration> patchConversationsMessagingIntegrationsFacebookIntegrationIdWithHttpInfo(String integrationId, FacebookIntegrationUpdateRequest body) throws IOException
      Update Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - FacebookIntegrationUpdateRequest (required)
      Returns:
      FacebookIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsFacebookIntegrationId

      public FacebookIntegration patchConversationsMessagingIntegrationsFacebookIntegrationId(PatchConversationsMessagingIntegrationsFacebookIntegrationIdRequest request) throws IOException, ApiException
      Update Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsFacebookIntegrationId

      public ApiResponse<FacebookIntegration> patchConversationsMessagingIntegrationsFacebookIntegrationId(ApiRequest<FacebookIntegrationUpdateRequest> request) throws IOException
      Update Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsInstagramIntegrationId

      public InstagramIntegration patchConversationsMessagingIntegrationsInstagramIntegrationId(String integrationId, InstagramIntegrationUpdateRequest body) throws IOException, ApiException
      Update Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - InstagramIntegrationUpdateRequest (required)
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo

      public ApiResponse<InstagramIntegration> patchConversationsMessagingIntegrationsInstagramIntegrationIdWithHttpInfo(String integrationId, InstagramIntegrationUpdateRequest body) throws IOException
      Update Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - InstagramIntegrationUpdateRequest (required)
      Returns:
      InstagramIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsInstagramIntegrationId

      public InstagramIntegration patchConversationsMessagingIntegrationsInstagramIntegrationId(PatchConversationsMessagingIntegrationsInstagramIntegrationIdRequest request) throws IOException, ApiException
      Update Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsInstagramIntegrationId

      public ApiResponse<InstagramIntegration> patchConversationsMessagingIntegrationsInstagramIntegrationId(ApiRequest<InstagramIntegrationUpdateRequest> request) throws IOException
      Update Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public GoogleBusinessProfileOpenIntegration patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(String integrationId, GoogleBusinessProfileOpenIntegrationUpdateRequest body) throws IOException, ApiException
      Update an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      body - GoogleBusinessProfileOpenIntegrationUpdateRequest (required)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo

      public ApiResponse<GoogleBusinessProfileOpenIntegration> patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdWithHttpInfo(String integrationId, GoogleBusinessProfileOpenIntegrationUpdateRequest body) throws IOException
      Update an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      integrationId - Integration ID (required)
      body - GoogleBusinessProfileOpenIntegrationUpdateRequest (required)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public GoogleBusinessProfileOpenIntegration patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(PatchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationIdRequest request) throws IOException, ApiException
      Update an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId

      public ApiResponse<GoogleBusinessProfileOpenIntegration> patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(ApiRequest<GoogleBusinessProfileOpenIntegrationUpdateRequest> request) throws IOException
      Update an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenIntegrationId

      public OpenIntegration patchConversationsMessagingIntegrationsOpenIntegrationId(String integrationId, OpenIntegrationUpdateRequest body) throws IOException, ApiException
      Update an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      body - OpenIntegrationUpdateRequest (required)
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo

      public ApiResponse<OpenIntegration> patchConversationsMessagingIntegrationsOpenIntegrationIdWithHttpInfo(String integrationId, OpenIntegrationUpdateRequest body) throws IOException
      Update an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      integrationId - Integration ID (required)
      body - OpenIntegrationUpdateRequest (required)
      Returns:
      OpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenIntegrationId

      public OpenIntegration patchConversationsMessagingIntegrationsOpenIntegrationId(PatchConversationsMessagingIntegrationsOpenIntegrationIdRequest request) throws IOException, ApiException
      Update an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsOpenIntegrationId

      public ApiResponse<OpenIntegration> patchConversationsMessagingIntegrationsOpenIntegrationId(ApiRequest<OpenIntegrationUpdateRequest> request) throws IOException
      Update an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsTwitterIntegrationId

      public TwitterIntegration patchConversationsMessagingIntegrationsTwitterIntegrationId(String integrationId, TwitterIntegrationUpdateRequest body) throws IOException, ApiException
      Update a Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - TwitterIntegrationUpdateRequest (required)
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo

      public ApiResponse<TwitterIntegration> patchConversationsMessagingIntegrationsTwitterIntegrationIdWithHttpInfo(String integrationId, TwitterIntegrationUpdateRequest body) throws IOException
      Update a Twitter messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - TwitterIntegrationUpdateRequest (required)
      Returns:
      TwitterIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsTwitterIntegrationId

      public TwitterIntegration patchConversationsMessagingIntegrationsTwitterIntegrationId(PatchConversationsMessagingIntegrationsTwitterIntegrationIdRequest request) throws IOException, ApiException
      Update a Twitter messaging integration
      Parameters:
      request - The request object
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsTwitterIntegrationId

      public ApiResponse<TwitterIntegration> patchConversationsMessagingIntegrationsTwitterIntegrationId(ApiRequest<TwitterIntegrationUpdateRequest> request) throws IOException
      Update a Twitter messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId

      public WhatsAppIntegration patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(String integrationId, WhatsAppEmbeddedSignupIntegrationActivationRequest body) throws IOException, ApiException
      Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
      Parameters:
      integrationId - Integration ID (required)
      body - WhatsAppEmbeddedSignupIntegrationActivationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIntegration> patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationIdWithHttpInfo(String integrationId, WhatsAppEmbeddedSignupIntegrationActivationRequest body) throws IOException
      Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
      Parameters:
      integrationId - Integration ID (required)
      body - WhatsAppEmbeddedSignupIntegrationActivationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId

      public WhatsAppIntegration patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(PatchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationIdRequest request) throws IOException, ApiException
      Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId

      public ApiResponse<WhatsAppIntegration> patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(ApiRequest<WhatsAppEmbeddedSignupIntegrationActivationRequest> request) throws IOException
      Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration patchConversationsMessagingIntegrationsWhatsappIntegrationId(String integrationId, WhatsAppIntegrationUpdateRequest body) throws IOException, ApiException
      Update a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - WhatsAppIntegrationUpdateRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIntegration> patchConversationsMessagingIntegrationsWhatsappIntegrationIdWithHttpInfo(String integrationId, WhatsAppIntegrationUpdateRequest body) throws IOException
      Update a WhatsApp messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - WhatsAppIntegrationUpdateRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappIntegrationId

      public WhatsAppIntegration patchConversationsMessagingIntegrationsWhatsappIntegrationId(PatchConversationsMessagingIntegrationsWhatsappIntegrationIdRequest request) throws IOException, ApiException
      Update a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingIntegrationsWhatsappIntegrationId

      public ApiResponse<WhatsAppIntegration> patchConversationsMessagingIntegrationsWhatsappIntegrationId(ApiRequest<WhatsAppIntegrationUpdateRequest> request) throws IOException
      Update a WhatsApp messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingSetting

      public MessagingSetting patchConversationsMessagingSetting(String messageSettingId, MessagingSettingPatchRequest body) throws IOException, ApiException
      Update a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingSettingWithHttpInfo

      public ApiResponse<MessagingSetting> patchConversationsMessagingSettingWithHttpInfo(String messageSettingId, MessagingSettingPatchRequest body) throws IOException
      Update a messaging setting
      Parameters:
      messageSettingId - Message Setting ID (required)
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingSetting

      public MessagingSetting patchConversationsMessagingSetting(PatchConversationsMessagingSettingRequest request) throws IOException, ApiException
      Update a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingSetting

      public ApiResponse<MessagingSetting> patchConversationsMessagingSetting(ApiRequest<MessagingSettingPatchRequest> request) throws IOException
      Update a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingSupportedcontentSupportedContentId

      public SupportedContent patchConversationsMessagingSupportedcontentSupportedContentId(String supportedContentId, SupportedContent body) throws IOException, ApiException
      Update a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<SupportedContent> patchConversationsMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId, SupportedContent body) throws IOException
      Update a supported content profile
      Parameters:
      supportedContentId - Supported Content ID (required)
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsMessagingSupportedcontentSupportedContentId

      public SupportedContent patchConversationsMessagingSupportedcontentSupportedContentId(PatchConversationsMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Update a supported content profile
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsMessagingSupportedcontentSupportedContentId

      public ApiResponse<SupportedContent> patchConversationsMessagingSupportedcontentSupportedContentId(ApiRequest<SupportedContent> request) throws IOException
      Update a supported content profile
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsSettings

      public void patchConversationsSettings(Settings body) throws IOException, ApiException
      Update Settings
      Parameters:
      body - Settings (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsSettingsWithHttpInfo

      public ApiResponse<Void> patchConversationsSettingsWithHttpInfo(Settings body) throws IOException
      Update Settings
      Parameters:
      body - Settings (required)
      Throws:
      IOException - if the request fails to be processed
    • patchConversationsSettings

      public void patchConversationsSettings(PatchConversationsSettingsRequest request) throws IOException, ApiException
      Update Settings
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchConversationsSettings

      public ApiResponse<Void> patchConversationsSettings(ApiRequest<Settings> request) throws IOException
      Update Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationDetailsProperties

      public PropertyIndexRequest postAnalyticsConversationDetailsProperties(String conversationId, PropertyIndexRequest body) throws IOException, ApiException
      Index conversation properties
      Parameters:
      conversationId - conversationId (required)
      body - request (required)
      Returns:
      PropertyIndexRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationDetailsPropertiesWithHttpInfo

      public ApiResponse<PropertyIndexRequest> postAnalyticsConversationDetailsPropertiesWithHttpInfo(String conversationId, PropertyIndexRequest body) throws IOException
      Index conversation properties
      Parameters:
      conversationId - conversationId (required)
      body - request (required)
      Returns:
      PropertyIndexRequest
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationDetailsProperties

      public PropertyIndexRequest postAnalyticsConversationDetailsProperties(PostAnalyticsConversationDetailsPropertiesRequest request) throws IOException, ApiException
      Index conversation properties
      Parameters:
      request - The request object
      Returns:
      PropertyIndexRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationDetailsProperties

      public ApiResponse<PropertyIndexRequest> postAnalyticsConversationDetailsProperties(ApiRequest<PropertyIndexRequest> request) throws IOException
      Index conversation properties
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsActivityQuery

      public ConversationActivityResponse postAnalyticsConversationsActivityQuery(ConversationActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Query for conversation activity observations
      Parameters:
      body - query (required)
      pageSize - The desired page size (optional)
      pageNumber - The desired page number (optional)
      Returns:
      ConversationActivityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsActivityQueryWithHttpInfo

      public ApiResponse<ConversationActivityResponse> postAnalyticsConversationsActivityQueryWithHttpInfo(ConversationActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException
      Query for conversation activity observations
      Parameters:
      body - query (required)
      pageSize - The desired page size (optional)
      pageNumber - The desired page number (optional)
      Returns:
      ConversationActivityResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsActivityQuery

      public ConversationActivityResponse postAnalyticsConversationsActivityQuery(PostAnalyticsConversationsActivityQueryRequest request) throws IOException, ApiException
      Query for conversation activity observations
      Parameters:
      request - The request object
      Returns:
      ConversationActivityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsActivityQuery

      public ApiResponse<ConversationActivityResponse> postAnalyticsConversationsActivityQuery(ApiRequest<ConversationActivityQuery> request) throws IOException
      Query for conversation activity observations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesJobs

      public AsyncQueryResponse postAnalyticsConversationsAggregatesJobs(ConversationAsyncAggregationQuery body) throws IOException, ApiException
      Query for conversation aggregates asynchronously
      Parameters:
      body - query (required)
      Returns:
      AsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesJobsWithHttpInfo

      public ApiResponse<AsyncQueryResponse> postAnalyticsConversationsAggregatesJobsWithHttpInfo(ConversationAsyncAggregationQuery body) throws IOException
      Query for conversation aggregates asynchronously
      Parameters:
      body - query (required)
      Returns:
      AsyncQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesJobs

      public AsyncQueryResponse postAnalyticsConversationsAggregatesJobs(PostAnalyticsConversationsAggregatesJobsRequest request) throws IOException, ApiException
      Query for conversation aggregates asynchronously
      Parameters:
      request - The request object
      Returns:
      AsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesJobs

      public ApiResponse<AsyncQueryResponse> postAnalyticsConversationsAggregatesJobs(ApiRequest<ConversationAsyncAggregationQuery> request) throws IOException
      Query for conversation aggregates asynchronously
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesQuery

      public ConversationAggregateQueryResponse postAnalyticsConversationsAggregatesQuery(ConversationAggregationQuery body) throws IOException, ApiException
      Query for conversation aggregates
      Parameters:
      body - query (required)
      Returns:
      ConversationAggregateQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesQueryWithHttpInfo

      public ApiResponse<ConversationAggregateQueryResponse> postAnalyticsConversationsAggregatesQueryWithHttpInfo(ConversationAggregationQuery body) throws IOException
      Query for conversation aggregates
      Parameters:
      body - query (required)
      Returns:
      ConversationAggregateQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesQuery

      public ConversationAggregateQueryResponse postAnalyticsConversationsAggregatesQuery(PostAnalyticsConversationsAggregatesQueryRequest request) throws IOException, ApiException
      Query for conversation aggregates
      Parameters:
      request - The request object
      Returns:
      ConversationAggregateQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsAggregatesQuery

      public ApiResponse<ConversationAggregateQueryResponse> postAnalyticsConversationsAggregatesQuery(ApiRequest<ConversationAggregationQuery> request) throws IOException
      Query for conversation aggregates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsJobs

      public AsyncQueryResponse postAnalyticsConversationsDetailsJobs(AsyncConversationQuery body) throws IOException, ApiException
      Query for conversation details asynchronously
      Parameters:
      body - query (required)
      Returns:
      AsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsJobsWithHttpInfo

      public ApiResponse<AsyncQueryResponse> postAnalyticsConversationsDetailsJobsWithHttpInfo(AsyncConversationQuery body) throws IOException
      Query for conversation details asynchronously
      Parameters:
      body - query (required)
      Returns:
      AsyncQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsJobs

      public AsyncQueryResponse postAnalyticsConversationsDetailsJobs(PostAnalyticsConversationsDetailsJobsRequest request) throws IOException, ApiException
      Query for conversation details asynchronously
      Parameters:
      request - The request object
      Returns:
      AsyncQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsJobs

      public ApiResponse<AsyncQueryResponse> postAnalyticsConversationsDetailsJobs(ApiRequest<AsyncConversationQuery> request) throws IOException
      Query for conversation details asynchronously
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsQuery

      public AnalyticsConversationQueryResponse postAnalyticsConversationsDetailsQuery(ConversationQuery body) throws IOException, ApiException
      Query for conversation details
      Parameters:
      body - query (required)
      Returns:
      AnalyticsConversationQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsQueryWithHttpInfo

      public ApiResponse<AnalyticsConversationQueryResponse> postAnalyticsConversationsDetailsQueryWithHttpInfo(ConversationQuery body) throws IOException
      Query for conversation details
      Parameters:
      body - query (required)
      Returns:
      AnalyticsConversationQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsQuery

      public AnalyticsConversationQueryResponse postAnalyticsConversationsDetailsQuery(PostAnalyticsConversationsDetailsQueryRequest request) throws IOException, ApiException
      Query for conversation details
      Parameters:
      request - The request object
      Returns:
      AnalyticsConversationQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsConversationsDetailsQuery

      public ApiResponse<AnalyticsConversationQueryResponse> postAnalyticsConversationsDetailsQuery(ApiRequest<ConversationQuery> request) throws IOException
      Query for conversation details
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationAssign

      public String postConversationAssign(String conversationId, ConversationUser body) throws IOException, ApiException
      Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
      Parameters:
      conversationId - conversation ID (required)
      body - Targeted user (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationAssignWithHttpInfo

      public ApiResponse<String> postConversationAssignWithHttpInfo(String conversationId, ConversationUser body) throws IOException
      Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
      Parameters:
      conversationId - conversation ID (required)
      body - Targeted user (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • postConversationAssign

      public String postConversationAssign(PostConversationAssignRequest request) throws IOException, ApiException
      Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationAssign

      public ApiResponse<String> postConversationAssign(ApiRequest<ConversationUser> request) throws IOException
      Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationBarge

      public void postConversationBarge(String conversationId) throws IOException, ApiException
      Barge a conversation creating a barged in conference of connected participants.
      Parameters:
      conversationId - conversation ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationBargeWithHttpInfo

      public ApiResponse<Void> postConversationBargeWithHttpInfo(String conversationId) throws IOException
      Barge a conversation creating a barged in conference of connected participants.
      Parameters:
      conversationId - conversation ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationBarge

      public void postConversationBarge(PostConversationBargeRequest request) throws IOException, ApiException
      Barge a conversation creating a barged in conference of connected participants.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationBarge

      public ApiResponse<Void> postConversationBarge(ApiRequest<Void> request) throws IOException
      Barge a conversation creating a barged in conference of connected participants.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCobrowse

      public CobrowseWebMessagingSession postConversationCobrowse(String conversationId) throws IOException, ApiException
      Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.
      Parameters:
      conversationId - Conversation ID (required)
      Returns:
      CobrowseWebMessagingSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCobrowseWithHttpInfo

      public ApiResponse<CobrowseWebMessagingSession> postConversationCobrowseWithHttpInfo(String conversationId) throws IOException
      Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.
      Parameters:
      conversationId - Conversation ID (required)
      Returns:
      CobrowseWebMessagingSession
      Throws:
      IOException - if the request fails to be processed
    • postConversationCobrowse

      public CobrowseWebMessagingSession postConversationCobrowse(PostConversationCobrowseRequest request) throws IOException, ApiException
      Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.
      Parameters:
      request - The request object
      Returns:
      CobrowseWebMessagingSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCobrowse

      public ApiResponse<CobrowseWebMessagingSession> postConversationCobrowse(ApiRequest<Void> request) throws IOException
      Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklist

      public AgentChecklistResponse postConversationCommunicationAgentchecklist(String conversationId, String communicationId, String agentChecklistId, ChecklistActivationPayload body) throws IOException, ApiException
      Agent Checklist activation API
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent checklist activation payload (required)
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistWithHttpInfo

      public ApiResponse<AgentChecklistResponse> postConversationCommunicationAgentchecklistWithHttpInfo(String conversationId, String communicationId, String agentChecklistId, ChecklistActivationPayload body) throws IOException
      Agent Checklist activation API
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent checklist activation payload (required)
      Returns:
      AgentChecklistResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklist

      public AgentChecklistResponse postConversationCommunicationAgentchecklist(PostConversationCommunicationAgentchecklistRequest request) throws IOException, ApiException
      Agent Checklist activation API
      Parameters:
      request - The request object
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklist

      public ApiResponse<AgentChecklistResponse> postConversationCommunicationAgentchecklist(ApiRequest<ChecklistActivationPayload> request) throws IOException
      Agent Checklist activation API
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistAgentaction

      public AgentChecklistResponse postConversationCommunicationAgentchecklistAgentaction(String conversationId, String communicationId, String agentChecklistId, AgentActionPayload body) throws IOException, ApiException
      API invoked to capture an agent action.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent action payload (required)
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistAgentactionWithHttpInfo

      public ApiResponse<AgentChecklistResponse> postConversationCommunicationAgentchecklistAgentactionWithHttpInfo(String conversationId, String communicationId, String agentChecklistId, AgentActionPayload body) throws IOException
      API invoked to capture an agent action.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent action payload (required)
      Returns:
      AgentChecklistResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistAgentaction

      public AgentChecklistResponse postConversationCommunicationAgentchecklistAgentaction(PostConversationCommunicationAgentchecklistAgentactionRequest request) throws IOException, ApiException
      API invoked to capture an agent action.
      Parameters:
      request - The request object
      Returns:
      AgentChecklistResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistAgentaction

      public ApiResponse<AgentChecklistResponse> postConversationCommunicationAgentchecklistAgentaction(ApiRequest<AgentActionPayload> request) throws IOException
      API invoked to capture an agent action.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistJobs

      public ChecklistInferenceJobCreationResponse postConversationCommunicationAgentchecklistJobs(String conversationId, String communicationId, String agentChecklistId, ChecklistInferenceJobPayload body) throws IOException, ApiException
      Create inference job
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent checklist inference job payload (required)
      Returns:
      ChecklistInferenceJobCreationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistJobsWithHttpInfo

      public ApiResponse<ChecklistInferenceJobCreationResponse> postConversationCommunicationAgentchecklistJobsWithHttpInfo(String conversationId, String communicationId, String agentChecklistId, ChecklistInferenceJobPayload body) throws IOException
      Create inference job
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      agentChecklistId - Agent Checklist ID (required)
      body - Agent checklist inference job payload (required)
      Returns:
      ChecklistInferenceJobCreationResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistJobs

      public ChecklistInferenceJobCreationResponse postConversationCommunicationAgentchecklistJobs(PostConversationCommunicationAgentchecklistJobsRequest request) throws IOException, ApiException
      Create inference job
      Parameters:
      request - The request object
      Returns:
      ChecklistInferenceJobCreationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistJobs

      public ApiResponse<ChecklistInferenceJobCreationResponse> postConversationCommunicationAgentchecklistJobs(ApiRequest<ChecklistInferenceJobPayload> request) throws IOException
      Create inference job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistsFinalize

      public AgentChecklistResponseList postConversationCommunicationAgentchecklistsFinalize(String conversationId, String communicationId, ChecklistFinalizePayload body) throws IOException, ApiException
      API invoked to finalize agent checklist evaluation.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      body - Agent checklist finalize payload (required)
      Returns:
      AgentChecklistResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistsFinalizeWithHttpInfo

      public ApiResponse<AgentChecklistResponseList> postConversationCommunicationAgentchecklistsFinalizeWithHttpInfo(String conversationId, String communicationId, ChecklistFinalizePayload body) throws IOException
      API invoked to finalize agent checklist evaluation.
      Parameters:
      conversationId - Conversation ID (required)
      communicationId - Communication ID (required)
      body - Agent checklist finalize payload (required)
      Returns:
      AgentChecklistResponseList
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistsFinalize

      public AgentChecklistResponseList postConversationCommunicationAgentchecklistsFinalize(PostConversationCommunicationAgentchecklistsFinalizeRequest request) throws IOException, ApiException
      API invoked to finalize agent checklist evaluation.
      Parameters:
      request - The request object
      Returns:
      AgentChecklistResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationAgentchecklistsFinalize

      public ApiResponse<AgentChecklistResponseList> postConversationCommunicationAgentchecklistsFinalize(ApiRequest<ChecklistFinalizePayload> request) throws IOException
      API invoked to finalize agent checklist evaluation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationInternalmessages

      public InternalMessageData postConversationCommunicationInternalmessages(String conversationId, String communicationId, InternalMessageRequest body) throws IOException, ApiException
      Send internal message Send a new internal message for an existing communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      InternalMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationInternalmessagesWithHttpInfo

      public ApiResponse<InternalMessageData> postConversationCommunicationInternalmessagesWithHttpInfo(String conversationId, String communicationId, InternalMessageRequest body) throws IOException
      Send internal message Send a new internal message for an existing communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      InternalMessageData
      Throws:
      IOException - if the request fails to be processed
    • postConversationCommunicationInternalmessages

      public InternalMessageData postConversationCommunicationInternalmessages(PostConversationCommunicationInternalmessagesRequest request) throws IOException, ApiException
      Send internal message Send a new internal message for an existing communication.
      Parameters:
      request - The request object
      Returns:
      InternalMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationCommunicationInternalmessages

      public ApiResponse<InternalMessageData> postConversationCommunicationInternalmessages(ApiRequest<InternalMessageRequest> request) throws IOException
      Send internal message Send a new internal message for an existing communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationDisconnect

      public String postConversationDisconnect(String conversationId) throws IOException, ApiException
      Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationDisconnectWithHttpInfo

      public ApiResponse<String> postConversationDisconnectWithHttpInfo(String conversationId) throws IOException
      Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
      Parameters:
      conversationId - conversation ID (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • postConversationDisconnect

      public String postConversationDisconnect(PostConversationDisconnectRequest request) throws IOException, ApiException
      Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationDisconnect

      public ApiResponse<String> postConversationDisconnect(ApiRequest<Void> request) throws IOException
      Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantCallbacks

      public void postConversationParticipantCallbacks(String conversationId, String participantId, CreateCallbackOnConversationCommand body) throws IOException, ApiException
      Create a new callback for the specified participant on the conversation.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantCallbacksWithHttpInfo

      public ApiResponse<Void> postConversationParticipantCallbacksWithHttpInfo(String conversationId, String participantId, CreateCallbackOnConversationCommand body) throws IOException
      Create a new callback for the specified participant on the conversation.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantCallbacks

      public void postConversationParticipantCallbacks(PostConversationParticipantCallbacksRequest request) throws IOException, ApiException
      Create a new callback for the specified participant on the conversation.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantCallbacks

      public ApiResponse<Void> postConversationParticipantCallbacks(ApiRequest<CreateCallbackOnConversationCommand> request) throws IOException
      Create a new callback for the specified participant on the conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantDigits

      public void postConversationParticipantDigits(String conversationId, String participantId, Digits body) throws IOException, ApiException
      Sends DTMF to the participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Digits (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantDigitsWithHttpInfo

      public ApiResponse<Void> postConversationParticipantDigitsWithHttpInfo(String conversationId, String participantId, Digits body) throws IOException
      Sends DTMF to the participant
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Digits (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantDigits

      public void postConversationParticipantDigits(PostConversationParticipantDigitsRequest request) throws IOException, ApiException
      Sends DTMF to the participant
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantDigits

      public ApiResponse<Void> postConversationParticipantDigits(ApiRequest<Digits> request) throws IOException
      Sends DTMF to the participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantInternalmessagesUsersCommunications

      public MessagingConferResponse postConversationParticipantInternalmessagesUsersCommunications(String conversationId, String participantId, MessagingConferWithUserRequest body) throws IOException, ApiException
      Setup internal message communication with user The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Confer request (required)
      Returns:
      MessagingConferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantInternalmessagesUsersCommunicationsWithHttpInfo

      public ApiResponse<MessagingConferResponse> postConversationParticipantInternalmessagesUsersCommunicationsWithHttpInfo(String conversationId, String participantId, MessagingConferWithUserRequest body) throws IOException
      Setup internal message communication with user The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Confer request (required)
      Returns:
      MessagingConferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantInternalmessagesUsersCommunications

      public MessagingConferResponse postConversationParticipantInternalmessagesUsersCommunications(PostConversationParticipantInternalmessagesUsersCommunicationsRequest request) throws IOException, ApiException
      Setup internal message communication with user The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
      Parameters:
      request - The request object
      Returns:
      MessagingConferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantInternalmessagesUsersCommunications

      public ApiResponse<MessagingConferResponse> postConversationParticipantInternalmessagesUsersCommunications(ApiRequest<MessagingConferWithUserRequest> request) throws IOException
      Setup internal message communication with user The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplace

      public void postConversationParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Deprecated.
      Replace this participant (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Deprecated.
      Replace this participant (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplace

      public void postConversationParticipantReplace(PostConversationParticipantReplaceRequest request) throws IOException, ApiException
      Deprecated.
      Replace this participant (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplace

      public ApiResponse<Void> postConversationParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Deprecated.
      Replace this participant (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceAgent

      public void postConversationParticipantReplaceAgent(String conversationId, String participantId, TransferToAgentRequest body) throws IOException, ApiException
      Replace this participant with the specified agent
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceAgentWithHttpInfo

      public ApiResponse<Void> postConversationParticipantReplaceAgentWithHttpInfo(String conversationId, String participantId, TransferToAgentRequest body) throws IOException
      Replace this participant with the specified agent
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceAgent

      public void postConversationParticipantReplaceAgent(PostConversationParticipantReplaceAgentRequest request) throws IOException, ApiException
      Replace this participant with the specified agent
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceAgent

      public ApiResponse<Void> postConversationParticipantReplaceAgent(ApiRequest<TransferToAgentRequest> request) throws IOException
      Replace this participant with the specified agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceContactExternal

      public void postConversationParticipantReplaceContactExternal(String conversationId, String participantId, TransferToExternalContactRequest body) throws IOException, ApiException
      Replace this participant with the an external contact
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceContactExternalWithHttpInfo

      public ApiResponse<Void> postConversationParticipantReplaceContactExternalWithHttpInfo(String conversationId, String participantId, TransferToExternalContactRequest body) throws IOException
      Replace this participant with the an external contact
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceContactExternal

      public void postConversationParticipantReplaceContactExternal(PostConversationParticipantReplaceContactExternalRequest request) throws IOException, ApiException
      Replace this participant with the an external contact
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceContactExternal

      public ApiResponse<Void> postConversationParticipantReplaceContactExternal(ApiRequest<TransferToExternalContactRequest> request) throws IOException
      Replace this participant with the an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceExternal

      public void postConversationParticipantReplaceExternal(String conversationId, String participantId, TransferToExternalRequest body) throws IOException, ApiException
      Deprecated.
      Replace this participant with the an external contact (Deprecated) This endpoint is deprecated. Use /replace/contact/external endpoint instead.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceExternalWithHttpInfo

      public ApiResponse<Void> postConversationParticipantReplaceExternalWithHttpInfo(String conversationId, String participantId, TransferToExternalRequest body) throws IOException
      Deprecated.
      Replace this participant with the an external contact (Deprecated) This endpoint is deprecated. Use /replace/contact/external endpoint instead.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceExternal

      public void postConversationParticipantReplaceExternal(PostConversationParticipantReplaceExternalRequest request) throws IOException, ApiException
      Deprecated.
      Replace this participant with the an external contact (Deprecated) This endpoint is deprecated. Use /replace/contact/external endpoint instead.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceExternal

      public ApiResponse<Void> postConversationParticipantReplaceExternal(ApiRequest<TransferToExternalRequest> request) throws IOException
      Deprecated.
      Replace this participant with the an external contact (Deprecated) This endpoint is deprecated. Use /replace/contact/external endpoint instead.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceQueue

      public void postConversationParticipantReplaceQueue(String conversationId, String participantId, TransferToQueueRequest body) throws IOException, ApiException
      Replace this participant with the specified queue
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceQueueWithHttpInfo

      public ApiResponse<Void> postConversationParticipantReplaceQueueWithHttpInfo(String conversationId, String participantId, TransferToQueueRequest body) throws IOException
      Replace this participant with the specified queue
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceQueue

      public void postConversationParticipantReplaceQueue(PostConversationParticipantReplaceQueueRequest request) throws IOException, ApiException
      Replace this participant with the specified queue
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantReplaceQueue

      public ApiResponse<Void> postConversationParticipantReplaceQueue(ApiRequest<TransferToQueueRequest> request) throws IOException
      Replace this participant with the specified queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantSecureivrsessions

      public SecureSession postConversationParticipantSecureivrsessions(String conversationId, String participantId, CreateSecureSession body) throws IOException, ApiException
      Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - (optional)
      Returns:
      SecureSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantSecureivrsessionsWithHttpInfo

      public ApiResponse<SecureSession> postConversationParticipantSecureivrsessionsWithHttpInfo(String conversationId, String participantId, CreateSecureSession body) throws IOException
      Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - (optional)
      Returns:
      SecureSession
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantSecureivrsessions

      public SecureSession postConversationParticipantSecureivrsessions(PostConversationParticipantSecureivrsessionsRequest request) throws IOException, ApiException
      Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
      Parameters:
      request - The request object
      Returns:
      SecureSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantSecureivrsessions

      public ApiResponse<SecureSession> postConversationParticipantSecureivrsessions(ApiRequest<CreateSecureSession> request) throws IOException
      Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantTransfer

      public void postConversationParticipantTransfer(String conversationId, String participantId, TransferToAddressRequest body) throws IOException, ApiException
      Replace this participant by another one using the address of the destination.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantTransferWithHttpInfo

      public ApiResponse<Void> postConversationParticipantTransferWithHttpInfo(String conversationId, String participantId, TransferToAddressRequest body) throws IOException
      Replace this participant by another one using the address of the destination.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationParticipantTransfer

      public void postConversationParticipantTransfer(PostConversationParticipantTransferRequest request) throws IOException, ApiException
      Replace this participant by another one using the address of the destination.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationParticipantTransfer

      public ApiResponse<Void> postConversationParticipantTransfer(ApiRequest<TransferToAddressRequest> request) throws IOException
      Replace this participant by another one using the address of the destination.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationSuggestionEngagement

      public SuggestionEngagement postConversationSuggestionEngagement(String conversationId, String suggestionId, SuggestionEngagement body) throws IOException, ApiException
      Save an engagement on the suggestion.
      Parameters:
      conversationId - Conversation ID (required)
      suggestionId - Suggestion ID (required)
      body - (required)
      Returns:
      SuggestionEngagement
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSuggestionEngagementWithHttpInfo

      public ApiResponse<SuggestionEngagement> postConversationSuggestionEngagementWithHttpInfo(String conversationId, String suggestionId, SuggestionEngagement body) throws IOException
      Save an engagement on the suggestion.
      Parameters:
      conversationId - Conversation ID (required)
      suggestionId - Suggestion ID (required)
      body - (required)
      Returns:
      SuggestionEngagement
      Throws:
      IOException - if the request fails to be processed
    • postConversationSuggestionEngagement

      public SuggestionEngagement postConversationSuggestionEngagement(PostConversationSuggestionEngagementRequest request) throws IOException, ApiException
      Save an engagement on the suggestion.
      Parameters:
      request - The request object
      Returns:
      SuggestionEngagement
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSuggestionEngagement

      public ApiResponse<SuggestionEngagement> postConversationSuggestionEngagement(ApiRequest<SuggestionEngagement> request) throws IOException
      Save an engagement on the suggestion.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationSuggestionsFeedback

      public void postConversationSuggestionsFeedback(String conversationId, Feedback body) throws IOException, ApiException
      Deprecated.
      Suggestion feedback. Google Agent Assist offering within Genesys will no longer be supported
      Parameters:
      conversationId - Conversation ID (required)
      body - SuggestionFeedback (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSuggestionsFeedbackWithHttpInfo

      public ApiResponse<Void> postConversationSuggestionsFeedbackWithHttpInfo(String conversationId, Feedback body) throws IOException
      Deprecated.
      Suggestion feedback. Google Agent Assist offering within Genesys will no longer be supported
      Parameters:
      conversationId - Conversation ID (required)
      body - SuggestionFeedback (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationSuggestionsFeedback

      public void postConversationSuggestionsFeedback(PostConversationSuggestionsFeedbackRequest request) throws IOException, ApiException
      Deprecated.
      Suggestion feedback. Google Agent Assist offering within Genesys will no longer be supported
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSuggestionsFeedback

      public ApiResponse<Void> postConversationSuggestionsFeedback(ApiRequest<Feedback> request) throws IOException
      Deprecated.
      Suggestion feedback. Google Agent Assist offering within Genesys will no longer be supported
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationSummaryFeedback

      public void postConversationSummaryFeedback(String conversationId, String summaryId, FeedbackAddRequest body) throws IOException, ApiException
      Submit feedback for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSummaryFeedbackWithHttpInfo

      public ApiResponse<Void> postConversationSummaryFeedbackWithHttpInfo(String conversationId, String summaryId, FeedbackAddRequest body) throws IOException
      Submit feedback for the summary.
      Parameters:
      conversationId - Conversation ID (required)
      summaryId - Summary ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationSummaryFeedback

      public void postConversationSummaryFeedback(PostConversationSummaryFeedbackRequest request) throws IOException, ApiException
      Submit feedback for the summary.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationSummaryFeedback

      public ApiResponse<Void> postConversationSummaryFeedback(ApiRequest<FeedbackAddRequest> request) throws IOException
      Submit feedback for the summary.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCall

      public Conversation postConversationsCall(String conversationId, CallCommand body) throws IOException, ApiException
      Place a new call as part of a callback conversation.
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallWithHttpInfo

      public ApiResponse<Conversation> postConversationsCallWithHttpInfo(String conversationId, CallCommand body) throws IOException
      Place a new call as part of a callback conversation.
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCall

      public Conversation postConversationsCall(PostConversationsCallRequest request) throws IOException, ApiException
      Place a new call as part of a callback conversation.
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCall

      public ApiResponse<Conversation> postConversationsCall(ApiRequest<CallCommand> request) throws IOException
      Place a new call as part of a callback conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantBarge

      public void postConversationsCallParticipantBarge(String conversationId, String participantId) throws IOException, ApiException
      Barge a given participant's call creating a barged in conference of connected participants.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantBargeWithHttpInfo

      public ApiResponse<Void> postConversationsCallParticipantBargeWithHttpInfo(String conversationId, String participantId) throws IOException
      Barge a given participant's call creating a barged in conference of connected participants.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantBarge

      public void postConversationsCallParticipantBarge(PostConversationsCallParticipantBargeRequest request) throws IOException, ApiException
      Barge a given participant's call creating a barged in conference of connected participants.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantBarge

      public ApiResponse<Void> postConversationsCallParticipantBarge(ApiRequest<Void> request) throws IOException
      Barge a given participant's call creating a barged in conference of connected participants.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCoach

      public void postConversationsCallParticipantCoach(String conversationId, String participantId) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCoachWithHttpInfo

      public ApiResponse<Void> postConversationsCallParticipantCoachWithHttpInfo(String conversationId, String participantId) throws IOException
      Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCoach

      public void postConversationsCallParticipantCoach(PostConversationsCallParticipantCoachRequest request) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCoach

      public ApiResponse<Void> postConversationsCallParticipantCoach(ApiRequest<Void> request) throws IOException
      Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCommunicationWrapup

      public void postConversationsCallParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsCallParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCommunicationWrapup

      public void postConversationsCallParticipantCommunicationWrapup(PostConversationsCallParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsCallParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsult

      public ConsultTransferResponse postConversationsCallParticipantConsult(String conversationId, String participantId, ConsultTransfer body) throws IOException, ApiException
      Deprecated.
      Initiate and update consult transfer (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultWithHttpInfo(String conversationId, String participantId, ConsultTransfer body) throws IOException
      Deprecated.
      Initiate and update consult transfer (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsult

      public ConsultTransferResponse postConversationsCallParticipantConsult(PostConversationsCallParticipantConsultRequest request) throws IOException, ApiException
      Deprecated.
      Initiate and update consult transfer (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsult

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsult(ApiRequest<ConsultTransfer> request) throws IOException
      Deprecated.
      Initiate and update consult transfer (Deprecated) This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultAgent

      public ConsultTransferResponse postConversationsCallParticipantConsultAgent(String conversationId, String participantId, ConsultTransferToAgent body) throws IOException, ApiException
      Initiate a consult transfer to an agent
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination agent & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultAgentWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultAgentWithHttpInfo(String conversationId, String participantId, ConsultTransferToAgent body) throws IOException
      Initiate a consult transfer to an agent
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination agent & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultAgent

      public ConsultTransferResponse postConversationsCallParticipantConsultAgent(PostConversationsCallParticipantConsultAgentRequest request) throws IOException, ApiException
      Initiate a consult transfer to an agent
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultAgent

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultAgent(ApiRequest<ConsultTransferToAgent> request) throws IOException
      Initiate a consult transfer to an agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultContactExternal

      public ConsultTransferResponse postConversationsCallParticipantConsultContactExternal(String conversationId, String participantId, ConsultTransferToExternalContact body) throws IOException, ApiException
      Initiate a consult transfer to an external contact
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultContactExternalWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultContactExternalWithHttpInfo(String conversationId, String participantId, ConsultTransferToExternalContact body) throws IOException
      Initiate a consult transfer to an external contact
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultContactExternal

      public ConsultTransferResponse postConversationsCallParticipantConsultContactExternal(PostConversationsCallParticipantConsultContactExternalRequest request) throws IOException, ApiException
      Initiate a consult transfer to an external contact
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultContactExternal

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultContactExternal(ApiRequest<ConsultTransferToExternalContact> request) throws IOException
      Initiate a consult transfer to an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultExternal

      public ConsultTransferResponse postConversationsCallParticipantConsultExternal(String conversationId, String participantId, ConsultTransferToExternal body) throws IOException, ApiException
      Deprecated.
      Initiate a consult transfer to an external contact (Deprecated) This endpoint is deprecated. Use /consult/contact/external endpoints instead.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultExternalWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultExternalWithHttpInfo(String conversationId, String participantId, ConsultTransferToExternal body) throws IOException
      Deprecated.
      Initiate a consult transfer to an external contact (Deprecated) This endpoint is deprecated. Use /consult/contact/external endpoints instead.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultExternal

      public ConsultTransferResponse postConversationsCallParticipantConsultExternal(PostConversationsCallParticipantConsultExternalRequest request) throws IOException, ApiException
      Deprecated.
      Initiate a consult transfer to an external contact (Deprecated) This endpoint is deprecated. Use /consult/contact/external endpoints instead.
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultExternal

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultExternal(ApiRequest<ConsultTransferToExternal> request) throws IOException
      Deprecated.
      Initiate a consult transfer to an external contact (Deprecated) This endpoint is deprecated. Use /consult/contact/external endpoints instead.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultQueue

      public ConsultTransferResponse postConversationsCallParticipantConsultQueue(String conversationId, String participantId, ConsultTransferToQueue body) throws IOException, ApiException
      Initiate a consult transfer to a queue
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination queue & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultQueueWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultQueueWithHttpInfo(String conversationId, String participantId, ConsultTransferToQueue body) throws IOException
      Initiate a consult transfer to a queue
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination queue & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultQueue

      public ConsultTransferResponse postConversationsCallParticipantConsultQueue(PostConversationsCallParticipantConsultQueueRequest request) throws IOException, ApiException
      Initiate a consult transfer to a queue
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantConsultQueue

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantConsultQueue(ApiRequest<ConsultTransferToQueue> request) throws IOException
      Initiate a consult transfer to a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantMonitor

      public void postConversationsCallParticipantMonitor(String conversationId, String participantId) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantMonitorWithHttpInfo

      public ApiResponse<Void> postConversationsCallParticipantMonitorWithHttpInfo(String conversationId, String participantId) throws IOException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantMonitor

      public void postConversationsCallParticipantMonitor(PostConversationsCallParticipantMonitorRequest request) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantMonitor

      public ApiResponse<Void> postConversationsCallParticipantMonitor(ApiRequest<Void> request) throws IOException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantReplace

      public void postConversationsCallParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsCallParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantReplace

      public void postConversationsCallParticipantReplace(PostConversationsCallParticipantReplaceRequest request) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantReplace

      public ApiResponse<Void> postConversationsCallParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantSnippetRecord

      public String postConversationsCallParticipantSnippetRecord(String conversationId, String participantId, SnippetRecordingRequest body) throws IOException, ApiException
      Start/stop the snippet recording for a participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - snippetRecordingRequest (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantSnippetRecordWithHttpInfo

      public ApiResponse<String> postConversationsCallParticipantSnippetRecordWithHttpInfo(String conversationId, String participantId, SnippetRecordingRequest body) throws IOException
      Start/stop the snippet recording for a participant
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - snippetRecordingRequest (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantSnippetRecord

      public String postConversationsCallParticipantSnippetRecord(PostConversationsCallParticipantSnippetRecordRequest request) throws IOException, ApiException
      Start/stop the snippet recording for a participant
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantSnippetRecord

      public ApiResponse<String> postConversationsCallParticipantSnippetRecord(ApiRequest<SnippetRecordingRequest> request) throws IOException
      Start/stop the snippet recording for a participant
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantVoiceConsult

      public ConsultTransferResponse postConversationsCallParticipantVoiceConsult(String conversationId, String participantId, ConsultTransferToAddress body) throws IOException, ApiException
      Initiate voice consult transfer
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantVoiceConsultWithHttpInfo

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantVoiceConsultWithHttpInfo(String conversationId, String participantId, ConsultTransferToAddress body) throws IOException
      Initiate voice consult transfer
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Destination address & initial speak to (required)
      Returns:
      ConsultTransferResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantVoiceConsult

      public ConsultTransferResponse postConversationsCallParticipantVoiceConsult(PostConversationsCallParticipantVoiceConsultRequest request) throws IOException, ApiException
      Initiate voice consult transfer
      Parameters:
      request - The request object
      Returns:
      ConsultTransferResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantVoiceConsult

      public ApiResponse<ConsultTransferResponse> postConversationsCallParticipantVoiceConsult(ApiRequest<ConsultTransferToAddress> request) throws IOException
      Initiate voice consult transfer
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipants

      public Conversation postConversationsCallParticipants(String conversationId, Conversation body) throws IOException, ApiException
      Add participants to a conversation
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantsWithHttpInfo

      public ApiResponse<Conversation> postConversationsCallParticipantsWithHttpInfo(String conversationId, Conversation body) throws IOException
      Add participants to a conversation
      Parameters:
      conversationId - conversationId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipants

      public Conversation postConversationsCallParticipants(PostConversationsCallParticipantsRequest request) throws IOException, ApiException
      Add participants to a conversation
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipants

      public ApiResponse<Conversation> postConversationsCallParticipants(ApiRequest<Conversation> request) throws IOException
      Add participants to a conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantsUserUserId

      public Conversation postConversationsCallParticipantsUserUserId(String conversationId, String userId, Conversation body) throws IOException, ApiException
      Add participants to a conversation on behalf of a user
      Parameters:
      conversationId - conversationId (required)
      userId - userId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantsUserUserIdWithHttpInfo

      public ApiResponse<Conversation> postConversationsCallParticipantsUserUserIdWithHttpInfo(String conversationId, String userId, Conversation body) throws IOException
      Add participants to a conversation on behalf of a user
      Parameters:
      conversationId - conversationId (required)
      userId - userId (required)
      body - Conversation (required)
      Returns:
      Conversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallParticipantsUserUserId

      public Conversation postConversationsCallParticipantsUserUserId(PostConversationsCallParticipantsUserUserIdRequest request) throws IOException, ApiException
      Add participants to a conversation on behalf of a user
      Parameters:
      request - The request object
      Returns:
      Conversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallParticipantsUserUserId

      public ApiResponse<Conversation> postConversationsCallParticipantsUserUserId(ApiRequest<Conversation> request) throws IOException
      Add participants to a conversation on behalf of a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantCommunicationWrapup

      public void postConversationsCallbackParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsCallbackParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantCommunicationWrapup

      public void postConversationsCallbackParticipantCommunicationWrapup(PostConversationsCallbackParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsCallbackParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantReplace

      public void postConversationsCallbackParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsCallbackParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantReplace

      public void postConversationsCallbackParticipantReplace(PostConversationsCallbackParticipantReplaceRequest request) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbackParticipantReplace

      public ApiResponse<Void> postConversationsCallbackParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacks

      public CreateCallbackResponse postConversationsCallbacks(CreateCallbackCommand body) throws IOException, ApiException
      Create a Callback
      Parameters:
      body - Callback (required)
      Returns:
      CreateCallbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacksWithHttpInfo

      public ApiResponse<CreateCallbackResponse> postConversationsCallbacksWithHttpInfo(CreateCallbackCommand body) throws IOException
      Create a Callback
      Parameters:
      body - Callback (required)
      Returns:
      CreateCallbackResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacks

      public CreateCallbackResponse postConversationsCallbacks(PostConversationsCallbacksRequest request) throws IOException, ApiException
      Create a Callback
      Parameters:
      request - The request object
      Returns:
      CreateCallbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacks

      public ApiResponse<CreateCallbackResponse> postConversationsCallbacks(ApiRequest<CreateCallbackCommand> request) throws IOException
      Create a Callback
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkDisconnect

      public void postConversationsCallbacksBulkDisconnect(BulkCallbackDisconnectRequest body) throws IOException, ApiException
      Disconnect multiple scheduled callbacks
      Parameters:
      body - BulkCallbackDisconnectRequest (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkDisconnectWithHttpInfo

      public ApiResponse<Void> postConversationsCallbacksBulkDisconnectWithHttpInfo(BulkCallbackDisconnectRequest body) throws IOException
      Disconnect multiple scheduled callbacks
      Parameters:
      body - BulkCallbackDisconnectRequest (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkDisconnect

      public void postConversationsCallbacksBulkDisconnect(PostConversationsCallbacksBulkDisconnectRequest request) throws IOException, ApiException
      Disconnect multiple scheduled callbacks
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkDisconnect

      public ApiResponse<Void> postConversationsCallbacksBulkDisconnect(ApiRequest<BulkCallbackDisconnectRequest> request) throws IOException
      Disconnect multiple scheduled callbacks
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkUpdate

      public BulkCallbackPatchResponse postConversationsCallbacksBulkUpdate(BulkCallbackPatchRequest body) throws IOException, ApiException
      Update multiple scheduled callbacks
      Parameters:
      body - BulkCallbackPatchRequest (required)
      Returns:
      BulkCallbackPatchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkUpdateWithHttpInfo

      public ApiResponse<BulkCallbackPatchResponse> postConversationsCallbacksBulkUpdateWithHttpInfo(BulkCallbackPatchRequest body) throws IOException
      Update multiple scheduled callbacks
      Parameters:
      body - BulkCallbackPatchRequest (required)
      Returns:
      BulkCallbackPatchResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkUpdate

      public BulkCallbackPatchResponse postConversationsCallbacksBulkUpdate(PostConversationsCallbacksBulkUpdateRequest request) throws IOException, ApiException
      Update multiple scheduled callbacks
      Parameters:
      request - The request object
      Returns:
      BulkCallbackPatchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallbacksBulkUpdate

      public ApiResponse<BulkCallbackPatchResponse> postConversationsCallbacksBulkUpdate(ApiRequest<BulkCallbackPatchRequest> request) throws IOException
      Update multiple scheduled callbacks
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCalls

      public CreateCallResponse postConversationsCalls(CreateCallRequest body) throws IOException, ApiException
      Create a call conversation
      Parameters:
      body - Call request (required)
      Returns:
      CreateCallResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallsWithHttpInfo

      public ApiResponse<CreateCallResponse> postConversationsCallsWithHttpInfo(CreateCallRequest body) throws IOException
      Create a call conversation
      Parameters:
      body - Call request (required)
      Returns:
      CreateCallResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCalls

      public CreateCallResponse postConversationsCalls(PostConversationsCallsRequest request) throws IOException, ApiException
      Create a call conversation
      Parameters:
      request - The request object
      Returns:
      CreateCallResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCalls

      public ApiResponse<CreateCallResponse> postConversationsCalls(ApiRequest<CreateCallRequest> request) throws IOException
      Create a call conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallsUserUserId

      public CreateCallResponse postConversationsCallsUserUserId(String userId, CreateCallRequest body) throws IOException, ApiException
      Create a call conversation on behalf of a user
      Parameters:
      userId - userId (required)
      body - Call request (required)
      Returns:
      CreateCallResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallsUserUserIdWithHttpInfo

      public ApiResponse<CreateCallResponse> postConversationsCallsUserUserIdWithHttpInfo(String userId, CreateCallRequest body) throws IOException
      Create a call conversation on behalf of a user
      Parameters:
      userId - userId (required)
      body - Call request (required)
      Returns:
      CreateCallResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCallsUserUserId

      public CreateCallResponse postConversationsCallsUserUserId(PostConversationsCallsUserUserIdRequest request) throws IOException, ApiException
      Create a call conversation on behalf of a user
      Parameters:
      request - The request object
      Returns:
      CreateCallResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCallsUserUserId

      public ApiResponse<CreateCallResponse> postConversationsCallsUserUserId(ApiRequest<CreateCallRequest> request) throws IOException
      Create a call conversation on behalf of a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChatCommunicationMessages

      public WebChatMessage postConversationsChatCommunicationMessages(String conversationId, String communicationId, CreateWebChatMessageRequest body) throws IOException, ApiException
      Deprecated.
      Send a message on behalf of a communication 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)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      WebChatMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChatCommunicationMessagesWithHttpInfo

      public ApiResponse<WebChatMessage> postConversationsChatCommunicationMessagesWithHttpInfo(String conversationId, String communicationId, CreateWebChatMessageRequest body) throws IOException
      Deprecated.
      Send a message on behalf of a communication 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)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      WebChatMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChatCommunicationMessages

      public WebChatMessage postConversationsChatCommunicationMessages(PostConversationsChatCommunicationMessagesRequest request) throws IOException, ApiException
      Deprecated.
      Send a message on behalf of a communication 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
    • postConversationsChatCommunicationMessages

      public ApiResponse<WebChatMessage> postConversationsChatCommunicationMessages(ApiRequest<CreateWebChatMessageRequest> request) throws IOException
      Deprecated.
      Send a message on behalf of a communication 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
    • postConversationsChatCommunicationTyping

      public WebChatTyping postConversationsChatCommunicationTyping(String conversationId, String communicationId) throws IOException, ApiException
      Deprecated.
      Send a typing-indicator on behalf of a communication 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)
      communicationId - communicationId (required)
      Returns:
      WebChatTyping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChatCommunicationTypingWithHttpInfo

      public ApiResponse<WebChatTyping> postConversationsChatCommunicationTypingWithHttpInfo(String conversationId, String communicationId) throws IOException
      Deprecated.
      Send a typing-indicator on behalf of a communication 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)
      communicationId - communicationId (required)
      Returns:
      WebChatTyping
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChatCommunicationTyping

      public WebChatTyping postConversationsChatCommunicationTyping(PostConversationsChatCommunicationTypingRequest request) throws IOException, ApiException
      Deprecated.
      Send a typing-indicator on behalf of a communication 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
    • postConversationsChatCommunicationTyping

      public ApiResponse<WebChatTyping> postConversationsChatCommunicationTyping(ApiRequest<Void> request) throws IOException
      Deprecated.
      Send a typing-indicator on behalf of a communication 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
    • postConversationsChatParticipantCommunicationWrapup

      public void postConversationsChatParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChatParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsChatParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication 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)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChatParticipantCommunicationWrapup

      public void postConversationsChatParticipantCommunicationWrapup(PostConversationsChatParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication 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
    • postConversationsChatParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsChatParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication 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
    • postConversationsChatParticipantReplace

      public void postConversationsChatParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Deprecated.
      Replace this participant with the specified user and/or address 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)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChatParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsChatParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Deprecated.
      Replace this participant with the specified user and/or address 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)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChatParticipantReplace

      public void postConversationsChatParticipantReplace(PostConversationsChatParticipantReplaceRequest request) throws IOException, ApiException
      Deprecated.
      Replace this participant with the specified user and/or address 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
    • postConversationsChatParticipantReplace

      public ApiResponse<Void> postConversationsChatParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Deprecated.
      Replace this participant with the specified user and/or address 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
    • postConversationsChats

      public ChatConversation postConversationsChats(CreateWebChatRequest body) throws IOException, ApiException
      Deprecated.
      Create a web chat conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
      Parameters:
      body - Create web chat request (required)
      Returns:
      ChatConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChatsWithHttpInfo

      public ApiResponse<ChatConversation> postConversationsChatsWithHttpInfo(CreateWebChatRequest body) throws IOException
      Deprecated.
      Create a web chat conversation This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
      Parameters:
      body - Create web chat request (required)
      Returns:
      ChatConversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsChats

      public ChatConversation postConversationsChats(PostConversationsChatsRequest request) throws IOException, ApiException
      Deprecated.
      Create a web 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:
      ChatConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsChats

      public ApiResponse<ChatConversation> postConversationsChats(ApiRequest<CreateWebChatRequest> request) throws IOException
      Deprecated.
      Create a web 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
    • postConversationsCobrowsesessionParticipantCommunicationWrapup

      public void postConversationsCobrowsesessionParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsCobrowsesessionParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantCommunicationWrapup

      public void postConversationsCobrowsesessionParticipantCommunicationWrapup(PostConversationsCobrowsesessionParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsCobrowsesessionParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication 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
    • postConversationsCobrowsesessionParticipantReplace

      public void postConversationsCobrowsesessionParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Deprecated.
      Replace this participant with the specified user and/or address This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsCobrowsesessionParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Deprecated.
      Replace this participant with the specified user and/or address This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantReplace

      public void postConversationsCobrowsesessionParticipantReplace(PostConversationsCobrowsesessionParticipantReplaceRequest request) throws IOException, ApiException
      Deprecated.
      Replace this participant with the specified user and/or address This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCobrowsesessionParticipantReplace

      public ApiResponse<Void> postConversationsCobrowsesessionParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Deprecated.
      Replace this participant with the specified user and/or address 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
    • postConversationsCustomattributesSchemas

      public ConversationDataSchema postConversationsCustomattributesSchemas(ConversationJsonSchemaRequest body) throws IOException, ApiException
      Create a schema
      Parameters:
      body - Schema create request body (required)
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSchemasWithHttpInfo

      public ApiResponse<ConversationDataSchema> postConversationsCustomattributesSchemasWithHttpInfo(ConversationJsonSchemaRequest body) throws IOException
      Create a schema
      Parameters:
      body - Schema create request body (required)
      Returns:
      ConversationDataSchema
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSchemas

      public ConversationDataSchema postConversationsCustomattributesSchemas(PostConversationsCustomattributesSchemasRequest request) throws IOException, ApiException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSchemas

      public ApiResponse<ConversationDataSchema> postConversationsCustomattributesSchemas(ApiRequest<ConversationJsonSchemaRequest> request) throws IOException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSearch

      public JsonSearchResponse postConversationsCustomattributesSearch(ConversationCustomAttributesSearchRequest body) throws IOException, ApiException
      Search resources.
      Parameters:
      body - Search request options (required)
      Returns:
      JsonSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSearchWithHttpInfo

      public ApiResponse<JsonSearchResponse> postConversationsCustomattributesSearchWithHttpInfo(ConversationCustomAttributesSearchRequest body) throws IOException
      Search resources.
      Parameters:
      body - Search request options (required)
      Returns:
      JsonSearchResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSearch

      public JsonSearchResponse postConversationsCustomattributesSearch(PostConversationsCustomattributesSearchRequest request) throws IOException, ApiException
      Search resources.
      Parameters:
      request - The request object
      Returns:
      JsonSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsCustomattributesSearch

      public ApiResponse<JsonSearchResponse> postConversationsCustomattributesSearch(ApiRequest<ConversationCustomAttributesSearchRequest> request) throws IOException
      Search resources.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailInboundmessages

      public EmailConversation postConversationsEmailInboundmessages(String conversationId, InboundMessageRequest body) throws IOException, ApiException
      Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
      Parameters:
      conversationId - conversationId (required)
      body - Send external email reply (required)
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailInboundmessagesWithHttpInfo

      public ApiResponse<EmailConversation> postConversationsEmailInboundmessagesWithHttpInfo(String conversationId, InboundMessageRequest body) throws IOException
      Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
      Parameters:
      conversationId - conversationId (required)
      body - Send external email reply (required)
      Returns:
      EmailConversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailInboundmessages

      public EmailConversation postConversationsEmailInboundmessages(PostConversationsEmailInboundmessagesRequest request) throws IOException, ApiException
      Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
      Parameters:
      request - The request object
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailInboundmessages

      public ApiResponse<EmailConversation> postConversationsEmailInboundmessages(ApiRequest<InboundMessageRequest> request) throws IOException
      Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailMessages

      public EmailMessageReply postConversationsEmailMessages(String conversationId, EmailMessage body) throws IOException, ApiException
      Send an email reply
      Parameters:
      conversationId - conversationId (required)
      body - Reply (required)
      Returns:
      EmailMessageReply
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailMessagesWithHttpInfo

      public ApiResponse<EmailMessageReply> postConversationsEmailMessagesWithHttpInfo(String conversationId, EmailMessage body) throws IOException
      Send an email reply
      Parameters:
      conversationId - conversationId (required)
      body - Reply (required)
      Returns:
      EmailMessageReply
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailMessages

      public EmailMessageReply postConversationsEmailMessages(PostConversationsEmailMessagesRequest request) throws IOException, ApiException
      Send an email reply
      Parameters:
      request - The request object
      Returns:
      EmailMessageReply
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailMessages

      public ApiResponse<EmailMessageReply> postConversationsEmailMessages(ApiRequest<EmailMessage> request) throws IOException
      Send an email reply
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailMessagesDraftAttachmentsCopy

      public EmailMessage postConversationsEmailMessagesDraftAttachmentsCopy(String conversationId, CopyAttachmentsRequest body) throws IOException, ApiException
      Copy attachments from an email message to the current draft.
      Parameters:
      conversationId - conversationId (required)
      body - Copy Attachment Request (required)
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailMessagesDraftAttachmentsCopyWithHttpInfo

      public ApiResponse<EmailMessage> postConversationsEmailMessagesDraftAttachmentsCopyWithHttpInfo(String conversationId, CopyAttachmentsRequest body) throws IOException
      Copy attachments from an email message to the current draft.
      Parameters:
      conversationId - conversationId (required)
      body - Copy Attachment Request (required)
      Returns:
      EmailMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailMessagesDraftAttachmentsCopy

      public EmailMessage postConversationsEmailMessagesDraftAttachmentsCopy(PostConversationsEmailMessagesDraftAttachmentsCopyRequest request) throws IOException, ApiException
      Copy attachments from an email message to the current draft.
      Parameters:
      request - The request object
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailMessagesDraftAttachmentsCopy

      public ApiResponse<EmailMessage> postConversationsEmailMessagesDraftAttachmentsCopy(ApiRequest<CopyAttachmentsRequest> request) throws IOException
      Copy attachments from an email message to the current draft.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantCommunicationWrapup

      public void postConversationsEmailParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsEmailParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantCommunicationWrapup

      public void postConversationsEmailParticipantCommunicationWrapup(PostConversationsEmailParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsEmailParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantReplace

      public void postConversationsEmailParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsEmailParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantReplace

      public void postConversationsEmailParticipantReplace(PostConversationsEmailParticipantReplaceRequest request) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailParticipantReplace

      public ApiResponse<Void> postConversationsEmailParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailReconnect

      public void postConversationsEmailReconnect(String conversationId) throws IOException, ApiException
      Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation This request is not valid when using the Client Credentials OAuth grant.
      Parameters:
      conversationId - conversationId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailReconnectWithHttpInfo

      public ApiResponse<Void> postConversationsEmailReconnectWithHttpInfo(String conversationId) throws IOException
      Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation This request is not valid when using the Client Credentials OAuth grant.
      Parameters:
      conversationId - conversationId (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailReconnect

      public void postConversationsEmailReconnect(PostConversationsEmailReconnectRequest request) throws IOException, ApiException
      Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation This request is not valid when using the Client Credentials OAuth grant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailReconnect

      public ApiResponse<Void> postConversationsEmailReconnect(ApiRequest<Void> request) throws IOException
      Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation This request is not valid when using the Client Credentials OAuth grant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmails

      public EmailConversation postConversationsEmails(CreateEmailRequest body) throws IOException, ApiException
      Create an email conversation If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
      Parameters:
      body - Create email request (required)
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailsWithHttpInfo

      public ApiResponse<EmailConversation> postConversationsEmailsWithHttpInfo(CreateEmailRequest body) throws IOException
      Create an email conversation If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
      Parameters:
      body - Create email request (required)
      Returns:
      EmailConversation
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmails

      public EmailConversation postConversationsEmails(PostConversationsEmailsRequest request) throws IOException, ApiException
      Create an email conversation If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
      Parameters:
      request - The request object
      Returns:
      EmailConversation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmails

      public ApiResponse<EmailConversation> postConversationsEmails(ApiRequest<CreateEmailRequest> request) throws IOException
      Create an email conversation If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailsAgentless

      public AgentlessEmailSendResponseDto postConversationsEmailsAgentless(AgentlessEmailSendRequestDto body) throws IOException, ApiException
      Create an email conversation, per API
      Parameters:
      body - Create agentless email request (required)
      Returns:
      AgentlessEmailSendResponseDto
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailsAgentlessWithHttpInfo

      public ApiResponse<AgentlessEmailSendResponseDto> postConversationsEmailsAgentlessWithHttpInfo(AgentlessEmailSendRequestDto body) throws IOException
      Create an email conversation, per API
      Parameters:
      body - Create agentless email request (required)
      Returns:
      AgentlessEmailSendResponseDto
      Throws:
      IOException - if the request fails to be processed
    • postConversationsEmailsAgentless

      public AgentlessEmailSendResponseDto postConversationsEmailsAgentless(PostConversationsEmailsAgentlessRequest request) throws IOException, ApiException
      Create an email conversation, per API
      Parameters:
      request - The request object
      Returns:
      AgentlessEmailSendResponseDto
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsEmailsAgentless

      public ApiResponse<AgentlessEmailSendResponseDto> postConversationsEmailsAgentless(ApiRequest<AgentlessEmailSendRequestDto> request) throws IOException
      Create an email conversation, per API
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsFaxes

      public FaxSendResponse postConversationsFaxes(FaxSendRequest body) throws IOException, ApiException
      Create Fax Conversation
      Parameters:
      body - Fax (required)
      Returns:
      FaxSendResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsFaxesWithHttpInfo

      public ApiResponse<FaxSendResponse> postConversationsFaxesWithHttpInfo(FaxSendRequest body) throws IOException
      Create Fax Conversation
      Parameters:
      body - Fax (required)
      Returns:
      FaxSendResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsFaxes

      public FaxSendResponse postConversationsFaxes(PostConversationsFaxesRequest request) throws IOException, ApiException
      Create Fax Conversation
      Parameters:
      request - The request object
      Returns:
      FaxSendResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsFaxes

      public ApiResponse<FaxSendResponse> postConversationsFaxes(ApiRequest<FaxSendRequest> request) throws IOException
      Create Fax Conversation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurations

      public ConversationEncryptionConfiguration postConversationsKeyconfigurations(ConversationEncryptionConfiguration body) throws IOException, ApiException
      Setup configurations for encryption key creation
      Parameters:
      body - Encryption Configuration (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurationsWithHttpInfo

      public ApiResponse<ConversationEncryptionConfiguration> postConversationsKeyconfigurationsWithHttpInfo(ConversationEncryptionConfiguration body) throws IOException
      Setup configurations for encryption key creation
      Parameters:
      body - Encryption Configuration (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurations

      Setup configurations for encryption key creation
      Parameters:
      request - The request object
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurations

      Setup configurations for encryption key creation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurationsValidate

      public ConversationEncryptionConfiguration postConversationsKeyconfigurationsValidate(ConversationEncryptionConfiguration body) throws IOException, ApiException
      Validate encryption key configurations without saving it
      Parameters:
      body - Encryption Configuration (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurationsValidateWithHttpInfo

      public ApiResponse<ConversationEncryptionConfiguration> postConversationsKeyconfigurationsValidateWithHttpInfo(ConversationEncryptionConfiguration body) throws IOException
      Validate encryption key configurations without saving it
      Parameters:
      body - Encryption Configuration (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurationsValidate

      public ConversationEncryptionConfiguration postConversationsKeyconfigurationsValidate(PostConversationsKeyconfigurationsValidateRequest request) throws IOException, ApiException
      Validate encryption key configurations without saving it
      Parameters:
      request - The request object
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsKeyconfigurationsValidate

      public ApiResponse<ConversationEncryptionConfiguration> postConversationsKeyconfigurationsValidate(ApiRequest<ConversationEncryptionConfiguration> request) throws IOException
      Validate encryption key configurations without saving it
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessages

      public MessageData postConversationsMessageCommunicationMessages(String conversationId, String communicationId, AdditionalMessage body, Boolean useNormalizedMessage) throws IOException, ApiException
      Send message Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesWithHttpInfo

      public ApiResponse<MessageData> postConversationsMessageCommunicationMessagesWithHttpInfo(String conversationId, String communicationId, AdditionalMessage body, Boolean useNormalizedMessage) throws IOException
      Send message Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      Returns:
      MessageData
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessages

      public MessageData postConversationsMessageCommunicationMessages(PostConversationsMessageCommunicationMessagesRequest request) throws IOException, ApiException
      Send message Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
      Parameters:
      request - The request object
      Returns:
      MessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessages

      public ApiResponse<MessageData> postConversationsMessageCommunicationMessages(ApiRequest<AdditionalMessage> request) throws IOException
      Send message Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMedia

      public MessageMediaData postConversationsMessageCommunicationMessagesMedia(String conversationId, String communicationId) throws IOException, ApiException
      Deprecated.
      Create media See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      Returns:
      MessageMediaData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMediaWithHttpInfo

      public ApiResponse<MessageMediaData> postConversationsMessageCommunicationMessagesMediaWithHttpInfo(String conversationId, String communicationId) throws IOException
      Deprecated.
      Create media See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      Returns:
      MessageMediaData
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMedia

      public MessageMediaData postConversationsMessageCommunicationMessagesMedia(PostConversationsMessageCommunicationMessagesMediaRequest request) throws IOException, ApiException
      Deprecated.
      Create media See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
      Parameters:
      request - The request object
      Returns:
      MessageMediaData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMedia

      public ApiResponse<MessageMediaData> postConversationsMessageCommunicationMessagesMedia(ApiRequest<Void> request) throws IOException
      Deprecated.
      Create media See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMediaUploads

      public MessageMediaUploadData postConversationsMessageCommunicationMessagesMediaUploads(String conversationId, String communicationId, UploadMediaRequest body) throws IOException, ApiException
      Create a URL to upload a message media file See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - request (required)
      Returns:
      MessageMediaUploadData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMediaUploadsWithHttpInfo

      public ApiResponse<MessageMediaUploadData> postConversationsMessageCommunicationMessagesMediaUploadsWithHttpInfo(String conversationId, String communicationId, UploadMediaRequest body) throws IOException
      Create a URL to upload a message media file See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - request (required)
      Returns:
      MessageMediaUploadData
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMediaUploads

      public MessageMediaUploadData postConversationsMessageCommunicationMessagesMediaUploads(PostConversationsMessageCommunicationMessagesMediaUploadsRequest request) throws IOException, ApiException
      Create a URL to upload a message media file See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      request - The request object
      Returns:
      MessageMediaUploadData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationMessagesMediaUploads

      public ApiResponse<MessageMediaUploadData> postConversationsMessageCommunicationMessagesMediaUploads(ApiRequest<UploadMediaRequest> request) throws IOException
      Create a URL to upload a message media file See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationSocialmediaMessages

      public SocialMediaMessageData postConversationsMessageCommunicationSocialmediaMessages(String conversationId, String communicationId, AdditionalSocialMediaMessage body) throws IOException, ApiException
      Send a social media message Send a social media message on existing conversation/communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      SocialMediaMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationSocialmediaMessagesWithHttpInfo

      public ApiResponse<SocialMediaMessageData> postConversationsMessageCommunicationSocialmediaMessagesWithHttpInfo(String conversationId, String communicationId, AdditionalSocialMediaMessage body) throws IOException
      Send a social media message Send a social media message on existing conversation/communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - Message (required)
      Returns:
      SocialMediaMessageData
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationSocialmediaMessages

      public SocialMediaMessageData postConversationsMessageCommunicationSocialmediaMessages(PostConversationsMessageCommunicationSocialmediaMessagesRequest request) throws IOException, ApiException
      Send a social media message Send a social media message on existing conversation/communication.
      Parameters:
      request - The request object
      Returns:
      SocialMediaMessageData
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationSocialmediaMessages

      public ApiResponse<SocialMediaMessageData> postConversationsMessageCommunicationSocialmediaMessages(ApiRequest<AdditionalSocialMediaMessage> request) throws IOException
      Send a social media message Send a social media message on existing conversation/communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationTyping

      public void postConversationsMessageCommunicationTyping(String conversationId, String communicationId, MessageTypingEventRequest body) throws IOException, ApiException
      Send message typing event Send message typing event for existing conversation/communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - MessageTypingEvent (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationTypingWithHttpInfo

      public ApiResponse<Void> postConversationsMessageCommunicationTypingWithHttpInfo(String conversationId, String communicationId, MessageTypingEventRequest body) throws IOException
      Send message typing event Send message typing event for existing conversation/communication.
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      body - MessageTypingEvent (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationTyping

      public void postConversationsMessageCommunicationTyping(PostConversationsMessageCommunicationTypingRequest request) throws IOException, ApiException
      Send message typing event Send message typing event for existing conversation/communication.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageCommunicationTyping

      public ApiResponse<Void> postConversationsMessageCommunicationTyping(ApiRequest<MessageTypingEventRequest> request) throws IOException
      Send message typing event Send message typing event for existing conversation/communication.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenEvent

      public OpenEventNormalizedMessage postConversationsMessageInboundOpenEvent(String integrationId, OpenInboundNormalizedEvent body) throws IOException, ApiException
      Send an inbound Open Event Message Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      Returns:
      OpenEventNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenEventWithHttpInfo

      public ApiResponse<OpenEventNormalizedMessage> postConversationsMessageInboundOpenEventWithHttpInfo(String integrationId, OpenInboundNormalizedEvent body) throws IOException
      Send an inbound Open Event Message Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      Returns:
      OpenEventNormalizedMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenEvent

      public OpenEventNormalizedMessage postConversationsMessageInboundOpenEvent(PostConversationsMessageInboundOpenEventRequest request) throws IOException, ApiException
      Send an inbound Open Event Message Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      OpenEventNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenEvent

      public ApiResponse<OpenEventNormalizedMessage> postConversationsMessageInboundOpenEvent(ApiRequest<OpenInboundNormalizedEvent> request) throws IOException
      Send an inbound Open Event Message Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenMessage

      public OpenMessageNormalizedMessage postConversationsMessageInboundOpenMessage(String integrationId, OpenInboundNormalizedMessage body, Boolean prefetchConversationId) throws IOException, ApiException
      Send inbound Open Message Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      prefetchConversationId - Indicates whether or not to prefetch conversationId (optional, default to false)
      Returns:
      OpenMessageNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenMessageWithHttpInfo

      public ApiResponse<OpenMessageNormalizedMessage> postConversationsMessageInboundOpenMessageWithHttpInfo(String integrationId, OpenInboundNormalizedMessage body, Boolean prefetchConversationId) throws IOException
      Send inbound Open Message Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      prefetchConversationId - Indicates whether or not to prefetch conversationId (optional, default to false)
      Returns:
      OpenMessageNormalizedMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenMessage

      public OpenMessageNormalizedMessage postConversationsMessageInboundOpenMessage(PostConversationsMessageInboundOpenMessageRequest request) throws IOException, ApiException
      Send inbound Open Message Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      OpenMessageNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenMessage

      public ApiResponse<OpenMessageNormalizedMessage> postConversationsMessageInboundOpenMessage(ApiRequest<OpenInboundNormalizedMessage> request) throws IOException
      Send inbound Open Message Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenReceipt

      public OpenReceiptNormalizedMessage postConversationsMessageInboundOpenReceipt(String integrationId, OpenInboundNormalizedReceipt body) throws IOException, ApiException
      Send an inbound Open Receipt Message Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      Returns:
      OpenReceiptNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenReceiptWithHttpInfo

      public ApiResponse<OpenReceiptNormalizedMessage> postConversationsMessageInboundOpenReceiptWithHttpInfo(String integrationId, OpenInboundNormalizedReceipt body) throws IOException
      Send an inbound Open Receipt Message Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - NormalizedMessage (required)
      Returns:
      OpenReceiptNormalizedMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenReceipt

      public OpenReceiptNormalizedMessage postConversationsMessageInboundOpenReceipt(PostConversationsMessageInboundOpenReceiptRequest request) throws IOException, ApiException
      Send an inbound Open Receipt Message Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      OpenReceiptNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenReceipt

      public ApiResponse<OpenReceiptNormalizedMessage> postConversationsMessageInboundOpenReceipt(ApiRequest<OpenInboundNormalizedReceipt> request) throws IOException
      Send an inbound Open Receipt Message Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenStructuredResponse

      public OpenStructuredResponseNormalizedMessage postConversationsMessageInboundOpenStructuredResponse(String integrationId, OpenInboundStructuredResponseMessage body) throws IOException, ApiException
      Send inbound Open Response Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - OpenInboundStructuredResponseMessage (required)
      Returns:
      OpenStructuredResponseNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenStructuredResponseWithHttpInfo

      public ApiResponse<OpenStructuredResponseNormalizedMessage> postConversationsMessageInboundOpenStructuredResponseWithHttpInfo(String integrationId, OpenInboundStructuredResponseMessage body) throws IOException
      Send inbound Open Response Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      integrationId - integrationId (required)
      body - OpenInboundStructuredResponseMessage (required)
      Returns:
      OpenStructuredResponseNormalizedMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenStructuredResponse

      public OpenStructuredResponseNormalizedMessage postConversationsMessageInboundOpenStructuredResponse(PostConversationsMessageInboundOpenStructuredResponseRequest request) throws IOException, ApiException
      Send inbound Open Response Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      OpenStructuredResponseNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageInboundOpenStructuredResponse

      public ApiResponse<OpenStructuredResponseNormalizedMessage> postConversationsMessageInboundOpenStructuredResponse(ApiRequest<OpenInboundStructuredResponseMessage> request) throws IOException
      Send inbound Open Response Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageMessagesBulk

      public TextMessageListing postConversationsMessageMessagesBulk(String conversationId, Boolean useNormalizedMessage, List<String> body) throws IOException, ApiException
      Get messages in batch The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
      Parameters:
      conversationId - (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      body - messageIds (optional)
      Returns:
      TextMessageListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageMessagesBulkWithHttpInfo

      public ApiResponse<TextMessageListing> postConversationsMessageMessagesBulkWithHttpInfo(String conversationId, Boolean useNormalizedMessage, List<String> body) throws IOException
      Get messages in batch The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
      Parameters:
      conversationId - (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, media) (optional, default to false)
      body - messageIds (optional)
      Returns:
      TextMessageListing
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageMessagesBulk

      public TextMessageListing postConversationsMessageMessagesBulk(PostConversationsMessageMessagesBulkRequest request) throws IOException, ApiException
      Get messages in batch The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
      Parameters:
      request - The request object
      Returns:
      TextMessageListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageMessagesBulk

      public ApiResponse<TextMessageListing> postConversationsMessageMessagesBulk(ApiRequest<List<String>> request) throws IOException
      Get messages in batch The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantCommunicationWrapup

      public void postConversationsMessageParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsMessageParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantCommunicationWrapup

      public void postConversationsMessageParticipantCommunicationWrapup(PostConversationsMessageParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsMessageParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantMonitor

      public void postConversationsMessageParticipantMonitor(String conversationId, String participantId) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantMonitorWithHttpInfo

      public ApiResponse<Void> postConversationsMessageParticipantMonitorWithHttpInfo(String conversationId, String participantId) throws IOException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantMonitor

      public void postConversationsMessageParticipantMonitor(PostConversationsMessageParticipantMonitorRequest request) throws IOException, ApiException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantMonitor

      public ApiResponse<Void> postConversationsMessageParticipantMonitor(ApiRequest<Void> request) throws IOException
      Listen in on the conversation from the point of view of a given participant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantReplace

      public void postConversationsMessageParticipantReplace(String conversationId, String participantId, TransferRequest body) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantReplaceWithHttpInfo

      public ApiResponse<Void> postConversationsMessageParticipantReplaceWithHttpInfo(String conversationId, String participantId, TransferRequest body) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      body - Transfer request (required)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantReplace

      public void postConversationsMessageParticipantReplace(PostConversationsMessageParticipantReplaceRequest request) throws IOException, ApiException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessageParticipantReplace

      public ApiResponse<Void> postConversationsMessageParticipantReplace(ApiRequest<TransferRequest> request) throws IOException
      Replace this participant with the specified user and/or address
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessages

      Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.
      Parameters:
      body - Create outbound messaging conversation (required)
      Returns:
      CreateOutboundMessagingConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagesWithHttpInfo

      Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.
      Parameters:
      body - Create outbound messaging conversation (required)
      Returns:
      CreateOutboundMessagingConversationResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessages

      Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.
      Parameters:
      request - The request object
      Returns:
      CreateOutboundMessagingConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessages

      Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagesAgentless

      public SendAgentlessOutboundMessageResponse postConversationsMessagesAgentless(SendAgentlessOutboundMessageRequest body, Boolean useNormalizedMessage) throws IOException, ApiException
      Send an agentless outbound message Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and recipient specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.
      Parameters:
      body - Create agentless outbound messaging request (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, messagingTemplate) (optional, default to false)
      Returns:
      SendAgentlessOutboundMessageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagesAgentlessWithHttpInfo

      public ApiResponse<SendAgentlessOutboundMessageResponse> postConversationsMessagesAgentlessWithHttpInfo(SendAgentlessOutboundMessageRequest body, Boolean useNormalizedMessage) throws IOException
      Send an agentless outbound message Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and recipient specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.
      Parameters:
      body - Create agentless outbound messaging request (required)
      useNormalizedMessage - If true, response removes deprecated fields (textBody, messagingTemplate) (optional, default to false)
      Returns:
      SendAgentlessOutboundMessageResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagesAgentless

      Send an agentless outbound message Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and recipient specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.
      Parameters:
      request - The request object
      Returns:
      SendAgentlessOutboundMessageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagesAgentless

      Send an agentless outbound message Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and recipient specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagesInboundOpen

      public OpenNormalizedMessage postConversationsMessagesInboundOpen(OpenNormalizedMessage body) throws IOException, ApiException
      Deprecated.
      Send an inbound Open Message [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      body - NormalizedMessage (required)
      Returns:
      OpenNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagesInboundOpenWithHttpInfo

      public ApiResponse<OpenNormalizedMessage> postConversationsMessagesInboundOpenWithHttpInfo(OpenNormalizedMessage body) throws IOException
      Deprecated.
      Send an inbound Open Message [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      body - NormalizedMessage (required)
      Returns:
      OpenNormalizedMessage
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagesInboundOpen

      public OpenNormalizedMessage postConversationsMessagesInboundOpen(PostConversationsMessagesInboundOpenRequest request) throws IOException, ApiException
      Deprecated.
      Send an inbound Open Message [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      OpenNormalizedMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagesInboundOpen

      public ApiResponse<OpenNormalizedMessage> postConversationsMessagesInboundOpen(ApiRequest<OpenNormalizedMessage> request) throws IOException
      Deprecated.
      Send an inbound Open Message [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsApple

      public AppleIntegration postConversationsMessagingIntegrationsApple(AppleIntegrationRequest body) throws IOException, ApiException
      Create Apple Integration
      Parameters:
      body - AppleIntegrationRequest (required)
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsAppleWithHttpInfo

      public ApiResponse<AppleIntegration> postConversationsMessagingIntegrationsAppleWithHttpInfo(AppleIntegrationRequest body) throws IOException
      Create Apple Integration
      Parameters:
      body - AppleIntegrationRequest (required)
      Returns:
      AppleIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsApple

      public AppleIntegration postConversationsMessagingIntegrationsApple(PostConversationsMessagingIntegrationsAppleRequest request) throws IOException, ApiException
      Create Apple Integration
      Parameters:
      request - The request object
      Returns:
      AppleIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsApple

      public ApiResponse<AppleIntegration> postConversationsMessagingIntegrationsApple(ApiRequest<AppleIntegrationRequest> request) throws IOException
      Create Apple Integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsFacebook

      public FacebookIntegration postConversationsMessagingIntegrationsFacebook(FacebookIntegrationRequest body) throws IOException, ApiException
      Create a Facebook Integration
      Parameters:
      body - FacebookIntegrationRequest (required)
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsFacebookWithHttpInfo

      public ApiResponse<FacebookIntegration> postConversationsMessagingIntegrationsFacebookWithHttpInfo(FacebookIntegrationRequest body) throws IOException
      Create a Facebook Integration
      Parameters:
      body - FacebookIntegrationRequest (required)
      Returns:
      FacebookIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsFacebook

      public FacebookIntegration postConversationsMessagingIntegrationsFacebook(PostConversationsMessagingIntegrationsFacebookRequest request) throws IOException, ApiException
      Create a Facebook Integration
      Parameters:
      request - The request object
      Returns:
      FacebookIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsFacebook

      public ApiResponse<FacebookIntegration> postConversationsMessagingIntegrationsFacebook(ApiRequest<FacebookIntegrationRequest> request) throws IOException
      Create a Facebook Integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsInstagram

      public InstagramIntegration postConversationsMessagingIntegrationsInstagram(InstagramIntegrationRequest body) throws IOException, ApiException
      Create Instagram Integration
      Parameters:
      body - InstagramIntegrationRequest (required)
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsInstagramWithHttpInfo

      public ApiResponse<InstagramIntegration> postConversationsMessagingIntegrationsInstagramWithHttpInfo(InstagramIntegrationRequest body) throws IOException
      Create Instagram Integration
      Parameters:
      body - InstagramIntegrationRequest (required)
      Returns:
      InstagramIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsInstagram

      public InstagramIntegration postConversationsMessagingIntegrationsInstagram(PostConversationsMessagingIntegrationsInstagramRequest request) throws IOException, ApiException
      Create Instagram Integration
      Parameters:
      request - The request object
      Returns:
      InstagramIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsInstagram

      public ApiResponse<InstagramIntegration> postConversationsMessagingIntegrationsInstagram(ApiRequest<InstagramIntegrationRequest> request) throws IOException
      Create Instagram Integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpen

      public OpenIntegration postConversationsMessagingIntegrationsOpen(OpenIntegrationRequest body) throws IOException, ApiException
      Create an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      body - OpenIntegrationRequest (required)
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenWithHttpInfo

      public ApiResponse<OpenIntegration> postConversationsMessagingIntegrationsOpenWithHttpInfo(OpenIntegrationRequest body) throws IOException
      Create an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      body - OpenIntegrationRequest (required)
      Returns:
      OpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpen

      public OpenIntegration postConversationsMessagingIntegrationsOpen(PostConversationsMessagingIntegrationsOpenRequest request) throws IOException, ApiException
      Create an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      OpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpen

      public ApiResponse<OpenIntegration> postConversationsMessagingIntegrationsOpen(ApiRequest<OpenIntegrationRequest> request) throws IOException
      Create an Open messaging integration See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile

      public GoogleBusinessProfileOpenIntegration postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile(GoogleBusinessProfileOpenIntegrationRequest body) throws IOException, ApiException
      Create an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - GoogleBusinessProfileOpenIntegrationRequest (required)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileWithHttpInfo

      public ApiResponse<GoogleBusinessProfileOpenIntegration> postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileWithHttpInfo(GoogleBusinessProfileOpenIntegrationRequest body) throws IOException
      Create an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - GoogleBusinessProfileOpenIntegrationRequest (required)
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile

      public GoogleBusinessProfileOpenIntegration postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile(PostConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileRequest request) throws IOException, ApiException
      Create an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleBusinessProfileOpenIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile

      public ApiResponse<GoogleBusinessProfileOpenIntegration> postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile(ApiRequest<GoogleBusinessProfileOpenIntegrationRequest> request) throws IOException
      Create an Open messaging integration with the Google Business Profile extension See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens

      public GoogleAuthToken postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens(GoogleAuthTokenRequest body) throws IOException, ApiException
      Create a Google Auth Token by exchanging the one-time auth code retrieved from Google See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - GoogleAuthTokenRequest (required)
      Returns:
      GoogleAuthToken
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokensWithHttpInfo

      public ApiResponse<GoogleAuthToken> postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokensWithHttpInfo(GoogleAuthTokenRequest body) throws IOException
      Create a Google Auth Token by exchanging the one-time auth code retrieved from Google See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - GoogleAuthTokenRequest (required)
      Returns:
      GoogleAuthToken
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens

      public GoogleAuthToken postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens(PostConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokensRequest request) throws IOException, ApiException
      Create a Google Auth Token by exchanging the one-time auth code retrieved from Google See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      GoogleAuthToken
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens

      public ApiResponse<GoogleAuthToken> postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens(ApiRequest<GoogleAuthTokenRequest> request) throws IOException
      Create a Google Auth Token by exchanging the one-time auth code retrieved from Google See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsTwitter

      public TwitterIntegration postConversationsMessagingIntegrationsTwitter(TwitterIntegrationRequest body) throws IOException, ApiException
      Create Twitter Integration
      Parameters:
      body - TwitterIntegrationRequest (required)
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsTwitterWithHttpInfo

      public ApiResponse<TwitterIntegration> postConversationsMessagingIntegrationsTwitterWithHttpInfo(TwitterIntegrationRequest body) throws IOException
      Create Twitter Integration
      Parameters:
      body - TwitterIntegrationRequest (required)
      Returns:
      TwitterIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsTwitter

      public TwitterIntegration postConversationsMessagingIntegrationsTwitter(PostConversationsMessagingIntegrationsTwitterRequest request) throws IOException, ApiException
      Create Twitter Integration
      Parameters:
      request - The request object
      Returns:
      TwitterIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsTwitter

      public ApiResponse<TwitterIntegration> postConversationsMessagingIntegrationsTwitter(ApiRequest<TwitterIntegrationRequest> request) throws IOException
      Create Twitter Integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsapp

      public WhatsAppIntegration postConversationsMessagingIntegrationsWhatsapp(WhatsAppIntegrationRequest body) throws IOException, ApiException
      Deprecated.
      [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
      Parameters:
      body - WhatsAppIntegrationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsappWithHttpInfo

      public ApiResponse<WhatsAppIntegration> postConversationsMessagingIntegrationsWhatsappWithHttpInfo(WhatsAppIntegrationRequest body) throws IOException
      Deprecated.
      [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
      Parameters:
      body - WhatsAppIntegrationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsapp

      public WhatsAppIntegration postConversationsMessagingIntegrationsWhatsapp(PostConversationsMessagingIntegrationsWhatsappRequest request) throws IOException, ApiException
      Deprecated.
      [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsapp

      public ApiResponse<WhatsAppIntegration> postConversationsMessagingIntegrationsWhatsapp(ApiRequest<WhatsAppIntegrationRequest> request) throws IOException
      Deprecated.
      [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsappEmbeddedsignup

      public WhatsAppIntegration postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(WhatsAppEmbeddedSignupIntegrationRequest body) throws IOException, ApiException
      Create a WhatsApp Integration using the WhatsApp embedded signup flow Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
      Parameters:
      body - WhatsAppEmbeddedSignupIntegrationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsappEmbeddedsignupWithHttpInfo

      public ApiResponse<WhatsAppIntegration> postConversationsMessagingIntegrationsWhatsappEmbeddedsignupWithHttpInfo(WhatsAppEmbeddedSignupIntegrationRequest body) throws IOException
      Create a WhatsApp Integration using the WhatsApp embedded signup flow Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
      Parameters:
      body - WhatsAppEmbeddedSignupIntegrationRequest (required)
      Returns:
      WhatsAppIntegration
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsappEmbeddedsignup

      public WhatsAppIntegration postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(PostConversationsMessagingIntegrationsWhatsappEmbeddedsignupRequest request) throws IOException, ApiException
      Create a WhatsApp Integration using the WhatsApp embedded signup flow Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
      Parameters:
      request - The request object
      Returns:
      WhatsAppIntegration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingIntegrationsWhatsappEmbeddedsignup

      public ApiResponse<WhatsAppIntegration> postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(ApiRequest<WhatsAppEmbeddedSignupIntegrationRequest> request) throws IOException
      Create a WhatsApp Integration using the WhatsApp embedded signup flow Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingSettings

      public MessagingSetting postConversationsMessagingSettings(MessagingSettingRequest body) throws IOException, ApiException
      Create a messaging setting
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingSettingsWithHttpInfo

      public ApiResponse<MessagingSetting> postConversationsMessagingSettingsWithHttpInfo(MessagingSettingRequest body) throws IOException
      Create a messaging setting
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingSettings

      public MessagingSetting postConversationsMessagingSettings(PostConversationsMessagingSettingsRequest request) throws IOException, ApiException
      Create a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingSettings

      public ApiResponse<MessagingSetting> postConversationsMessagingSettings(ApiRequest<MessagingSettingRequest> request) throws IOException
      Create a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingSupportedcontent

      public SupportedContent postConversationsMessagingSupportedcontent(SupportedContent body) throws IOException, ApiException
      Create a Supported Content profile
      Parameters:
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingSupportedcontentWithHttpInfo

      public ApiResponse<SupportedContent> postConversationsMessagingSupportedcontentWithHttpInfo(SupportedContent body) throws IOException
      Create a Supported Content profile
      Parameters:
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed
    • postConversationsMessagingSupportedcontent

      public SupportedContent postConversationsMessagingSupportedcontent(PostConversationsMessagingSupportedcontentRequest request) throws IOException, ApiException
      Create a Supported Content profile
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsMessagingSupportedcontent

      public ApiResponse<SupportedContent> postConversationsMessagingSupportedcontent(ApiRequest<SupportedContent> request) throws IOException
      Create a Supported Content profile
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsParticipantsAttributesSearch

      public JsonCursorSearchResponse postConversationsParticipantsAttributesSearch(ConversationParticipantSearchRequest body) throws IOException, ApiException
      Search conversations
      Parameters:
      body - Search request options (required)
      Returns:
      JsonCursorSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsParticipantsAttributesSearchWithHttpInfo

      public ApiResponse<JsonCursorSearchResponse> postConversationsParticipantsAttributesSearchWithHttpInfo(ConversationParticipantSearchRequest body) throws IOException
      Search conversations
      Parameters:
      body - Search request options (required)
      Returns:
      JsonCursorSearchResponse
      Throws:
      IOException - if the request fails to be processed
    • postConversationsParticipantsAttributesSearch

      public JsonCursorSearchResponse postConversationsParticipantsAttributesSearch(PostConversationsParticipantsAttributesSearchRequest request) throws IOException, ApiException
      Search conversations
      Parameters:
      request - The request object
      Returns:
      JsonCursorSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsParticipantsAttributesSearch

      public ApiResponse<JsonCursorSearchResponse> postConversationsParticipantsAttributesSearch(ApiRequest<ConversationParticipantSearchRequest> request) throws IOException
      Search conversations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsScreenshareParticipantCommunicationWrapup

      public void postConversationsScreenshareParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsScreenshareParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsScreenshareParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsScreenshareParticipantCommunicationWrapup

      public void postConversationsScreenshareParticipantCommunicationWrapup(PostConversationsScreenshareParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Deprecated.
      Apply wrap-up for this conversation communication This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsScreenshareParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsScreenshareParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Deprecated.
      Apply wrap-up for this conversation communication 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
    • postConversationsSocialParticipantCommunicationWrapup

      public void postConversationsSocialParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsSocialParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsSocialParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsSocialParticipantCommunicationWrapup

      public void postConversationsSocialParticipantCommunicationWrapup(PostConversationsSocialParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsSocialParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsSocialParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideoAgentconferenceCommunication

      public VideoConferenceDetails postConversationsVideoAgentconferenceCommunication(String conversationId, String communicationId) throws IOException, ApiException
      Create an Agent-Type video conference and assign an agent to it postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      Returns:
      VideoConferenceDetails
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideoAgentconferenceCommunicationWithHttpInfo

      public ApiResponse<VideoConferenceDetails> postConversationsVideoAgentconferenceCommunicationWithHttpInfo(String conversationId, String communicationId) throws IOException
      Create an Agent-Type video conference and assign an agent to it postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      conversationId - conversationId (required)
      communicationId - communicationId (required)
      Returns:
      VideoConferenceDetails
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideoAgentconferenceCommunication

      public VideoConferenceDetails postConversationsVideoAgentconferenceCommunication(PostConversationsVideoAgentconferenceCommunicationRequest request) throws IOException, ApiException
      Create an Agent-Type video conference and assign an agent to it postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      VideoConferenceDetails
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideoAgentconferenceCommunication

      public ApiResponse<VideoConferenceDetails> postConversationsVideoAgentconferenceCommunication(ApiRequest<Void> request) throws IOException
      Create an Agent-Type video conference and assign an agent to it postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideoParticipantCommunicationWrapup

      public void postConversationsVideoParticipantCommunicationWrapup(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideoParticipantCommunicationWrapupWithHttpInfo

      public ApiResponse<Void> postConversationsVideoParticipantCommunicationWrapupWithHttpInfo(String conversationId, String participantId, String communicationId, WrapupInput body) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - Wrap-up (optional)
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideoParticipantCommunicationWrapup

      public void postConversationsVideoParticipantCommunicationWrapup(PostConversationsVideoParticipantCommunicationWrapupRequest request) throws IOException, ApiException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideoParticipantCommunicationWrapup

      public ApiResponse<Void> postConversationsVideoParticipantCommunicationWrapup(ApiRequest<WrapupInput> request) throws IOException
      Apply wrap-up for this conversation communication
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideosMeetings

      public MeetingIdRecord postConversationsVideosMeetings(GenerateMeetingIdRequest body) throws IOException, ApiException
      Generate a meetingId for a given conferenceId
      Parameters:
      body - MeetingIdRequest (required)
      Returns:
      MeetingIdRecord
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideosMeetingsWithHttpInfo

      public ApiResponse<MeetingIdRecord> postConversationsVideosMeetingsWithHttpInfo(GenerateMeetingIdRequest body) throws IOException
      Generate a meetingId for a given conferenceId
      Parameters:
      body - MeetingIdRequest (required)
      Returns:
      MeetingIdRecord
      Throws:
      IOException - if the request fails to be processed
    • postConversationsVideosMeetings

      public MeetingIdRecord postConversationsVideosMeetings(PostConversationsVideosMeetingsRequest request) throws IOException, ApiException
      Generate a meetingId for a given conferenceId
      Parameters:
      request - The request object
      Returns:
      MeetingIdRecord
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postConversationsVideosMeetings

      public ApiResponse<MeetingIdRecord> postConversationsVideosMeetings(ApiRequest<GenerateMeetingIdRequest> request) throws IOException
      Generate a meetingId for a given conferenceId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationCustomattributes

      public CustomAttributesIdResponse putConversationCustomattributes(String conversationId, CustomAttributesUpdateRequest body) throws IOException, ApiException
      Create or update a single custom attributes record. Updating replaces all data with the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesIdResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationCustomattributesWithHttpInfo

      public ApiResponse<CustomAttributesIdResponse> putConversationCustomattributesWithHttpInfo(String conversationId, CustomAttributesUpdateRequest body) throws IOException
      Create or update a single custom attributes record. Updating replaces all data with the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesIdResponse
      Throws:
      IOException - if the request fails to be processed
    • putConversationCustomattributes

      public CustomAttributesIdResponse putConversationCustomattributes(PutConversationCustomattributesRequest request) throws IOException, ApiException
      Create or update a single custom attributes record. Updating replaces all data with the provided fields.
      Parameters:
      request - The request object
      Returns:
      CustomAttributesIdResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationCustomattributes

      public ApiResponse<CustomAttributesIdResponse> putConversationCustomattributes(ApiRequest<CustomAttributesUpdateRequest> request) throws IOException
      Create or update a single custom attributes record. Updating replaces all data with the provided fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationCustomattributesBulk

      public CustomAttributesBulkUpdateResponseMap putConversationCustomattributesBulk(String conversationId, List<CustomAttributesUpdateRequest> body) throws IOException, ApiException
      Create or update a list of custom attributes records. Updating replaces all data with the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationCustomattributesBulkWithHttpInfo

      public ApiResponse<CustomAttributesBulkUpdateResponseMap> putConversationCustomattributesBulkWithHttpInfo(String conversationId, List<CustomAttributesUpdateRequest> body) throws IOException
      Create or update a list of custom attributes records. Updating replaces all data with the provided fields.
      Parameters:
      conversationId - conversation ID (required)
      body - (optional)
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      IOException - if the request fails to be processed
    • putConversationCustomattributesBulk

      Create or update a list of custom attributes records. Updating replaces all data with the provided fields.
      Parameters:
      request - The request object
      Returns:
      CustomAttributesBulkUpdateResponseMap
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationCustomattributesBulk

      public ApiResponse<CustomAttributesBulkUpdateResponseMap> putConversationCustomattributesBulk(ApiRequest<List<CustomAttributesUpdateRequest>> request) throws IOException
      Create or update a list of custom attributes records. Updating replaces all data with the provided fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationParticipantFlaggedreason

      public void putConversationParticipantFlaggedreason(String conversationId, String participantId) throws IOException, ApiException
      Set flagged reason on conversation participant to indicate bad conversation quality.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationParticipantFlaggedreasonWithHttpInfo

      public ApiResponse<Void> putConversationParticipantFlaggedreasonWithHttpInfo(String conversationId, String participantId) throws IOException
      Set flagged reason on conversation participant to indicate bad conversation quality.
      Parameters:
      conversationId - conversation ID (required)
      participantId - participant ID (required)
      Throws:
      IOException - if the request fails to be processed
    • putConversationParticipantFlaggedreason

      public void putConversationParticipantFlaggedreason(PutConversationParticipantFlaggedreasonRequest request) throws IOException, ApiException
      Set flagged reason on conversation participant to indicate bad conversation quality.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationParticipantFlaggedreason

      public ApiResponse<Void> putConversationParticipantFlaggedreason(ApiRequest<Void> request) throws IOException
      Set flagged reason on conversation participant to indicate bad conversation quality.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationSecureattributes

      public String putConversationSecureattributes(String conversationId, ConversationSecureAttributes body) throws IOException, ApiException
      Set the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Secure Attributes (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationSecureattributesWithHttpInfo

      public ApiResponse<String> putConversationSecureattributesWithHttpInfo(String conversationId, ConversationSecureAttributes body) throws IOException
      Set the secure attributes on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Secure Attributes (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationSecureattributes

      public String putConversationSecureattributes(PutConversationSecureattributesRequest request) throws IOException, ApiException
      Set the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationSecureattributes

      public ApiResponse<String> putConversationSecureattributes(ApiRequest<ConversationSecureAttributes> request) throws IOException
      Set the secure attributes on a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationTags

      public String putConversationTags(String conversationId, ConversationTagsUpdate body) throws IOException, ApiException
      Update the tags on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Tags (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationTagsWithHttpInfo

      public ApiResponse<String> putConversationTagsWithHttpInfo(String conversationId, ConversationTagsUpdate body) throws IOException
      Update the tags on a conversation.
      Parameters:
      conversationId - conversation ID (required)
      body - Conversation Tags (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationTags

      public String putConversationTags(PutConversationTagsRequest request) throws IOException, ApiException
      Update the tags on a conversation.
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationTags

      public ApiResponse<String> putConversationTags(ApiRequest<ConversationTagsUpdate> request) throws IOException
      Update the tags on a conversation.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallParticipantCommunicationUuidata

      public Empty putConversationsCallParticipantCommunicationUuidata(String conversationId, String participantId, String communicationId, SetUuiDataRequest body) throws IOException, ApiException
      Set uuiData to be sent on future commands.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - UUIData Request (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallParticipantCommunicationUuidataWithHttpInfo

      public ApiResponse<Empty> putConversationsCallParticipantCommunicationUuidataWithHttpInfo(String conversationId, String participantId, String communicationId, SetUuiDataRequest body) throws IOException
      Set uuiData to be sent on future commands.
      Parameters:
      conversationId - conversationId (required)
      participantId - participantId (required)
      communicationId - communicationId (required)
      body - UUIData Request (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallParticipantCommunicationUuidata

      public Empty putConversationsCallParticipantCommunicationUuidata(PutConversationsCallParticipantCommunicationUuidataRequest request) throws IOException, ApiException
      Set uuiData to be sent on future commands.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallParticipantCommunicationUuidata

      public ApiResponse<Empty> putConversationsCallParticipantCommunicationUuidata(ApiRequest<SetUuiDataRequest> request) throws IOException
      Set uuiData to be sent on future commands.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallRecordingstate

      public String putConversationsCallRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsCallRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallRecordingstate

      public String putConversationsCallRecordingstate(PutConversationsCallRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallRecordingstate

      public ApiResponse<String> putConversationsCallRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallbackRecordingstate

      public String putConversationsCallbackRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallbackRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsCallbackRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCallbackRecordingstate

      public String putConversationsCallbackRecordingstate(PutConversationsCallbackRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCallbackRecordingstate

      public ApiResponse<String> putConversationsCallbackRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsChatRecordingstate

      public String putConversationsChatRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state 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)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsChatRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsChatRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Deprecated.
      Update a conversation by setting its recording state 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)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsChatRecordingstate

      public String putConversationsChatRecordingstate(PutConversationsChatRecordingstateRequest request) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state 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:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsChatRecordingstate

      public ApiResponse<String> putConversationsChatRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Deprecated.
      Update a conversation by setting its recording state 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
    • putConversationsCobrowsesessionRecordingstate

      public String putConversationsCobrowsesessionRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCobrowsesessionRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsCobrowsesessionRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Deprecated.
      Update a conversation by setting its recording state This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCobrowsesessionRecordingstate

      public String putConversationsCobrowsesessionRecordingstate(PutConversationsCobrowsesessionRecordingstateRequest request) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state 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:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCobrowsesessionRecordingstate

      public ApiResponse<String> putConversationsCobrowsesessionRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Deprecated.
      Update a conversation by setting its recording state 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
    • putConversationsCustomattributesSchema

      public ConversationDataSchema putConversationsCustomattributesSchema(String schemaId, ConversationSchemaUpdateRequest body) throws IOException, ApiException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Schema update request body (required)
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCustomattributesSchemaWithHttpInfo

      public ApiResponse<ConversationDataSchema> putConversationsCustomattributesSchemaWithHttpInfo(String schemaId, ConversationSchemaUpdateRequest body) throws IOException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Schema update request body (required)
      Returns:
      ConversationDataSchema
      Throws:
      IOException - if the request fails to be processed
    • putConversationsCustomattributesSchema

      public ConversationDataSchema putConversationsCustomattributesSchema(PutConversationsCustomattributesSchemaRequest request) throws IOException, ApiException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      ConversationDataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsCustomattributesSchema

      public ApiResponse<ConversationDataSchema> putConversationsCustomattributesSchema(ApiRequest<ConversationSchemaUpdateRequest> request) throws IOException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsEmailMessagesDraft

      public EmailMessage putConversationsEmailMessagesDraft(String conversationId, EmailMessage body) throws IOException, ApiException
      Update conversation draft reply
      Parameters:
      conversationId - conversationId (required)
      body - Draft (required)
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsEmailMessagesDraftWithHttpInfo

      public ApiResponse<EmailMessage> putConversationsEmailMessagesDraftWithHttpInfo(String conversationId, EmailMessage body) throws IOException
      Update conversation draft reply
      Parameters:
      conversationId - conversationId (required)
      body - Draft (required)
      Returns:
      EmailMessage
      Throws:
      IOException - if the request fails to be processed
    • putConversationsEmailMessagesDraft

      public EmailMessage putConversationsEmailMessagesDraft(PutConversationsEmailMessagesDraftRequest request) throws IOException, ApiException
      Update conversation draft reply
      Parameters:
      request - The request object
      Returns:
      EmailMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsEmailMessagesDraft

      public ApiResponse<EmailMessage> putConversationsEmailMessagesDraft(ApiRequest<EmailMessage> request) throws IOException
      Update conversation draft reply
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsEmailRecordingstate

      public String putConversationsEmailRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsEmailRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsEmailRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsEmailRecordingstate

      public String putConversationsEmailRecordingstate(PutConversationsEmailRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsEmailRecordingstate

      public ApiResponse<String> putConversationsEmailRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsKeyconfiguration

      public ConversationEncryptionConfiguration putConversationsKeyconfiguration(String keyconfigurationsId, ConversationEncryptionConfiguration body) throws IOException, ApiException
      Update the encryption key configurations
      Parameters:
      keyconfigurationsId - Key Configurations Id (required)
      body - Encryption key configuration metadata (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsKeyconfigurationWithHttpInfo

      public ApiResponse<ConversationEncryptionConfiguration> putConversationsKeyconfigurationWithHttpInfo(String keyconfigurationsId, ConversationEncryptionConfiguration body) throws IOException
      Update the encryption key configurations
      Parameters:
      keyconfigurationsId - Key Configurations Id (required)
      body - Encryption key configuration metadata (required)
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      IOException - if the request fails to be processed
    • putConversationsKeyconfiguration

      Update the encryption key configurations
      Parameters:
      request - The request object
      Returns:
      ConversationEncryptionConfiguration
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsKeyconfiguration

      Update the encryption key configurations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessageRecordingstate

      public String putConversationsMessageRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessageRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsMessageRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessageRecordingstate

      public String putConversationsMessageRecordingstate(PutConversationsMessageRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessageRecordingstate

      public ApiResponse<String> putConversationsMessageRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public AppleIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(String integrationId, AppleIdentityResolutionConfig body) throws IOException, ApiException
      Create an identity resolution settings for a Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdWithHttpInfo

      public ApiResponse<AppleIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdWithHttpInfo(String integrationId, AppleIdentityResolutionConfig body) throws IOException
      Create an identity resolution settings for a Apple messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public AppleIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationIdRequest request) throws IOException, ApiException
      Create an identity resolution settings for a Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      AppleIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId

      public ApiResponse<AppleIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(ApiRequest<AppleIdentityResolutionConfig> request) throws IOException
      Create an identity resolution settings for a Apple messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public FacebookIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(String integrationId, FacebookIdentityResolutionConfig body) throws IOException, ApiException
      Create an identity resolution settings for a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdWithHttpInfo

      public ApiResponse<FacebookIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdWithHttpInfo(String integrationId, FacebookIdentityResolutionConfig body) throws IOException
      Create an identity resolution settings for a Facebook messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public FacebookIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationIdRequest request) throws IOException, ApiException
      Create an identity resolution settings for a Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      FacebookIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId

      public ApiResponse<FacebookIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(ApiRequest<FacebookIdentityResolutionConfig> request) throws IOException
      Create an identity resolution settings for a Facebook messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public InstagramIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(String integrationId, InstagramIdentityResolutionConfig body) throws IOException, ApiException
      Create identity resolution settings for an Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdWithHttpInfo

      public ApiResponse<InstagramIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdWithHttpInfo(String integrationId, InstagramIdentityResolutionConfig body) throws IOException
      Create identity resolution settings for an Instagram messaging integration
      Parameters:
      integrationId - Integration ID (required)
      body - IdentityResolutionConfig (required)
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public InstagramIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationIdRequest request) throws IOException, ApiException
      Create identity resolution settings for an Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      InstagramIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId

      public ApiResponse<InstagramIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(ApiRequest<InstagramIdentityResolutionConfig> request) throws IOException
      Create identity resolution settings for an Instagram messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public OpenMessagingIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(String integrationId, OpenMessagingIdentityResolutionConfig body) throws IOException, ApiException
      Update an open messaging integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      body - (required)
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdWithHttpInfo

      public ApiResponse<OpenMessagingIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdWithHttpInfo(String integrationId, OpenMessagingIdentityResolutionConfig body) throws IOException
      Update an open messaging integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      body - (required)
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public OpenMessagingIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationIdRequest request) throws IOException, ApiException
      Update an open messaging integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      OpenMessagingIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId

      public ApiResponse<OpenMessagingIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(ApiRequest<OpenMessagingIdentityResolutionConfig> request) throws IOException
      Update an open messaging integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public TwitterIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(String integrationId, TwitterIdentityResolutionConfig body) throws IOException, ApiException
      Create an identity resolution settings for an X (Formally Twitter) messaging integration
      Parameters:
      integrationId - Integration Id (required)
      body - IdentityResolutionConfig (required)
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdWithHttpInfo

      public ApiResponse<TwitterIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdWithHttpInfo(String integrationId, TwitterIdentityResolutionConfig body) throws IOException
      Create an identity resolution settings for an X (Formally Twitter) messaging integration
      Parameters:
      integrationId - Integration Id (required)
      body - IdentityResolutionConfig (required)
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public TwitterIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationIdRequest request) throws IOException, ApiException
      Create an identity resolution settings for an X (Formally Twitter) messaging integration
      Parameters:
      request - The request object
      Returns:
      TwitterIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId

      public ApiResponse<TwitterIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(ApiRequest<TwitterIdentityResolutionConfig> request) throws IOException
      Create an identity resolution settings for an X (Formally Twitter) messaging integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public WhatsAppIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(String integrationId, WhatsAppIdentityResolutionConfig body) throws IOException, ApiException
      Update a whatsApp integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      body - (required)
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdWithHttpInfo

      public ApiResponse<WhatsAppIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdWithHttpInfo(String integrationId, WhatsAppIdentityResolutionConfig body) throws IOException
      Update a whatsApp integration Identity Resolution settings
      Parameters:
      integrationId - Integration ID (required)
      body - (required)
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public WhatsAppIdentityResolutionConfig putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(PutConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationIdRequest request) throws IOException, ApiException
      Update a whatsApp integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      WhatsAppIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId

      public ApiResponse<WhatsAppIdentityResolutionConfig> putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(ApiRequest<WhatsAppIdentityResolutionConfig> request) throws IOException
      Update a whatsApp integration Identity Resolution settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingSettingsDefault

      public MessagingSetting putConversationsMessagingSettingsDefault(MessagingSettingDefaultRequest body) throws IOException, ApiException
      Set the organization's default setting that may be applied to to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<MessagingSetting> putConversationsMessagingSettingsDefaultWithHttpInfo(MessagingSettingDefaultRequest body) throws IOException
      Set the organization's default setting that may be applied to to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingSettingsDefault

      public MessagingSetting putConversationsMessagingSettingsDefault(PutConversationsMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Set the organization's default setting that may be applied to to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingSettingsDefault

      public ApiResponse<MessagingSetting> putConversationsMessagingSettingsDefault(ApiRequest<MessagingSettingDefaultRequest> request) throws IOException
      Set the organization's default setting that may be applied to to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingSupportedcontentDefault

      public SupportedContent putConversationsMessagingSupportedcontentDefault(SupportedContentReference body) throws IOException, ApiException
      Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      body - Reference to supported content profile (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingSupportedcontentDefaultWithHttpInfo

      public ApiResponse<SupportedContent> putConversationsMessagingSupportedcontentDefaultWithHttpInfo(SupportedContentReference body) throws IOException
      Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      body - Reference to supported content profile (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingSupportedcontentDefault

      public SupportedContent putConversationsMessagingSupportedcontentDefault(PutConversationsMessagingSupportedcontentDefaultRequest request) throws IOException, ApiException
      Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingSupportedcontentDefault

      public ApiResponse<SupportedContent> putConversationsMessagingSupportedcontentDefault(ApiRequest<SupportedContentReference> request) throws IOException
      Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingThreadingtimeline

      public ConversationThreadingWindow putConversationsMessagingThreadingtimeline(ConversationThreadingWindow body) throws IOException, ApiException
      Update conversation threading window timeline for each messaging type PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
      Parameters:
      body - ConversationThreadingWindowRequest (required)
      Returns:
      ConversationThreadingWindow
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingThreadingtimelineWithHttpInfo

      public ApiResponse<ConversationThreadingWindow> putConversationsMessagingThreadingtimelineWithHttpInfo(ConversationThreadingWindow body) throws IOException
      Update conversation threading window timeline for each messaging type PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
      Parameters:
      body - ConversationThreadingWindowRequest (required)
      Returns:
      ConversationThreadingWindow
      Throws:
      IOException - if the request fails to be processed
    • putConversationsMessagingThreadingtimeline

      public ConversationThreadingWindow putConversationsMessagingThreadingtimeline(PutConversationsMessagingThreadingtimelineRequest request) throws IOException, ApiException
      Update conversation threading window timeline for each messaging type PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
      Parameters:
      request - The request object
      Returns:
      ConversationThreadingWindow
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsMessagingThreadingtimeline

      public ApiResponse<ConversationThreadingWindow> putConversationsMessagingThreadingtimeline(ApiRequest<ConversationThreadingWindow> request) throws IOException
      Update conversation threading window timeline for each messaging type PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsScreenshareRecordingstate

      public String putConversationsScreenshareRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsScreenshareRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsScreenshareRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Deprecated.
      Update a conversation by setting its recording state This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsScreenshareRecordingstate

      public String putConversationsScreenshareRecordingstate(PutConversationsScreenshareRecordingstateRequest request) throws IOException, ApiException
      Deprecated.
      Update a conversation by setting its recording state 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:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsScreenshareRecordingstate

      public ApiResponse<String> putConversationsScreenshareRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Deprecated.
      Update a conversation by setting its recording state 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
    • putConversationsSocialRecordingstate

      public String putConversationsSocialRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsSocialRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsSocialRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsSocialRecordingstate

      public String putConversationsSocialRecordingstate(PutConversationsSocialRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsSocialRecordingstate

      public ApiResponse<String> putConversationsSocialRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putConversationsVideoRecordingstate

      public String putConversationsVideoRecordingstate(String conversationId, SetRecordingState body) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsVideoRecordingstateWithHttpInfo

      public ApiResponse<String> putConversationsVideoRecordingstateWithHttpInfo(String conversationId, SetRecordingState body) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      conversationId - conversationId (required)
      body - SetRecordingState (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putConversationsVideoRecordingstate

      public String putConversationsVideoRecordingstate(PutConversationsVideoRecordingstateRequest request) throws IOException, ApiException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putConversationsVideoRecordingstate

      public ApiResponse<String> putConversationsVideoRecordingstate(ApiRequest<SetRecordingState> request) throws IOException
      Update a conversation by setting its recording state
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed