Class OutboundApi

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

public class OutboundApi extends Object
  • Constructor Details

    • OutboundApi

      public OutboundApi()
    • OutboundApi

      public OutboundApi(ApiClient apiClient)
  • Method Details

    • deleteOutboundAttemptlimit

      public void deleteOutboundAttemptlimit(String attemptLimitsId) throws IOException, ApiException
      Delete attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundAttemptlimitWithHttpInfo

      public ApiResponse<Void> deleteOutboundAttemptlimitWithHttpInfo(String attemptLimitsId) throws IOException
      Delete attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundAttemptlimit

      public void deleteOutboundAttemptlimit(DeleteOutboundAttemptlimitRequest request) throws IOException, ApiException
      Delete attempt limits
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundAttemptlimit

      public ApiResponse<Void> deleteOutboundAttemptlimit(ApiRequest<Void> request) throws IOException
      Delete attempt limits
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCallabletimeset

      public void deleteOutboundCallabletimeset(String callableTimeSetId) throws IOException, ApiException
      Delete callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCallabletimesetWithHttpInfo

      public ApiResponse<Void> deleteOutboundCallabletimesetWithHttpInfo(String callableTimeSetId) throws IOException
      Delete callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCallabletimeset

      public void deleteOutboundCallabletimeset(DeleteOutboundCallabletimesetRequest request) throws IOException, ApiException
      Delete callable time set
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCallabletimeset

      public ApiResponse<Void> deleteOutboundCallabletimeset(ApiRequest<Void> request) throws IOException
      Delete callable time set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCallanalysisresponseset

      public void deleteOutboundCallanalysisresponseset(String callAnalysisSetId) throws IOException, ApiException
      Delete a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCallanalysisresponsesetWithHttpInfo

      public ApiResponse<Void> deleteOutboundCallanalysisresponsesetWithHttpInfo(String callAnalysisSetId) throws IOException
      Delete a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCallanalysisresponseset

      public void deleteOutboundCallanalysisresponseset(DeleteOutboundCallanalysisresponsesetRequest request) throws IOException, ApiException
      Delete a dialer call analysis response set.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCallanalysisresponseset

      public ApiResponse<Void> deleteOutboundCallanalysisresponseset(ApiRequest<Void> request) throws IOException
      Delete a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaign

      public Campaign deleteOutboundCampaign(String campaignId) throws IOException, ApiException
      Delete a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaignWithHttpInfo

      public ApiResponse<Campaign> deleteOutboundCampaignWithHttpInfo(String campaignId) throws IOException
      Delete a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Campaign
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaign

      public Campaign deleteOutboundCampaign(DeleteOutboundCampaignRequest request) throws IOException, ApiException
      Delete a campaign.
      Parameters:
      request - The request object
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaign

      public ApiResponse<Campaign> deleteOutboundCampaign(ApiRequest<Void> request) throws IOException
      Delete a campaign.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaignProgress

      public void deleteOutboundCampaignProgress(String campaignId) throws IOException, ApiException
      Reset campaign progress and recycle the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaignProgressWithHttpInfo

      public ApiResponse<Void> deleteOutboundCampaignProgressWithHttpInfo(String campaignId) throws IOException
      Reset campaign progress and recycle the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaignProgress

      public void deleteOutboundCampaignProgress(DeleteOutboundCampaignProgressRequest request) throws IOException, ApiException
      Reset campaign progress and recycle the campaign
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaignProgress

      public ApiResponse<Void> deleteOutboundCampaignProgress(ApiRequest<Void> request) throws IOException
      Reset campaign progress and recycle the campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaignrule

      public void deleteOutboundCampaignrule(String campaignRuleId) throws IOException, ApiException
      Delete Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaignruleWithHttpInfo

      public ApiResponse<Void> deleteOutboundCampaignruleWithHttpInfo(String campaignRuleId) throws IOException
      Delete Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundCampaignrule

      public void deleteOutboundCampaignrule(DeleteOutboundCampaignruleRequest request) throws IOException, ApiException
      Delete Campaign Rule
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundCampaignrule

      public ApiResponse<Void> deleteOutboundCampaignrule(ApiRequest<Void> request) throws IOException
      Delete Campaign Rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlist

      public void deleteOutboundContactlist(String contactListId) throws IOException, ApiException
      Delete a contact list.
      Parameters:
      contactListId - ContactList ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlistWithHttpInfo(String contactListId) throws IOException
      Delete a contact list.
      Parameters:
      contactListId - ContactList ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlist

      public void deleteOutboundContactlist(DeleteOutboundContactlistRequest request) throws IOException, ApiException
      Delete a contact list.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlist

      public ApiResponse<Void> deleteOutboundContactlist(ApiRequest<Void> request) throws IOException
      Delete a contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContact

      public void deleteOutboundContactlistContact(String contactListId, String contactId) throws IOException, ApiException
      Delete a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContactWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlistContactWithHttpInfo(String contactListId, String contactId) throws IOException
      Delete a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContact

      public void deleteOutboundContactlistContact(DeleteOutboundContactlistContactRequest request) throws IOException, ApiException
      Delete a contact.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContact

      public ApiResponse<Void> deleteOutboundContactlistContact(ApiRequest<Void> request) throws IOException
      Delete a contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContacts

      public void deleteOutboundContactlistContacts(String contactListId, List<String> contactIds) throws IOException, ApiException
      Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
      Parameters:
      contactListId - Contact List ID (required)
      contactIds - ContactIds to delete. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContactsWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlistContactsWithHttpInfo(String contactListId, List<String> contactIds) throws IOException
      Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
      Parameters:
      contactListId - Contact List ID (required)
      contactIds - ContactIds to delete. (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContacts

      public void deleteOutboundContactlistContacts(DeleteOutboundContactlistContactsRequest request) throws IOException, ApiException
      Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistContacts

      public ApiResponse<Void> deleteOutboundContactlistContacts(ApiRequest<Void> request) throws IOException
      Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistfilter

      public void deleteOutboundContactlistfilter(String contactListFilterId) throws IOException, ApiException
      Delete Contact List Filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistfilterWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlistfilterWithHttpInfo(String contactListFilterId) throws IOException
      Delete Contact List Filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlistfilter

      public void deleteOutboundContactlistfilter(DeleteOutboundContactlistfilterRequest request) throws IOException, ApiException
      Delete Contact List Filter
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistfilter

      public ApiResponse<Void> deleteOutboundContactlistfilter(ApiRequest<Void> request) throws IOException
      Delete Contact List Filter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlists

      public void deleteOutboundContactlists(List<String> id) throws IOException, ApiException
      Delete multiple contact lists.
      Parameters:
      id - contact list id(s) to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlistsWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlistsWithHttpInfo(List<String> id) throws IOException
      Delete multiple contact lists.
      Parameters:
      id - contact list id(s) to delete (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlists

      public void deleteOutboundContactlists(DeleteOutboundContactlistsRequest request) throws IOException, ApiException
      Delete multiple contact lists.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlists

      public ApiResponse<Void> deleteOutboundContactlists(ApiRequest<Void> request) throws IOException
      Delete multiple contact lists.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplate

      public void deleteOutboundContactlisttemplate(String contactListTemplateId) throws IOException, ApiException
      Delete Contact List Template
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplateWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlisttemplateWithHttpInfo(String contactListTemplateId) throws IOException
      Delete Contact List Template
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplate

      public void deleteOutboundContactlisttemplate(DeleteOutboundContactlisttemplateRequest request) throws IOException, ApiException
      Delete Contact List Template
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplate

      public ApiResponse<Void> deleteOutboundContactlisttemplate(ApiRequest<Void> request) throws IOException
      Delete Contact List Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplates

      public void deleteOutboundContactlisttemplates(List<String> id) throws IOException, ApiException
      Delete multiple contact list templates.
      Parameters:
      id - contact list template id(s) to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplatesWithHttpInfo

      public ApiResponse<Void> deleteOutboundContactlisttemplatesWithHttpInfo(List<String> id) throws IOException
      Delete multiple contact list templates.
      Parameters:
      id - contact list template id(s) to delete (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplates

      public void deleteOutboundContactlisttemplates(DeleteOutboundContactlisttemplatesRequest request) throws IOException, ApiException
      Delete multiple contact list templates.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundContactlisttemplates

      public ApiResponse<Void> deleteOutboundContactlisttemplates(ApiRequest<Void> request) throws IOException
      Delete multiple contact list templates.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDigitalruleset

      public void deleteOutboundDigitalruleset(String digitalRuleSetId) throws IOException, ApiException
      Delete an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDigitalrulesetWithHttpInfo

      public ApiResponse<Void> deleteOutboundDigitalrulesetWithHttpInfo(String digitalRuleSetId) throws IOException
      Delete an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDigitalruleset

      public void deleteOutboundDigitalruleset(DeleteOutboundDigitalrulesetRequest request) throws IOException, ApiException
      Delete an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDigitalruleset

      public ApiResponse<Void> deleteOutboundDigitalruleset(ApiRequest<Void> request) throws IOException
      Delete an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclist

      public void deleteOutboundDnclist(String dncListId) throws IOException, ApiException
      Delete dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistWithHttpInfo

      public ApiResponse<Void> deleteOutboundDnclistWithHttpInfo(String dncListId) throws IOException
      Delete dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclist

      public void deleteOutboundDnclist(DeleteOutboundDnclistRequest request) throws IOException, ApiException
      Delete dialer DNC list
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclist

      public ApiResponse<Void> deleteOutboundDnclist(ApiRequest<Void> request) throws IOException
      Delete dialer DNC list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistCustomexclusioncolumns

      public void deleteOutboundDnclistCustomexclusioncolumns(String dncListId, Boolean expiredOnly) throws IOException, ApiException
      Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistCustomexclusioncolumnsWithHttpInfo

      public ApiResponse<Void> deleteOutboundDnclistCustomexclusioncolumnsWithHttpInfo(String dncListId, Boolean expiredOnly) throws IOException
      Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistCustomexclusioncolumns

      public void deleteOutboundDnclistCustomexclusioncolumns(DeleteOutboundDnclistCustomexclusioncolumnsRequest request) throws IOException, ApiException
      Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistCustomexclusioncolumns

      public ApiResponse<Void> deleteOutboundDnclistCustomexclusioncolumns(ApiRequest<Void> request) throws IOException
      Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistEmailaddresses

      public void deleteOutboundDnclistEmailaddresses(String dncListId, Boolean expiredOnly) throws IOException, ApiException
      Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistEmailaddressesWithHttpInfo

      public ApiResponse<Void> deleteOutboundDnclistEmailaddressesWithHttpInfo(String dncListId, Boolean expiredOnly) throws IOException
      Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistEmailaddresses

      public void deleteOutboundDnclistEmailaddresses(DeleteOutboundDnclistEmailaddressesRequest request) throws IOException, ApiException
      Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistEmailaddresses

      public ApiResponse<Void> deleteOutboundDnclistEmailaddresses(ApiRequest<Void> request) throws IOException
      Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistPhonenumbers

      public void deleteOutboundDnclistPhonenumbers(String dncListId, Boolean expiredOnly) throws IOException, ApiException
      Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistPhonenumbersWithHttpInfo

      public ApiResponse<Void> deleteOutboundDnclistPhonenumbersWithHttpInfo(String dncListId, Boolean expiredOnly) throws IOException
      Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC entries that are expired (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistPhonenumbers

      public void deleteOutboundDnclistPhonenumbers(DeleteOutboundDnclistPhonenumbersRequest request) throws IOException, ApiException
      Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistPhonenumbers

      public ApiResponse<Void> deleteOutboundDnclistPhonenumbers(ApiRequest<Void> request) throws IOException
      Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistWhatsappnumbers

      public void deleteOutboundDnclistWhatsappnumbers(String dncListId, Boolean expiredOnly) throws IOException, ApiException
      Deletes all or expired whatsApp numbers from a DNC list. This operation is only for Internal DNC lists of whatsApp numbers
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC whatsApp numbers that are expired (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistWhatsappnumbersWithHttpInfo

      public ApiResponse<Void> deleteOutboundDnclistWhatsappnumbersWithHttpInfo(String dncListId, Boolean expiredOnly) throws IOException
      Deletes all or expired whatsApp numbers from a DNC list. This operation is only for Internal DNC lists of whatsApp numbers
      Parameters:
      dncListId - DncList ID (required)
      expiredOnly - Set to true to only remove DNC whatsApp numbers that are expired (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundDnclistWhatsappnumbers

      public void deleteOutboundDnclistWhatsappnumbers(DeleteOutboundDnclistWhatsappnumbersRequest request) throws IOException, ApiException
      Deletes all or expired whatsApp numbers from a DNC list. This operation is only for Internal DNC lists of whatsApp numbers
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundDnclistWhatsappnumbers

      public ApiResponse<Void> deleteOutboundDnclistWhatsappnumbers(ApiRequest<Void> request) throws IOException
      Deletes all or expired whatsApp numbers from a DNC list. This operation is only for Internal DNC lists of whatsApp numbers
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplate

      public void deleteOutboundFilespecificationtemplate(String fileSpecificationTemplateId) throws IOException, ApiException
      Delete File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplateWithHttpInfo

      public ApiResponse<Void> deleteOutboundFilespecificationtemplateWithHttpInfo(String fileSpecificationTemplateId) throws IOException
      Delete File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplate

      public void deleteOutboundFilespecificationtemplate(DeleteOutboundFilespecificationtemplateRequest request) throws IOException, ApiException
      Delete File Specification Template
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplate

      public ApiResponse<Void> deleteOutboundFilespecificationtemplate(ApiRequest<Void> request) throws IOException
      Delete File Specification Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplatesBulk

      public void deleteOutboundFilespecificationtemplatesBulk(List<String> id) throws IOException, ApiException
      Delete multiple file specification templates.
      Parameters:
      id - File Specification template id(s) to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplatesBulkWithHttpInfo

      public ApiResponse<Void> deleteOutboundFilespecificationtemplatesBulkWithHttpInfo(List<String> id) throws IOException
      Delete multiple file specification templates.
      Parameters:
      id - File Specification template id(s) to delete (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplatesBulk

      public void deleteOutboundFilespecificationtemplatesBulk(DeleteOutboundFilespecificationtemplatesBulkRequest request) throws IOException, ApiException
      Delete multiple file specification templates.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundFilespecificationtemplatesBulk

      public ApiResponse<Void> deleteOutboundFilespecificationtemplatesBulk(ApiRequest<Void> request) throws IOException
      Delete multiple file specification templates.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplate

      public void deleteOutboundImporttemplate(String importTemplateId) throws IOException, ApiException
      Delete Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplateWithHttpInfo

      public ApiResponse<Void> deleteOutboundImporttemplateWithHttpInfo(String importTemplateId) throws IOException
      Delete Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplate

      public void deleteOutboundImporttemplate(DeleteOutboundImporttemplateRequest request) throws IOException, ApiException
      Delete Import Template
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplate

      public ApiResponse<Void> deleteOutboundImporttemplate(ApiRequest<Void> request) throws IOException
      Delete Import Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplates

      public void deleteOutboundImporttemplates(List<String> id) throws IOException, ApiException
      Delete multiple import templates.
      Parameters:
      id - import template id(s) to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplatesWithHttpInfo

      public ApiResponse<Void> deleteOutboundImporttemplatesWithHttpInfo(List<String> id) throws IOException
      Delete multiple import templates.
      Parameters:
      id - import template id(s) to delete (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplates

      public void deleteOutboundImporttemplates(DeleteOutboundImporttemplatesRequest request) throws IOException, ApiException
      Delete multiple import templates.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundImporttemplates

      public ApiResponse<Void> deleteOutboundImporttemplates(ApiRequest<Void> request) throws IOException
      Delete multiple import templates.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaign

      public MessagingCampaign deleteOutboundMessagingcampaign(String messagingCampaignId) throws IOException, ApiException
      Delete an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaignWithHttpInfo

      public ApiResponse<MessagingCampaign> deleteOutboundMessagingcampaignWithHttpInfo(String messagingCampaignId) throws IOException
      Delete an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaign
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaign

      public MessagingCampaign deleteOutboundMessagingcampaign(DeleteOutboundMessagingcampaignRequest request) throws IOException, ApiException
      Delete an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaign

      public ApiResponse<MessagingCampaign> deleteOutboundMessagingcampaign(ApiRequest<Void> request) throws IOException
      Delete an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaignProgress

      public void deleteOutboundMessagingcampaignProgress(String messagingCampaignId) throws IOException, ApiException
      Reset messaging campaign progress and recycle the messaging campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaignProgressWithHttpInfo

      public ApiResponse<Void> deleteOutboundMessagingcampaignProgressWithHttpInfo(String messagingCampaignId) throws IOException
      Reset messaging campaign progress and recycle the messaging campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaignProgress

      public void deleteOutboundMessagingcampaignProgress(DeleteOutboundMessagingcampaignProgressRequest request) throws IOException, ApiException
      Reset messaging campaign progress and recycle the messaging campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundMessagingcampaignProgress

      public ApiResponse<Void> deleteOutboundMessagingcampaignProgress(ApiRequest<Void> request) throws IOException
      Reset messaging campaign progress and recycle the messaging campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundRuleset

      public void deleteOutboundRuleset(String ruleSetId) throws IOException, ApiException
      Delete a Rule Set.
      Parameters:
      ruleSetId - Rule Set ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundRulesetWithHttpInfo

      public ApiResponse<Void> deleteOutboundRulesetWithHttpInfo(String ruleSetId) throws IOException
      Delete a Rule Set.
      Parameters:
      ruleSetId - Rule Set ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundRuleset

      public void deleteOutboundRuleset(DeleteOutboundRulesetRequest request) throws IOException, ApiException
      Delete a Rule Set.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundRuleset

      public ApiResponse<Void> deleteOutboundRuleset(ApiRequest<Void> request) throws IOException
      Delete a Rule Set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesCampaign

      public void deleteOutboundSchedulesCampaign(String campaignId) throws IOException, ApiException
      Delete a dialer campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesCampaignWithHttpInfo

      public ApiResponse<Void> deleteOutboundSchedulesCampaignWithHttpInfo(String campaignId) throws IOException
      Delete a dialer campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesCampaign

      public void deleteOutboundSchedulesCampaign(DeleteOutboundSchedulesCampaignRequest request) throws IOException, ApiException
      Delete a dialer campaign schedule.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesCampaign

      public ApiResponse<Void> deleteOutboundSchedulesCampaign(ApiRequest<Void> request) throws IOException
      Delete a dialer campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesEmailcampaign

      public void deleteOutboundSchedulesEmailcampaign(String emailCampaignId) throws IOException, ApiException
      Delete an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesEmailcampaignWithHttpInfo

      public ApiResponse<Void> deleteOutboundSchedulesEmailcampaignWithHttpInfo(String emailCampaignId) throws IOException
      Delete an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesEmailcampaign

      public void deleteOutboundSchedulesEmailcampaign(DeleteOutboundSchedulesEmailcampaignRequest request) throws IOException, ApiException
      Delete an email campaign schedule.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesEmailcampaign

      public ApiResponse<Void> deleteOutboundSchedulesEmailcampaign(ApiRequest<Void> request) throws IOException
      Delete an email campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesMessagingcampaign

      public void deleteOutboundSchedulesMessagingcampaign(String messagingCampaignId) throws IOException, ApiException
      Delete a messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesMessagingcampaignWithHttpInfo

      public ApiResponse<Void> deleteOutboundSchedulesMessagingcampaignWithHttpInfo(String messagingCampaignId) throws IOException
      Delete a messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesMessagingcampaign

      public void deleteOutboundSchedulesMessagingcampaign(DeleteOutboundSchedulesMessagingcampaignRequest request) throws IOException, ApiException
      Delete a messaging campaign schedule.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesMessagingcampaign

      public ApiResponse<Void> deleteOutboundSchedulesMessagingcampaign(ApiRequest<Void> request) throws IOException
      Delete a messaging campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesSequence

      public void deleteOutboundSchedulesSequence(String sequenceId) throws IOException, ApiException
      Delete a dialer sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesSequenceWithHttpInfo

      public ApiResponse<Void> deleteOutboundSchedulesSequenceWithHttpInfo(String sequenceId) throws IOException
      Delete a dialer sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesSequence

      public void deleteOutboundSchedulesSequence(DeleteOutboundSchedulesSequenceRequest request) throws IOException, ApiException
      Delete a dialer sequence schedule.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesSequence

      public ApiResponse<Void> deleteOutboundSchedulesSequence(ApiRequest<Void> request) throws IOException
      Delete a dialer sequence schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesWhatsappcampaign

      public void deleteOutboundSchedulesWhatsappcampaign(String whatsAppCampaignId) throws IOException, ApiException
      Delete a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesWhatsappcampaignWithHttpInfo

      public ApiResponse<Void> deleteOutboundSchedulesWhatsappcampaignWithHttpInfo(String whatsAppCampaignId) throws IOException
      Delete a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesWhatsappcampaign

      public void deleteOutboundSchedulesWhatsappcampaign(DeleteOutboundSchedulesWhatsappcampaignRequest request) throws IOException, ApiException
      Delete a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSchedulesWhatsappcampaign

      public ApiResponse<Void> deleteOutboundSchedulesWhatsappcampaign(ApiRequest<Void> request) throws IOException
      Delete a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSequence

      public void deleteOutboundSequence(String sequenceId) throws IOException, ApiException
      Delete a dialer campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSequenceWithHttpInfo

      public ApiResponse<Void> deleteOutboundSequenceWithHttpInfo(String sequenceId) throws IOException
      Delete a dialer campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteOutboundSequence

      public void deleteOutboundSequence(DeleteOutboundSequenceRequest request) throws IOException, ApiException
      Delete a dialer campaign sequence.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteOutboundSequence

      public ApiResponse<Void> deleteOutboundSequence(ApiRequest<Void> request) throws IOException
      Delete a dialer campaign sequence.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundAttemptlimit

      public AttemptLimits getOutboundAttemptlimit(String attemptLimitsId) throws IOException, ApiException
      Get attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundAttemptlimitWithHttpInfo

      public ApiResponse<AttemptLimits> getOutboundAttemptlimitWithHttpInfo(String attemptLimitsId) throws IOException
      Get attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      Returns:
      AttemptLimits
      Throws:
      IOException - if the request fails to be processed
    • getOutboundAttemptlimit

      public AttemptLimits getOutboundAttemptlimit(GetOutboundAttemptlimitRequest request) throws IOException, ApiException
      Get attempt limits
      Parameters:
      request - The request object
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundAttemptlimit

      public ApiResponse<AttemptLimits> getOutboundAttemptlimit(ApiRequest<Void> request) throws IOException
      Get attempt limits
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundAttemptlimits

      public AttemptLimitsEntityListing getOutboundAttemptlimits(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query attempt limits list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      AttemptLimitsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundAttemptlimitsWithHttpInfo

      public ApiResponse<AttemptLimitsEntityListing> getOutboundAttemptlimitsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query attempt limits list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      AttemptLimitsEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundAttemptlimits

      public AttemptLimitsEntityListing getOutboundAttemptlimits(GetOutboundAttemptlimitsRequest request) throws IOException, ApiException
      Query attempt limits list
      Parameters:
      request - The request object
      Returns:
      AttemptLimitsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundAttemptlimits

      public ApiResponse<AttemptLimitsEntityListing> getOutboundAttemptlimits(ApiRequest<Void> request) throws IOException
      Query attempt limits list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallabletimeset

      public CallableTimeSet getOutboundCallabletimeset(String callableTimeSetId) throws IOException, ApiException
      Get callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallabletimesetWithHttpInfo

      public ApiResponse<CallableTimeSet> getOutboundCallabletimesetWithHttpInfo(String callableTimeSetId) throws IOException
      Get callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      Returns:
      CallableTimeSet
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallabletimeset

      public CallableTimeSet getOutboundCallabletimeset(GetOutboundCallabletimesetRequest request) throws IOException, ApiException
      Get callable time set
      Parameters:
      request - The request object
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallabletimeset

      public ApiResponse<CallableTimeSet> getOutboundCallabletimeset(ApiRequest<Void> request) throws IOException
      Get callable time set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallabletimesets

      public CallableTimeSetEntityListing getOutboundCallabletimesets(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query callable time set list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CallableTimeSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallabletimesetsWithHttpInfo

      public ApiResponse<CallableTimeSetEntityListing> getOutboundCallabletimesetsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query callable time set list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CallableTimeSetEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallabletimesets

      public CallableTimeSetEntityListing getOutboundCallabletimesets(GetOutboundCallabletimesetsRequest request) throws IOException, ApiException
      Query callable time set list
      Parameters:
      request - The request object
      Returns:
      CallableTimeSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallabletimesets

      public ApiResponse<CallableTimeSetEntityListing> getOutboundCallabletimesets(ApiRequest<Void> request) throws IOException
      Query callable time set list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponseset

      public ResponseSet getOutboundCallanalysisresponseset(String callAnalysisSetId) throws IOException, ApiException
      Get a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponsesetWithHttpInfo

      public ApiResponse<ResponseSet> getOutboundCallanalysisresponsesetWithHttpInfo(String callAnalysisSetId) throws IOException
      Get a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      Returns:
      ResponseSet
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponseset

      public ResponseSet getOutboundCallanalysisresponseset(GetOutboundCallanalysisresponsesetRequest request) throws IOException, ApiException
      Get a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponseset

      public ApiResponse<ResponseSet> getOutboundCallanalysisresponseset(ApiRequest<Void> request) throws IOException
      Get a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponsesets

      public ResponseSetEntityListing getOutboundCallanalysisresponsesets(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of dialer call analysis response sets.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ResponseSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponsesetsWithHttpInfo

      public ApiResponse<ResponseSetEntityListing> getOutboundCallanalysisresponsesetsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query a list of dialer call analysis response sets.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ResponseSetEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponsesets

      public ResponseSetEntityListing getOutboundCallanalysisresponsesets(GetOutboundCallanalysisresponsesetsRequest request) throws IOException, ApiException
      Query a list of dialer call analysis response sets.
      Parameters:
      request - The request object
      Returns:
      ResponseSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCallanalysisresponsesets

      public ApiResponse<ResponseSetEntityListing> getOutboundCallanalysisresponsesets(ApiRequest<Void> request) throws IOException
      Query a list of dialer call analysis response sets.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaign

      public Campaign getOutboundCampaign(String campaignId) throws IOException, ApiException
      Get dialer campaign.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignWithHttpInfo

      public ApiResponse<Campaign> getOutboundCampaignWithHttpInfo(String campaignId) throws IOException
      Get dialer campaign.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Campaign
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaign

      public Campaign getOutboundCampaign(GetOutboundCampaignRequest request) throws IOException, ApiException
      Get dialer campaign.
      Parameters:
      request - The request object
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaign

      public ApiResponse<Campaign> getOutboundCampaign(ApiRequest<Void> request) throws IOException
      Get dialer campaign.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignAgentownedmappingpreviewResults

      public AgentOwnedMappingPreviewListing getOutboundCampaignAgentownedmappingpreviewResults(String campaignId) throws IOException, ApiException
      Get a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      AgentOwnedMappingPreviewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignAgentownedmappingpreviewResultsWithHttpInfo

      public ApiResponse<AgentOwnedMappingPreviewListing> getOutboundCampaignAgentownedmappingpreviewResultsWithHttpInfo(String campaignId) throws IOException
      Get a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      AgentOwnedMappingPreviewListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignAgentownedmappingpreviewResults

      public AgentOwnedMappingPreviewListing getOutboundCampaignAgentownedmappingpreviewResults(GetOutboundCampaignAgentownedmappingpreviewResultsRequest request) throws IOException, ApiException
      Get a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      request - The request object
      Returns:
      AgentOwnedMappingPreviewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignAgentownedmappingpreviewResults

      public ApiResponse<AgentOwnedMappingPreviewListing> getOutboundCampaignAgentownedmappingpreviewResults(ApiRequest<Void> request) throws IOException
      Get a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignDiagnostics

      public CampaignDiagnostics getOutboundCampaignDiagnostics(String campaignId) throws IOException, ApiException
      Get campaign diagnostics
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignDiagnostics
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignDiagnosticsWithHttpInfo

      public ApiResponse<CampaignDiagnostics> getOutboundCampaignDiagnosticsWithHttpInfo(String campaignId) throws IOException
      Get campaign diagnostics
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignDiagnostics
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignDiagnostics

      public CampaignDiagnostics getOutboundCampaignDiagnostics(GetOutboundCampaignDiagnosticsRequest request) throws IOException, ApiException
      Get campaign diagnostics
      Parameters:
      request - The request object
      Returns:
      CampaignDiagnostics
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignDiagnostics

      public ApiResponse<CampaignDiagnostics> getOutboundCampaignDiagnostics(ApiRequest<Void> request) throws IOException
      Get campaign diagnostics
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignInteractions

      public CampaignInteractions getOutboundCampaignInteractions(String campaignId) throws IOException, ApiException
      Get dialer campaign interactions.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignInteractions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignInteractionsWithHttpInfo

      public ApiResponse<CampaignInteractions> getOutboundCampaignInteractionsWithHttpInfo(String campaignId) throws IOException
      Get dialer campaign interactions.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignInteractions
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignInteractions

      public CampaignInteractions getOutboundCampaignInteractions(GetOutboundCampaignInteractionsRequest request) throws IOException, ApiException
      Get dialer campaign interactions.
      Parameters:
      request - The request object
      Returns:
      CampaignInteractions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignInteractions

      public ApiResponse<CampaignInteractions> getOutboundCampaignInteractions(ApiRequest<Void> request) throws IOException
      Get dialer campaign interactions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignLinedistribution

      public CampaignOutboundLinesDistribution getOutboundCampaignLinedistribution(String campaignId, Boolean includeOnlyActiveCampaigns, String edgeGroupId, String siteId, Boolean useWeight, Integer relativeWeight, Integer outboundLineCount) throws IOException, ApiException
      Get line distribution information for campaigns using same Edge Group or Site as given campaign
      Parameters:
      campaignId - Campaign ID (required)
      includeOnlyActiveCampaigns - If true will return only active Campaigns (optional, default to true)
      edgeGroupId - Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive. (optional)
      siteId - Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive. (optional)
      useWeight - Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations (optional)
      relativeWeight - Relative weight to be used in line distribution calculations instead of current Campaign's relative weight (optional)
      outboundLineCount - The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count (optional)
      Returns:
      CampaignOutboundLinesDistribution
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignLinedistributionWithHttpInfo

      public ApiResponse<CampaignOutboundLinesDistribution> getOutboundCampaignLinedistributionWithHttpInfo(String campaignId, Boolean includeOnlyActiveCampaigns, String edgeGroupId, String siteId, Boolean useWeight, Integer relativeWeight, Integer outboundLineCount) throws IOException
      Get line distribution information for campaigns using same Edge Group or Site as given campaign
      Parameters:
      campaignId - Campaign ID (required)
      includeOnlyActiveCampaigns - If true will return only active Campaigns (optional, default to true)
      edgeGroupId - Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive. (optional)
      siteId - Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive. (optional)
      useWeight - Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations (optional)
      relativeWeight - Relative weight to be used in line distribution calculations instead of current Campaign's relative weight (optional)
      outboundLineCount - The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count (optional)
      Returns:
      CampaignOutboundLinesDistribution
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignLinedistribution

      public CampaignOutboundLinesDistribution getOutboundCampaignLinedistribution(GetOutboundCampaignLinedistributionRequest request) throws IOException, ApiException
      Get line distribution information for campaigns using same Edge Group or Site as given campaign
      Parameters:
      request - The request object
      Returns:
      CampaignOutboundLinesDistribution
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignLinedistribution

      public ApiResponse<CampaignOutboundLinesDistribution> getOutboundCampaignLinedistribution(ApiRequest<Void> request) throws IOException
      Get line distribution information for campaigns using same Edge Group or Site as given campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignProgress

      public CampaignProgress getOutboundCampaignProgress(String campaignId) throws IOException, ApiException
      Get campaign progress
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignProgress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignProgressWithHttpInfo

      public ApiResponse<CampaignProgress> getOutboundCampaignProgressWithHttpInfo(String campaignId) throws IOException
      Get campaign progress
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignProgress
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignProgress

      public CampaignProgress getOutboundCampaignProgress(GetOutboundCampaignProgressRequest request) throws IOException, ApiException
      Get campaign progress
      Parameters:
      request - The request object
      Returns:
      CampaignProgress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignProgress

      public ApiResponse<CampaignProgress> getOutboundCampaignProgress(ApiRequest<Void> request) throws IOException
      Get campaign progress
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignSkillcombinations

      public PagedSkillCombinationListing getOutboundCampaignSkillcombinations(String campaignId, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get the remaining and total contact count for each skill combination in a skills campaign
      Parameters:
      campaignId - Campaign ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      PagedSkillCombinationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignSkillcombinationsWithHttpInfo

      public ApiResponse<PagedSkillCombinationListing> getOutboundCampaignSkillcombinationsWithHttpInfo(String campaignId, Integer pageNumber, Integer pageSize) throws IOException
      Get the remaining and total contact count for each skill combination in a skills campaign
      Parameters:
      campaignId - Campaign ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      PagedSkillCombinationListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignSkillcombinations

      public PagedSkillCombinationListing getOutboundCampaignSkillcombinations(GetOutboundCampaignSkillcombinationsRequest request) throws IOException, ApiException
      Get the remaining and total contact count for each skill combination in a skills campaign
      Parameters:
      request - The request object
      Returns:
      PagedSkillCombinationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignSkillcombinations

      public ApiResponse<PagedSkillCombinationListing> getOutboundCampaignSkillcombinations(ApiRequest<Void> request) throws IOException
      Get the remaining and total contact count for each skill combination in a skills campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignStats

      public CampaignStats getOutboundCampaignStats(String campaignId) throws IOException, ApiException
      Get statistics about a Dialer Campaign
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignStats
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignStatsWithHttpInfo

      public ApiResponse<CampaignStats> getOutboundCampaignStatsWithHttpInfo(String campaignId) throws IOException
      Get statistics about a Dialer Campaign
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignStats
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignStats

      public CampaignStats getOutboundCampaignStats(GetOutboundCampaignStatsRequest request) throws IOException, ApiException
      Get statistics about a Dialer Campaign
      Parameters:
      request - The request object
      Returns:
      CampaignStats
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignStats

      public ApiResponse<CampaignStats> getOutboundCampaignStats(ApiRequest<Void> request) throws IOException
      Get statistics about a Dialer Campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignrule

      public CampaignRule getOutboundCampaignrule(String campaignRuleId) throws IOException, ApiException
      Get Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignruleWithHttpInfo

      public ApiResponse<CampaignRule> getOutboundCampaignruleWithHttpInfo(String campaignRuleId) throws IOException
      Get Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      Returns:
      CampaignRule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignrule

      public CampaignRule getOutboundCampaignrule(GetOutboundCampaignruleRequest request) throws IOException, ApiException
      Get Campaign Rule
      Parameters:
      request - The request object
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignrule

      public ApiResponse<CampaignRule> getOutboundCampaignrule(ApiRequest<Void> request) throws IOException
      Get Campaign Rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignrules

      public CampaignRuleEntityListing getOutboundCampaignrules(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query Campaign Rule list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignRuleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignrulesWithHttpInfo

      public ApiResponse<CampaignRuleEntityListing> getOutboundCampaignrulesWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query Campaign Rule list
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignRuleEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignrules

      public CampaignRuleEntityListing getOutboundCampaignrules(GetOutboundCampaignrulesRequest request) throws IOException, ApiException
      Query Campaign Rule list
      Parameters:
      request - The request object
      Returns:
      CampaignRuleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignrules

      public ApiResponse<CampaignRuleEntityListing> getOutboundCampaignrules(ApiRequest<Void> request) throws IOException
      Query Campaign Rule list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaigns

      public CampaignEntityListing getOutboundCampaigns(Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String contactListId, String dncListIds, String distributionQueueId, String edgeGroupId, String callAnalysisResponseSetId, List<String> divisionId, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of dialer campaigns.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      contactListId - Contact List ID (optional)
      dncListIds - DNC list ID (optional)
      distributionQueueId - Distribution queue ID (optional)
      edgeGroupId - Edge group ID (optional)
      callAnalysisResponseSetId - Call analysis response set ID (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsWithHttpInfo

      public ApiResponse<CampaignEntityListing> getOutboundCampaignsWithHttpInfo(Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String contactListId, String dncListIds, String distributionQueueId, String edgeGroupId, String callAnalysisResponseSetId, List<String> divisionId, String sortBy, String sortOrder) throws IOException
      Query a list of dialer campaigns.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      contactListId - Contact List ID (optional)
      dncListIds - DNC list ID (optional)
      distributionQueueId - Distribution queue ID (optional)
      edgeGroupId - Edge group ID (optional)
      callAnalysisResponseSetId - Call analysis response set ID (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaigns

      public CampaignEntityListing getOutboundCampaigns(GetOutboundCampaignsRequest request) throws IOException, ApiException
      Query a list of dialer campaigns.
      Parameters:
      request - The request object
      Returns:
      CampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaigns

      public ApiResponse<CampaignEntityListing> getOutboundCampaigns(ApiRequest<Void> request) throws IOException
      Query a list of dialer campaigns.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsAll

      public CommonCampaignEntityListing getOutboundCampaignsAll(Integer pageSize, Integer pageNumber, List<String> id, String name, List<String> divisionId, List<String> mediaType, String sortOrder) throws IOException, ApiException
      Query across all types of campaigns by division
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - Campaign ID(s) (optional)
      name - Campaign name(s) (optional)
      divisionId - Division ID(s) (optional)
      mediaType - Media type(s) (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CommonCampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsAllWithHttpInfo

      public ApiResponse<CommonCampaignEntityListing> getOutboundCampaignsAllWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, String name, List<String> divisionId, List<String> mediaType, String sortOrder) throws IOException
      Query across all types of campaigns by division
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - Campaign ID(s) (optional)
      name - Campaign name(s) (optional)
      divisionId - Division ID(s) (optional)
      mediaType - Media type(s) (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CommonCampaignEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsAll

      public CommonCampaignEntityListing getOutboundCampaignsAll(GetOutboundCampaignsAllRequest request) throws IOException, ApiException
      Query across all types of campaigns by division
      Parameters:
      request - The request object
      Returns:
      CommonCampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsAll

      public ApiResponse<CommonCampaignEntityListing> getOutboundCampaignsAll(ApiRequest<Void> request) throws IOException
      Query across all types of campaigns by division
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsAllDivisionviews

      public CommonCampaignDivisionViewEntityListing getOutboundCampaignsAllDivisionviews(Integer pageSize, Integer pageNumber, List<String> id, String name, List<String> divisionId, List<String> mediaType, String sortOrder) throws IOException, ApiException
      Query across all types of campaigns
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - Campaign ID(s) (optional)
      name - Campaign name(s) (optional)
      divisionId - Division ID(s) (optional)
      mediaType - Media type(s) (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CommonCampaignDivisionViewEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsAllDivisionviewsWithHttpInfo

      public ApiResponse<CommonCampaignDivisionViewEntityListing> getOutboundCampaignsAllDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, String name, List<String> divisionId, List<String> mediaType, String sortOrder) throws IOException
      Query across all types of campaigns
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - Campaign ID(s) (optional)
      name - Campaign name(s) (optional)
      divisionId - Division ID(s) (optional)
      mediaType - Media type(s) (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CommonCampaignDivisionViewEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsAllDivisionviews

      Query across all types of campaigns
      Parameters:
      request - The request object
      Returns:
      CommonCampaignDivisionViewEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsAllDivisionviews

      public ApiResponse<CommonCampaignDivisionViewEntityListing> getOutboundCampaignsAllDivisionviews(ApiRequest<Void> request) throws IOException
      Query across all types of campaigns
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionview

      public CampaignDivisionView getOutboundCampaignsDivisionview(String campaignId) throws IOException, ApiException
      Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionviewWithHttpInfo

      public ApiResponse<CampaignDivisionView> getOutboundCampaignsDivisionviewWithHttpInfo(String campaignId) throws IOException
      Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignDivisionView
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionview

      public CampaignDivisionView getOutboundCampaignsDivisionview(GetOutboundCampaignsDivisionviewRequest request) throws IOException, ApiException
      Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      request - The request object
      Returns:
      CampaignDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionview

      public ApiResponse<CampaignDivisionView> getOutboundCampaignsDivisionview(ApiRequest<Void> request) throws IOException
      Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionviews

      public CampaignDivisionViewListing getOutboundCampaignsDivisionviews(Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionviewsWithHttpInfo

      public ApiResponse<CampaignDivisionViewListing> getOutboundCampaignsDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String sortBy, String sortOrder) throws IOException
      Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignDivisionViewListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionviews

      public CampaignDivisionViewListing getOutboundCampaignsDivisionviews(GetOutboundCampaignsDivisionviewsRequest request) throws IOException, ApiException
      Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      request - The request object
      Returns:
      CampaignDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundCampaignsDivisionviews

      public ApiResponse<CampaignDivisionViewListing> getOutboundCampaignsDivisionviews(ApiRequest<Void> request) throws IOException
      Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlist

      public ContactList getOutboundContactlist(String contactListId, Boolean includeImportStatus, Boolean includeSize) throws IOException, ApiException
      Get a dialer contact list.
      Parameters:
      contactListId - ContactList ID (required)
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistWithHttpInfo

      public ApiResponse<ContactList> getOutboundContactlistWithHttpInfo(String contactListId, Boolean includeImportStatus, Boolean includeSize) throws IOException
      Get a dialer contact list.
      Parameters:
      contactListId - ContactList ID (required)
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      ContactList
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlist

      public ContactList getOutboundContactlist(GetOutboundContactlistRequest request) throws IOException, ApiException
      Get a dialer contact list.
      Parameters:
      request - The request object
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlist

      public ApiResponse<ContactList> getOutboundContactlist(ApiRequest<Void> request) throws IOException
      Get a dialer contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContact

      public DialerContact getOutboundContactlistContact(String contactListId, String contactId) throws IOException, ApiException
      Get a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      Returns:
      DialerContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContactWithHttpInfo

      public ApiResponse<DialerContact> getOutboundContactlistContactWithHttpInfo(String contactListId, String contactId) throws IOException
      Get a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      Returns:
      DialerContact
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContact

      public DialerContact getOutboundContactlistContact(GetOutboundContactlistContactRequest request) throws IOException, ApiException
      Get a contact.
      Parameters:
      request - The request object
      Returns:
      DialerContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContact

      public ApiResponse<DialerContact> getOutboundContactlistContact(ApiRequest<Void> request) throws IOException
      Get a contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJob

      public ContactsBulkOperationJob getOutboundContactlistContactsBulkJob(String contactListId, String jobId) throws IOException, ApiException
      Get bulk operation job.
      Parameters:
      contactListId - Contact List ID (required)
      jobId - Job ID (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJobWithHttpInfo

      public ApiResponse<ContactsBulkOperationJob> getOutboundContactlistContactsBulkJobWithHttpInfo(String contactListId, String jobId) throws IOException
      Get bulk operation job.
      Parameters:
      contactListId - Contact List ID (required)
      jobId - Job ID (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJob

      public ContactsBulkOperationJob getOutboundContactlistContactsBulkJob(GetOutboundContactlistContactsBulkJobRequest request) throws IOException, ApiException
      Get bulk operation job.
      Parameters:
      request - The request object
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJob

      public ApiResponse<ContactsBulkOperationJob> getOutboundContactlistContactsBulkJob(ApiRequest<Void> request) throws IOException
      Get bulk operation job.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJobs

      public ContactsBulkOperationJobListing getOutboundContactlistContactsBulkJobs(String contactListId) throws IOException, ApiException
      Get 10 most recent bulk operation jobs associated with contact list.
      Parameters:
      contactListId - Contact List ID (required)
      Returns:
      ContactsBulkOperationJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJobsWithHttpInfo

      public ApiResponse<ContactsBulkOperationJobListing> getOutboundContactlistContactsBulkJobsWithHttpInfo(String contactListId) throws IOException
      Get 10 most recent bulk operation jobs associated with contact list.
      Parameters:
      contactListId - Contact List ID (required)
      Returns:
      ContactsBulkOperationJobListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJobs

      public ContactsBulkOperationJobListing getOutboundContactlistContactsBulkJobs(GetOutboundContactlistContactsBulkJobsRequest request) throws IOException, ApiException
      Get 10 most recent bulk operation jobs associated with contact list.
      Parameters:
      request - The request object
      Returns:
      ContactsBulkOperationJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistContactsBulkJobs

      public ApiResponse<ContactsBulkOperationJobListing> getOutboundContactlistContactsBulkJobs(ApiRequest<Void> request) throws IOException
      Get 10 most recent bulk operation jobs associated with contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistExport

      public ExportUri getOutboundContactlistExport(String contactListId, String download) throws IOException, ApiException
      Get the URI of a contact list export.
      Parameters:
      contactListId - ContactList ID (required)
      download - Redirect to download uri (optional, default to false)
      Returns:
      ExportUri
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistExportWithHttpInfo

      public ApiResponse<ExportUri> getOutboundContactlistExportWithHttpInfo(String contactListId, String download) throws IOException
      Get the URI of a contact list export.
      Parameters:
      contactListId - ContactList ID (required)
      download - Redirect to download uri (optional, default to false)
      Returns:
      ExportUri
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistExport

      public ExportUri getOutboundContactlistExport(GetOutboundContactlistExportRequest request) throws IOException, ApiException
      Get the URI of a contact list export.
      Parameters:
      request - The request object
      Returns:
      ExportUri
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistExport

      public ApiResponse<ExportUri> getOutboundContactlistExport(ApiRequest<Void> request) throws IOException
      Get the URI of a contact list export.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistImportstatus

      public ImportStatus getOutboundContactlistImportstatus(String contactListId) throws IOException, ApiException
      Get dialer contactList import status.
      Parameters:
      contactListId - ContactList ID (required)
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistImportstatusWithHttpInfo

      public ApiResponse<ImportStatus> getOutboundContactlistImportstatusWithHttpInfo(String contactListId) throws IOException
      Get dialer contactList import status.
      Parameters:
      contactListId - ContactList ID (required)
      Returns:
      ImportStatus
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistImportstatus

      public ImportStatus getOutboundContactlistImportstatus(GetOutboundContactlistImportstatusRequest request) throws IOException, ApiException
      Get dialer contactList import status.
      Parameters:
      request - The request object
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistImportstatus

      public ApiResponse<ImportStatus> getOutboundContactlistImportstatus(ApiRequest<Void> request) throws IOException
      Get dialer contactList import status.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistTimezonemappingpreview

      public TimeZoneMappingPreview getOutboundContactlistTimezonemappingpreview(String contactListId) throws IOException, ApiException
      Preview the result of applying Automatic Time Zone Mapping to a contact list
      Parameters:
      contactListId - ContactList ID (required)
      Returns:
      TimeZoneMappingPreview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistTimezonemappingpreviewWithHttpInfo

      public ApiResponse<TimeZoneMappingPreview> getOutboundContactlistTimezonemappingpreviewWithHttpInfo(String contactListId) throws IOException
      Preview the result of applying Automatic Time Zone Mapping to a contact list
      Parameters:
      contactListId - ContactList ID (required)
      Returns:
      TimeZoneMappingPreview
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistTimezonemappingpreview

      public TimeZoneMappingPreview getOutboundContactlistTimezonemappingpreview(GetOutboundContactlistTimezonemappingpreviewRequest request) throws IOException, ApiException
      Preview the result of applying Automatic Time Zone Mapping to a contact list
      Parameters:
      request - The request object
      Returns:
      TimeZoneMappingPreview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistTimezonemappingpreview

      public ApiResponse<TimeZoneMappingPreview> getOutboundContactlistTimezonemappingpreview(ApiRequest<Void> request) throws IOException
      Preview the result of applying Automatic Time Zone Mapping to a contact list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistfilter

      public ContactListFilter getOutboundContactlistfilter(String contactListFilterId) throws IOException, ApiException
      Get Contact list filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistfilterWithHttpInfo

      public ApiResponse<ContactListFilter> getOutboundContactlistfilterWithHttpInfo(String contactListFilterId) throws IOException
      Get Contact list filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      Returns:
      ContactListFilter
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistfilter

      public ContactListFilter getOutboundContactlistfilter(GetOutboundContactlistfilterRequest request) throws IOException, ApiException
      Get Contact list filter
      Parameters:
      request - The request object
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistfilter

      public ApiResponse<ContactListFilter> getOutboundContactlistfilter(ApiRequest<Void> request) throws IOException
      Get Contact list filter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistfilters

      public ContactListFilterEntityListing getOutboundContactlistfilters(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder, String contactListId) throws IOException, ApiException
      Query Contact list filters
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      contactListId - Contact List ID (optional)
      Returns:
      ContactListFilterEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistfiltersWithHttpInfo

      public ApiResponse<ContactListFilterEntityListing> getOutboundContactlistfiltersWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder, String contactListId) throws IOException
      Query Contact list filters
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      contactListId - Contact List ID (optional)
      Returns:
      ContactListFilterEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistfilters

      public ContactListFilterEntityListing getOutboundContactlistfilters(GetOutboundContactlistfiltersRequest request) throws IOException, ApiException
      Query Contact list filters
      Parameters:
      request - The request object
      Returns:
      ContactListFilterEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistfilters

      public ApiResponse<ContactListFilterEntityListing> getOutboundContactlistfilters(ApiRequest<Void> request) throws IOException
      Query Contact list filters
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlists

      public ContactListEntityListing getOutboundContactlists(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, List<String> id, List<String> divisionId, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of contact lists.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistsWithHttpInfo

      public ApiResponse<ContactListEntityListing> getOutboundContactlistsWithHttpInfo(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, List<String> id, List<String> divisionId, String sortBy, String sortOrder) throws IOException
      Query a list of contact lists.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlists

      public ContactListEntityListing getOutboundContactlists(GetOutboundContactlistsRequest request) throws IOException, ApiException
      Query a list of contact lists.
      Parameters:
      request - The request object
      Returns:
      ContactListEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlists

      public ApiResponse<ContactListEntityListing> getOutboundContactlists(ApiRequest<Void> request) throws IOException
      Query a list of contact lists.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionview

      public ContactListDivisionView getOutboundContactlistsDivisionview(String contactListId, Boolean includeImportStatus, Boolean includeSize) throws IOException, ApiException
      Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      contactListId - Contactlist ID (required)
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      ContactListDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionviewWithHttpInfo

      public ApiResponse<ContactListDivisionView> getOutboundContactlistsDivisionviewWithHttpInfo(String contactListId, Boolean includeImportStatus, Boolean includeSize) throws IOException
      Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      contactListId - Contactlist ID (required)
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      ContactListDivisionView
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionview

      public ContactListDivisionView getOutboundContactlistsDivisionview(GetOutboundContactlistsDivisionviewRequest request) throws IOException, ApiException
      Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      request - The request object
      Returns:
      ContactListDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionview

      public ApiResponse<ContactListDivisionView> getOutboundContactlistsDivisionview(ApiRequest<Void> request) throws IOException
      Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionviews

      public ContactListDivisionViewListing getOutboundContactlistsDivisionviews(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionviewsWithHttpInfo

      public ApiResponse<ContactListDivisionViewListing> getOutboundContactlistsDivisionviewsWithHttpInfo(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, String filterType, String name, List<String> id, String sortBy, String sortOrder) throws IOException
      Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListDivisionViewListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionviews

      public ContactListDivisionViewListing getOutboundContactlistsDivisionviews(GetOutboundContactlistsDivisionviewsRequest request) throws IOException, ApiException
      Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      request - The request object
      Returns:
      ContactListDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlistsDivisionviews

      public ApiResponse<ContactListDivisionViewListing> getOutboundContactlistsDivisionviews(ApiRequest<Void> request) throws IOException
      Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplate

      public ContactListTemplate getOutboundContactlisttemplate(String contactListTemplateId) throws IOException, ApiException
      Get Contact List Template
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplateWithHttpInfo

      public ApiResponse<ContactListTemplate> getOutboundContactlisttemplateWithHttpInfo(String contactListTemplateId) throws IOException
      Get Contact List Template
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      Returns:
      ContactListTemplate
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplate

      public ContactListTemplate getOutboundContactlisttemplate(GetOutboundContactlisttemplateRequest request) throws IOException, ApiException
      Get Contact List Template
      Parameters:
      request - The request object
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplate

      public ApiResponse<ContactListTemplate> getOutboundContactlisttemplate(ApiRequest<Void> request) throws IOException
      Get Contact List Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplates

      public ContactListTemplateEntityListing getOutboundContactlisttemplates(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of contact list templates
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplatesWithHttpInfo

      public ApiResponse<ContactListTemplateEntityListing> getOutboundContactlisttemplatesWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query a list of contact list templates
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplates

      public ContactListTemplateEntityListing getOutboundContactlisttemplates(GetOutboundContactlisttemplatesRequest request) throws IOException, ApiException
      Query a list of contact list templates
      Parameters:
      request - The request object
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundContactlisttemplates

      public ApiResponse<ContactListTemplateEntityListing> getOutboundContactlisttemplates(ApiRequest<Void> request) throws IOException
      Query a list of contact list templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDiagnosticsCampaignSummary

      public CampaignDiagnosticSummary getOutboundDiagnosticsCampaignSummary(String campaignId, String start, String end) throws IOException, ApiException
      Get diagnostic summary for a single campaign
      Parameters:
      campaignId - Campaign ID (required)
      start - Start datetime (ISO 8601 or Unix epoch) (required)
      end - End datetime (ISO 8601 or Unix epoch) (required)
      Returns:
      CampaignDiagnosticSummary
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDiagnosticsCampaignSummaryWithHttpInfo

      public ApiResponse<CampaignDiagnosticSummary> getOutboundDiagnosticsCampaignSummaryWithHttpInfo(String campaignId, String start, String end) throws IOException
      Get diagnostic summary for a single campaign
      Parameters:
      campaignId - Campaign ID (required)
      start - Start datetime (ISO 8601 or Unix epoch) (required)
      end - End datetime (ISO 8601 or Unix epoch) (required)
      Returns:
      CampaignDiagnosticSummary
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDiagnosticsCampaignSummary

      public CampaignDiagnosticSummary getOutboundDiagnosticsCampaignSummary(GetOutboundDiagnosticsCampaignSummaryRequest request) throws IOException, ApiException
      Get diagnostic summary for a single campaign
      Parameters:
      request - The request object
      Returns:
      CampaignDiagnosticSummary
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDiagnosticsCampaignSummary

      public ApiResponse<CampaignDiagnosticSummary> getOutboundDiagnosticsCampaignSummary(ApiRequest<Void> request) throws IOException
      Get diagnostic summary for a single campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDigitalruleset

      public DigitalRuleSet getOutboundDigitalruleset(String digitalRuleSetId) throws IOException, ApiException
      Get an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDigitalrulesetWithHttpInfo

      public ApiResponse<DigitalRuleSet> getOutboundDigitalrulesetWithHttpInfo(String digitalRuleSetId) throws IOException
      Get an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      Returns:
      DigitalRuleSet
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDigitalruleset

      public DigitalRuleSet getOutboundDigitalruleset(GetOutboundDigitalrulesetRequest request) throws IOException, ApiException
      Get an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDigitalruleset

      public ApiResponse<DigitalRuleSet> getOutboundDigitalruleset(ApiRequest<Void> request) throws IOException
      Get an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDigitalrulesets

      public DigitalRuleSetEntityListing getOutboundDigitalrulesets(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id) throws IOException, ApiException
      Query a list of Outbound Digital Rule Sets
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - The field to sort by (optional, default to name)
      sortOrder - The direction to sort (optional, default to ascending)
      name - Name (optional)
      id - A list of digital rule set ids to bulk fetch (optional)
      Returns:
      DigitalRuleSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDigitalrulesetsWithHttpInfo

      public ApiResponse<DigitalRuleSetEntityListing> getOutboundDigitalrulesetsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id) throws IOException
      Query a list of Outbound Digital Rule Sets
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - The field to sort by (optional, default to name)
      sortOrder - The direction to sort (optional, default to ascending)
      name - Name (optional)
      id - A list of digital rule set ids to bulk fetch (optional)
      Returns:
      DigitalRuleSetEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDigitalrulesets

      public DigitalRuleSetEntityListing getOutboundDigitalrulesets(GetOutboundDigitalrulesetsRequest request) throws IOException, ApiException
      Query a list of Outbound Digital Rule Sets
      Parameters:
      request - The request object
      Returns:
      DigitalRuleSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDigitalrulesets

      public ApiResponse<DigitalRuleSetEntityListing> getOutboundDigitalrulesets(ApiRequest<Void> request) throws IOException
      Query a list of Outbound Digital Rule Sets
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclist

      public DncList getOutboundDnclist(String dncListId, Boolean includeImportStatus, Boolean includeSize) throws IOException, ApiException
      Get dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistWithHttpInfo

      public ApiResponse<DncList> getOutboundDnclistWithHttpInfo(String dncListId, Boolean includeImportStatus, Boolean includeSize) throws IOException
      Get dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      DncList
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclist

      public DncList getOutboundDnclist(GetOutboundDnclistRequest request) throws IOException, ApiException
      Get dialer DNC list
      Parameters:
      request - The request object
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclist

      public ApiResponse<DncList> getOutboundDnclist(ApiRequest<Void> request) throws IOException
      Get dialer DNC list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistExport

      public ExportUri getOutboundDnclistExport(String dncListId, String download) throws IOException, ApiException
      Get the URI of a DNC list export.
      Parameters:
      dncListId - DncList ID (required)
      download - Redirect to download uri (optional, default to false)
      Returns:
      ExportUri
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistExportWithHttpInfo

      public ApiResponse<ExportUri> getOutboundDnclistExportWithHttpInfo(String dncListId, String download) throws IOException
      Get the URI of a DNC list export.
      Parameters:
      dncListId - DncList ID (required)
      download - Redirect to download uri (optional, default to false)
      Returns:
      ExportUri
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistExport

      public ExportUri getOutboundDnclistExport(GetOutboundDnclistExportRequest request) throws IOException, ApiException
      Get the URI of a DNC list export.
      Parameters:
      request - The request object
      Returns:
      ExportUri
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistExport

      public ApiResponse<ExportUri> getOutboundDnclistExport(ApiRequest<Void> request) throws IOException
      Get the URI of a DNC list export.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistImportstatus

      public ImportStatus getOutboundDnclistImportstatus(String dncListId) throws IOException, ApiException
      Get dialer dncList import status.
      Parameters:
      dncListId - DncList ID (required)
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistImportstatusWithHttpInfo

      public ApiResponse<ImportStatus> getOutboundDnclistImportstatusWithHttpInfo(String dncListId) throws IOException
      Get dialer dncList import status.
      Parameters:
      dncListId - DncList ID (required)
      Returns:
      ImportStatus
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistImportstatus

      public ImportStatus getOutboundDnclistImportstatus(GetOutboundDnclistImportstatusRequest request) throws IOException, ApiException
      Get dialer dncList import status.
      Parameters:
      request - The request object
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistImportstatus

      public ApiResponse<ImportStatus> getOutboundDnclistImportstatus(ApiRequest<Void> request) throws IOException
      Get dialer dncList import status.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclists

      public DncListEntityListing getOutboundDnclists(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String dncSourceType, List<String> divisionId, String sortBy, String sortOrder) throws IOException, ApiException
      Query dialer DNC lists
      Parameters:
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      dncSourceType - DncSourceType (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional)
      Returns:
      DncListEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistsWithHttpInfo

      public ApiResponse<DncListEntityListing> getOutboundDnclistsWithHttpInfo(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String dncSourceType, List<String> divisionId, String sortBy, String sortOrder) throws IOException
      Query dialer DNC lists
      Parameters:
      includeImportStatus - Import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      dncSourceType - DncSourceType (optional)
      divisionId - Division ID(s) (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional)
      Returns:
      DncListEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclists

      public DncListEntityListing getOutboundDnclists(GetOutboundDnclistsRequest request) throws IOException, ApiException
      Query dialer DNC lists
      Parameters:
      request - The request object
      Returns:
      DncListEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclists

      public ApiResponse<DncListEntityListing> getOutboundDnclists(ApiRequest<Void> request) throws IOException
      Query dialer DNC lists
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionview

      public DncListDivisionView getOutboundDnclistsDivisionview(String dncListId, Boolean includeImportStatus, Boolean includeSize) throws IOException, ApiException
      Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
      Parameters:
      dncListId - Dnclist ID (required)
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      DncListDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionviewWithHttpInfo

      public ApiResponse<DncListDivisionView> getOutboundDnclistsDivisionviewWithHttpInfo(String dncListId, Boolean includeImportStatus, Boolean includeSize) throws IOException
      Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
      Parameters:
      dncListId - Dnclist ID (required)
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      Returns:
      DncListDivisionView
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionview

      public DncListDivisionView getOutboundDnclistsDivisionview(GetOutboundDnclistsDivisionviewRequest request) throws IOException, ApiException
      Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
      Parameters:
      request - The request object
      Returns:
      DncListDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionview

      public ApiResponse<DncListDivisionView> getOutboundDnclistsDivisionview(ApiRequest<Void> request) throws IOException
      Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionviews

      public DncListDivisionViewListing getOutboundDnclistsDivisionviews(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, String filterType, String name, String dncSourceType, List<String> id, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      dncSourceType - DncSourceType (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      DncListDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionviewsWithHttpInfo

      public ApiResponse<DncListDivisionViewListing> getOutboundDnclistsDivisionviewsWithHttpInfo(Boolean includeImportStatus, Boolean includeSize, Integer pageSize, Integer pageNumber, String filterType, String name, String dncSourceType, List<String> id, String sortBy, String sortOrder) throws IOException
      Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
      Parameters:
      includeImportStatus - Include import status (optional, default to false)
      includeSize - Include size (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      dncSourceType - DncSourceType (optional)
      id - id (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      DncListDivisionViewListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionviews

      public DncListDivisionViewListing getOutboundDnclistsDivisionviews(GetOutboundDnclistsDivisionviewsRequest request) throws IOException, ApiException
      Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
      Parameters:
      request - The request object
      Returns:
      DncListDivisionViewListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundDnclistsDivisionviews

      public ApiResponse<DncListDivisionViewListing> getOutboundDnclistsDivisionviews(ApiRequest<Void> request) throws IOException
      Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundEvent

      public EventLog getOutboundEvent(String eventId) throws IOException, ApiException
      Get Dialer Event
      Parameters:
      eventId - Event Log ID (required)
      Returns:
      EventLog
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundEventWithHttpInfo

      public ApiResponse<EventLog> getOutboundEventWithHttpInfo(String eventId) throws IOException
      Get Dialer Event
      Parameters:
      eventId - Event Log ID (required)
      Returns:
      EventLog
      Throws:
      IOException - if the request fails to be processed
    • getOutboundEvent

      public EventLog getOutboundEvent(GetOutboundEventRequest request) throws IOException, ApiException
      Get Dialer Event
      Parameters:
      request - The request object
      Returns:
      EventLog
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundEvent

      public ApiResponse<EventLog> getOutboundEvent(ApiRequest<Void> request) throws IOException
      Get Dialer Event
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundEvents

      public DialerEventEntityListing getOutboundEvents(Integer pageSize, Integer pageNumber, String filterType, String category, String level, String sortBy, String sortOrder) throws IOException, ApiException
      Query Event Logs
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      category - Category (optional)
      level - Level (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      DialerEventEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundEventsWithHttpInfo

      public ApiResponse<DialerEventEntityListing> getOutboundEventsWithHttpInfo(Integer pageSize, Integer pageNumber, String filterType, String category, String level, String sortBy, String sortOrder) throws IOException
      Query Event Logs
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filterType - Filter type (optional, default to Prefix)
      category - Category (optional)
      level - Level (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      DialerEventEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundEvents

      public DialerEventEntityListing getOutboundEvents(GetOutboundEventsRequest request) throws IOException, ApiException
      Query Event Logs
      Parameters:
      request - The request object
      Returns:
      DialerEventEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundEvents

      public ApiResponse<DialerEventEntityListing> getOutboundEvents(ApiRequest<Void> request) throws IOException
      Query Event Logs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplate

      public FileSpecificationTemplate getOutboundFilespecificationtemplate(String fileSpecificationTemplateId) throws IOException, ApiException
      Get File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplateWithHttpInfo

      public ApiResponse<FileSpecificationTemplate> getOutboundFilespecificationtemplateWithHttpInfo(String fileSpecificationTemplateId) throws IOException
      Get File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplate

      public FileSpecificationTemplate getOutboundFilespecificationtemplate(GetOutboundFilespecificationtemplateRequest request) throws IOException, ApiException
      Get File Specification Template
      Parameters:
      request - The request object
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplate

      public ApiResponse<FileSpecificationTemplate> getOutboundFilespecificationtemplate(ApiRequest<Void> request) throws IOException
      Get File Specification Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplates

      public FileSpecificationTemplateEntityListing getOutboundFilespecificationtemplates(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query File Specification Templates
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      FileSpecificationTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplatesWithHttpInfo

      public ApiResponse<FileSpecificationTemplateEntityListing> getOutboundFilespecificationtemplatesWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query File Specification Templates
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      FileSpecificationTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplates

      Query File Specification Templates
      Parameters:
      request - The request object
      Returns:
      FileSpecificationTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundFilespecificationtemplates

      public ApiResponse<FileSpecificationTemplateEntityListing> getOutboundFilespecificationtemplates(ApiRequest<Void> request) throws IOException
      Query File Specification Templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplate

      public ImportTemplate getOutboundImporttemplate(String importTemplateId, Boolean includeImportStatus) throws IOException, ApiException
      Get Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      includeImportStatus - Import status (optional, default to false)
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplateWithHttpInfo

      public ApiResponse<ImportTemplate> getOutboundImporttemplateWithHttpInfo(String importTemplateId, Boolean includeImportStatus) throws IOException
      Get Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      includeImportStatus - Import status (optional, default to false)
      Returns:
      ImportTemplate
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplate

      public ImportTemplate getOutboundImporttemplate(GetOutboundImporttemplateRequest request) throws IOException, ApiException
      Get Import Template
      Parameters:
      request - The request object
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplate

      public ApiResponse<ImportTemplate> getOutboundImporttemplate(ApiRequest<Void> request) throws IOException
      Get Import Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplateImportstatus

      public ImportStatus getOutboundImporttemplateImportstatus(String importTemplateId, String listNamePrefix) throws IOException, ApiException
      Get the import status for an import template.
      Parameters:
      importTemplateId - importTemplateId (required)
      listNamePrefix - listNamePrefix (optional)
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplateImportstatusWithHttpInfo

      public ApiResponse<ImportStatus> getOutboundImporttemplateImportstatusWithHttpInfo(String importTemplateId, String listNamePrefix) throws IOException
      Get the import status for an import template.
      Parameters:
      importTemplateId - importTemplateId (required)
      listNamePrefix - listNamePrefix (optional)
      Returns:
      ImportStatus
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplateImportstatus

      public ImportStatus getOutboundImporttemplateImportstatus(GetOutboundImporttemplateImportstatusRequest request) throws IOException, ApiException
      Get the import status for an import template.
      Parameters:
      request - The request object
      Returns:
      ImportStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplateImportstatus

      public ApiResponse<ImportStatus> getOutboundImporttemplateImportstatus(ApiRequest<Void> request) throws IOException
      Get the import status for an import template.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplates

      public ImportTemplateEntityListing getOutboundImporttemplates(Boolean includeImportStatus, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder, String contactListTemplateId) throws IOException, ApiException
      Query Import Templates
      Parameters:
      includeImportStatus - Import status (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      contactListTemplateId - Contact List Template ID (optional)
      Returns:
      ImportTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplatesWithHttpInfo

      public ApiResponse<ImportTemplateEntityListing> getOutboundImporttemplatesWithHttpInfo(Boolean includeImportStatus, Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder, String contactListTemplateId) throws IOException
      Query Import Templates
      Parameters:
      includeImportStatus - Import status (optional, default to false)
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      contactListTemplateId - Contact List Template ID (optional)
      Returns:
      ImportTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundImporttemplates

      public ImportTemplateEntityListing getOutboundImporttemplates(GetOutboundImporttemplatesRequest request) throws IOException, ApiException
      Query Import Templates
      Parameters:
      request - The request object
      Returns:
      ImportTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundImporttemplates

      public ApiResponse<ImportTemplateEntityListing> getOutboundImporttemplates(ApiRequest<Void> request) throws IOException
      Query Import Templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaign

      public MessagingCampaign getOutboundMessagingcampaign(String messagingCampaignId) throws IOException, ApiException
      Get an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignWithHttpInfo

      public ApiResponse<MessagingCampaign> getOutboundMessagingcampaignWithHttpInfo(String messagingCampaignId) throws IOException
      Get an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaign
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaign

      public MessagingCampaign getOutboundMessagingcampaign(GetOutboundMessagingcampaignRequest request) throws IOException, ApiException
      Get an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaign

      public ApiResponse<MessagingCampaign> getOutboundMessagingcampaign(ApiRequest<Void> request) throws IOException
      Get an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignDiagnostics

      public MessagingCampaignDiagnostics getOutboundMessagingcampaignDiagnostics(String messagingCampaignId) throws IOException, ApiException
      Get messaging campaign diagnostics
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaignDiagnostics
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignDiagnosticsWithHttpInfo

      public ApiResponse<MessagingCampaignDiagnostics> getOutboundMessagingcampaignDiagnosticsWithHttpInfo(String messagingCampaignId) throws IOException
      Get messaging campaign diagnostics
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaignDiagnostics
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignDiagnostics

      public MessagingCampaignDiagnostics getOutboundMessagingcampaignDiagnostics(GetOutboundMessagingcampaignDiagnosticsRequest request) throws IOException, ApiException
      Get messaging campaign diagnostics
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignDiagnostics
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignDiagnostics

      public ApiResponse<MessagingCampaignDiagnostics> getOutboundMessagingcampaignDiagnostics(ApiRequest<Void> request) throws IOException
      Get messaging campaign diagnostics
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignProgress

      public CampaignProgress getOutboundMessagingcampaignProgress(String messagingCampaignId) throws IOException, ApiException
      Get messaging campaign's progress
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      CampaignProgress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignProgressWithHttpInfo

      public ApiResponse<CampaignProgress> getOutboundMessagingcampaignProgressWithHttpInfo(String messagingCampaignId) throws IOException
      Get messaging campaign's progress
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      CampaignProgress
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignProgress

      public CampaignProgress getOutboundMessagingcampaignProgress(GetOutboundMessagingcampaignProgressRequest request) throws IOException, ApiException
      Get messaging campaign's progress
      Parameters:
      request - The request object
      Returns:
      CampaignProgress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignProgress

      public ApiResponse<CampaignProgress> getOutboundMessagingcampaignProgress(ApiRequest<Void> request) throws IOException
      Get messaging campaign's progress
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaigns

      public MessagingCampaignEntityListing getOutboundMessagingcampaigns(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, String contactListId, List<String> divisionId, String type, String senderSmsPhoneNumber, List<String> id, String contentTemplateId, String campaignStatus, List<String> ruleSetIds) throws IOException, ApiException
      Query a list of Messaging Campaigns
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - The field to sort by (optional, default to name)
      sortOrder - The direction to sort (optional, default to ascending)
      name - Name (optional)
      contactListId - Contact List ID (optional)
      divisionId - Division ID(s) (optional)
      type - Campaign Type (optional)
      senderSmsPhoneNumber - Sender SMS Phone Number (optional)
      id - A list of messaging campaign ids to bulk fetch (optional)
      contentTemplateId - Content template ID (optional)
      campaignStatus - Campaign Status (optional)
      ruleSetIds - Ruleset ID(s) (optional)
      Returns:
      MessagingCampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsWithHttpInfo

      public ApiResponse<MessagingCampaignEntityListing> getOutboundMessagingcampaignsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, String contactListId, List<String> divisionId, String type, String senderSmsPhoneNumber, List<String> id, String contentTemplateId, String campaignStatus, List<String> ruleSetIds) throws IOException
      Query a list of Messaging Campaigns
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - The field to sort by (optional, default to name)
      sortOrder - The direction to sort (optional, default to ascending)
      name - Name (optional)
      contactListId - Contact List ID (optional)
      divisionId - Division ID(s) (optional)
      type - Campaign Type (optional)
      senderSmsPhoneNumber - Sender SMS Phone Number (optional)
      id - A list of messaging campaign ids to bulk fetch (optional)
      contentTemplateId - Content template ID (optional)
      campaignStatus - Campaign Status (optional)
      ruleSetIds - Ruleset ID(s) (optional)
      Returns:
      MessagingCampaignEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaigns

      public MessagingCampaignEntityListing getOutboundMessagingcampaigns(GetOutboundMessagingcampaignsRequest request) throws IOException, ApiException
      Query a list of Messaging Campaigns
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaigns

      public ApiResponse<MessagingCampaignEntityListing> getOutboundMessagingcampaigns(ApiRequest<Void> request) throws IOException
      Query a list of Messaging Campaigns
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionview

      public MessagingCampaignDivisionView getOutboundMessagingcampaignsDivisionview(String messagingCampaignId) throws IOException, ApiException
      Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaignDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionviewWithHttpInfo

      public ApiResponse<MessagingCampaignDivisionView> getOutboundMessagingcampaignsDivisionviewWithHttpInfo(String messagingCampaignId) throws IOException
      Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Returns:
      MessagingCampaignDivisionView
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionview

      public MessagingCampaignDivisionView getOutboundMessagingcampaignsDivisionview(GetOutboundMessagingcampaignsDivisionviewRequest request) throws IOException, ApiException
      Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignDivisionView
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionview

      public ApiResponse<MessagingCampaignDivisionView> getOutboundMessagingcampaignsDivisionview(ApiRequest<Void> request) throws IOException
      Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionviews

      public MessagingCampaignDivisionViewEntityListing getOutboundMessagingcampaignsDivisionviews(Integer pageSize, Integer pageNumber, String sortOrder, String name, String type, List<String> id, String senderSmsPhoneNumber, String contentTemplateId, String campaignStatus) throws IOException, ApiException
      Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - The direction to sort (optional, default to a)
      name - Name (optional)
      type - Campaign Type (optional)
      id - id (optional)
      senderSmsPhoneNumber - Sender SMS Phone Number (optional)
      contentTemplateId - Content template ID (optional)
      campaignStatus - Campaign Status (optional)
      Returns:
      MessagingCampaignDivisionViewEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionviewsWithHttpInfo

      public ApiResponse<MessagingCampaignDivisionViewEntityListing> getOutboundMessagingcampaignsDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name, String type, List<String> id, String senderSmsPhoneNumber, String contentTemplateId, String campaignStatus) throws IOException
      Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - The direction to sort (optional, default to a)
      name - Name (optional)
      type - Campaign Type (optional)
      id - id (optional)
      senderSmsPhoneNumber - Sender SMS Phone Number (optional)
      contentTemplateId - Content template ID (optional)
      campaignStatus - Campaign Status (optional)
      Returns:
      MessagingCampaignDivisionViewEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionviews

      Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignDivisionViewEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundMessagingcampaignsDivisionviews

      public ApiResponse<MessagingCampaignDivisionViewEntityListing> getOutboundMessagingcampaignsDivisionviews(ApiRequest<Void> request) throws IOException
      Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundRuleset

      public RuleSet getOutboundRuleset(String ruleSetId) throws IOException, ApiException
      Get a Rule Set by ID.
      Parameters:
      ruleSetId - Rule Set ID (required)
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundRulesetWithHttpInfo

      public ApiResponse<RuleSet> getOutboundRulesetWithHttpInfo(String ruleSetId) throws IOException
      Get a Rule Set by ID.
      Parameters:
      ruleSetId - Rule Set ID (required)
      Returns:
      RuleSet
      Throws:
      IOException - if the request fails to be processed
    • getOutboundRuleset

      public RuleSet getOutboundRuleset(GetOutboundRulesetRequest request) throws IOException, ApiException
      Get a Rule Set by ID.
      Parameters:
      request - The request object
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundRuleset

      public ApiResponse<RuleSet> getOutboundRuleset(ApiRequest<Void> request) throws IOException
      Get a Rule Set by ID.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundRulesets

      public RuleSetEntityListing getOutboundRulesets(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of Rule Sets.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      RuleSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundRulesetsWithHttpInfo

      public ApiResponse<RuleSetEntityListing> getOutboundRulesetsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query a list of Rule Sets.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      RuleSetEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundRulesets

      public RuleSetEntityListing getOutboundRulesets(GetOutboundRulesetsRequest request) throws IOException, ApiException
      Query a list of Rule Sets.
      Parameters:
      request - The request object
      Returns:
      RuleSetEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundRulesets

      public ApiResponse<RuleSetEntityListing> getOutboundRulesets(ApiRequest<Void> request) throws IOException
      Query a list of Rule Sets.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaign

      public CampaignSchedule getOutboundSchedulesCampaign(String campaignId) throws IOException, ApiException
      Get a dialer campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaignWithHttpInfo

      public ApiResponse<CampaignSchedule> getOutboundSchedulesCampaignWithHttpInfo(String campaignId) throws IOException
      Get a dialer campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      CampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaign

      public CampaignSchedule getOutboundSchedulesCampaign(GetOutboundSchedulesCampaignRequest request) throws IOException, ApiException
      Get a dialer campaign schedule.
      Parameters:
      request - The request object
      Returns:
      CampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaign

      public ApiResponse<CampaignSchedule> getOutboundSchedulesCampaign(ApiRequest<Void> request) throws IOException
      Get a dialer campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaigns

      public List<CampaignSchedule> getOutboundSchedulesCampaigns() throws IOException, ApiException
      Query for a list of dialer campaign schedules.
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaignsWithHttpInfo

      public ApiResponse<List<CampaignSchedule>> getOutboundSchedulesCampaignsWithHttpInfo() throws IOException
      Query for a list of dialer campaign schedules.
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaigns

      public List<CampaignSchedule> getOutboundSchedulesCampaigns(GetOutboundSchedulesCampaignsRequest request) throws IOException, ApiException
      Query for a list of dialer campaign schedules.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesCampaigns

      public ApiResponse<List<CampaignSchedule>> getOutboundSchedulesCampaigns(ApiRequest<Void> request) throws IOException
      Query for a list of dialer campaign schedules.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaign

      public EmailCampaignSchedule getOutboundSchedulesEmailcampaign(String emailCampaignId) throws IOException, ApiException
      Get an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      Returns:
      EmailCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaignWithHttpInfo

      public ApiResponse<EmailCampaignSchedule> getOutboundSchedulesEmailcampaignWithHttpInfo(String emailCampaignId) throws IOException
      Get an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      Returns:
      EmailCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaign

      public EmailCampaignSchedule getOutboundSchedulesEmailcampaign(GetOutboundSchedulesEmailcampaignRequest request) throws IOException, ApiException
      Get an email campaign schedule.
      Parameters:
      request - The request object
      Returns:
      EmailCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaign

      public ApiResponse<EmailCampaignSchedule> getOutboundSchedulesEmailcampaign(ApiRequest<Void> request) throws IOException
      Get an email campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaigns

      public EmailCampaignScheduleEntityListing getOutboundSchedulesEmailcampaigns() throws IOException, ApiException
      Query for a list of email campaign schedules.
      Returns:
      EmailCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaignsWithHttpInfo

      public ApiResponse<EmailCampaignScheduleEntityListing> getOutboundSchedulesEmailcampaignsWithHttpInfo() throws IOException
      Query for a list of email campaign schedules.
      Returns:
      EmailCampaignScheduleEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaigns

      Query for a list of email campaign schedules.
      Parameters:
      request - The request object
      Returns:
      EmailCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesEmailcampaigns

      public ApiResponse<EmailCampaignScheduleEntityListing> getOutboundSchedulesEmailcampaigns(ApiRequest<Void> request) throws IOException
      Query for a list of email campaign schedules.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaign

      public MessagingCampaignSchedule getOutboundSchedulesMessagingcampaign(String messagingCampaignId) throws IOException, ApiException
      Get a messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      Returns:
      MessagingCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaignWithHttpInfo

      public ApiResponse<MessagingCampaignSchedule> getOutboundSchedulesMessagingcampaignWithHttpInfo(String messagingCampaignId) throws IOException
      Get a messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      Returns:
      MessagingCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaign

      public MessagingCampaignSchedule getOutboundSchedulesMessagingcampaign(GetOutboundSchedulesMessagingcampaignRequest request) throws IOException, ApiException
      Get a messaging campaign schedule.
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaign

      public ApiResponse<MessagingCampaignSchedule> getOutboundSchedulesMessagingcampaign(ApiRequest<Void> request) throws IOException
      Get a messaging campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaigns

      public MessagingCampaignScheduleEntityListing getOutboundSchedulesMessagingcampaigns() throws IOException, ApiException
      Query for a list of messaging campaign schedules.
      Returns:
      MessagingCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaignsWithHttpInfo

      public ApiResponse<MessagingCampaignScheduleEntityListing> getOutboundSchedulesMessagingcampaignsWithHttpInfo() throws IOException
      Query for a list of messaging campaign schedules.
      Returns:
      MessagingCampaignScheduleEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaigns

      Query for a list of messaging campaign schedules.
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesMessagingcampaigns

      public ApiResponse<MessagingCampaignScheduleEntityListing> getOutboundSchedulesMessagingcampaigns(ApiRequest<Void> request) throws IOException
      Query for a list of messaging campaign schedules.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequence

      public SequenceSchedule getOutboundSchedulesSequence(String sequenceId) throws IOException, ApiException
      Get a dialer sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      Returns:
      SequenceSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequenceWithHttpInfo

      public ApiResponse<SequenceSchedule> getOutboundSchedulesSequenceWithHttpInfo(String sequenceId) throws IOException
      Get a dialer sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      Returns:
      SequenceSchedule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequence

      public SequenceSchedule getOutboundSchedulesSequence(GetOutboundSchedulesSequenceRequest request) throws IOException, ApiException
      Get a dialer sequence schedule.
      Parameters:
      request - The request object
      Returns:
      SequenceSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequence

      public ApiResponse<SequenceSchedule> getOutboundSchedulesSequence(ApiRequest<Void> request) throws IOException
      Get a dialer sequence schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequences

      public List<SequenceSchedule> getOutboundSchedulesSequences() throws IOException, ApiException
      Query for a list of dialer sequence schedules.
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequencesWithHttpInfo

      public ApiResponse<List<SequenceSchedule>> getOutboundSchedulesSequencesWithHttpInfo() throws IOException
      Query for a list of dialer sequence schedules.
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequences

      public List<SequenceSchedule> getOutboundSchedulesSequences(GetOutboundSchedulesSequencesRequest request) throws IOException, ApiException
      Query for a list of dialer sequence schedules.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesSequences

      public ApiResponse<List<SequenceSchedule>> getOutboundSchedulesSequences(ApiRequest<Void> request) throws IOException
      Query for a list of dialer sequence schedules.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaign

      public WhatsAppCampaignSchedule getOutboundSchedulesWhatsappcampaign(String whatsAppCampaignId) throws IOException, ApiException
      Get a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaignWithHttpInfo

      public ApiResponse<WhatsAppCampaignSchedule> getOutboundSchedulesWhatsappcampaignWithHttpInfo(String whatsAppCampaignId) throws IOException
      Get a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaign

      public WhatsAppCampaignSchedule getOutboundSchedulesWhatsappcampaign(GetOutboundSchedulesWhatsappcampaignRequest request) throws IOException, ApiException
      Get a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaign

      public ApiResponse<WhatsAppCampaignSchedule> getOutboundSchedulesWhatsappcampaign(ApiRequest<Void> request) throws IOException
      Get a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaigns

      public WhatsAppCampaignScheduleEntityListing getOutboundSchedulesWhatsappcampaigns() throws IOException, ApiException
      Query for a list of WhatsApp campaign schedules.
      Returns:
      WhatsAppCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaignsWithHttpInfo

      public ApiResponse<WhatsAppCampaignScheduleEntityListing> getOutboundSchedulesWhatsappcampaignsWithHttpInfo() throws IOException
      Query for a list of WhatsApp campaign schedules.
      Returns:
      WhatsAppCampaignScheduleEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaigns

      Query for a list of WhatsApp campaign schedules.
      Parameters:
      request - The request object
      Returns:
      WhatsAppCampaignScheduleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSchedulesWhatsappcampaigns

      public ApiResponse<WhatsAppCampaignScheduleEntityListing> getOutboundSchedulesWhatsappcampaigns(ApiRequest<Void> request) throws IOException
      Query for a list of WhatsApp campaign schedules.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSequence

      public CampaignSequence getOutboundSequence(String sequenceId) throws IOException, ApiException
      Get a dialer campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSequenceWithHttpInfo

      public ApiResponse<CampaignSequence> getOutboundSequenceWithHttpInfo(String sequenceId) throws IOException
      Get a dialer campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      Returns:
      CampaignSequence
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSequence

      public CampaignSequence getOutboundSequence(GetOutboundSequenceRequest request) throws IOException, ApiException
      Get a dialer campaign sequence.
      Parameters:
      request - The request object
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSequence

      public ApiResponse<CampaignSequence> getOutboundSequence(ApiRequest<Void> request) throws IOException
      Get a dialer campaign sequence.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSequences

      public CampaignSequenceEntityListing getOutboundSequences(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException, ApiException
      Query a list of dialer campaign sequences.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignSequenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSequencesWithHttpInfo

      public ApiResponse<CampaignSequenceEntityListing> getOutboundSequencesWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean allowEmptyResult, String filterType, String name, String sortBy, String sortOrder) throws IOException
      Query a list of dialer campaign sequences.
      Parameters:
      pageSize - Page size. The max that will be returned is 100. (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      allowEmptyResult - Whether to return an empty page when there are no results for that page (optional, default to false)
      filterType - Filter type (optional, default to Prefix)
      name - Name (optional)
      sortBy - Sort by (optional)
      sortOrder - Sort order (optional, default to a)
      Returns:
      CampaignSequenceEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSequences

      Query a list of dialer campaign sequences.
      Parameters:
      request - The request object
      Returns:
      CampaignSequenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSequences

      public ApiResponse<CampaignSequenceEntityListing> getOutboundSequences(ApiRequest<Void> request) throws IOException
      Query a list of dialer campaign sequences.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSettings

      public OutboundSettings getOutboundSettings() throws IOException, ApiException
      Get the outbound settings for this organization
      Returns:
      OutboundSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSettingsWithHttpInfo

      public ApiResponse<OutboundSettings> getOutboundSettingsWithHttpInfo() throws IOException
      Get the outbound settings for this organization
      Returns:
      OutboundSettings
      Throws:
      IOException - if the request fails to be processed
    • getOutboundSettings

      public OutboundSettings getOutboundSettings(GetOutboundSettingsRequest request) throws IOException, ApiException
      Get the outbound settings for this organization
      Parameters:
      request - The request object
      Returns:
      OutboundSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundSettings

      public ApiResponse<OutboundSettings> getOutboundSettings(ApiRequest<Void> request) throws IOException
      Get the outbound settings for this organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getOutboundWrapupcodemappings

      public WrapUpCodeMapping getOutboundWrapupcodemappings() throws IOException, ApiException
      Get the Dialer wrap up code mapping.
      Returns:
      WrapUpCodeMapping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundWrapupcodemappingsWithHttpInfo

      public ApiResponse<WrapUpCodeMapping> getOutboundWrapupcodemappingsWithHttpInfo() throws IOException
      Get the Dialer wrap up code mapping.
      Returns:
      WrapUpCodeMapping
      Throws:
      IOException - if the request fails to be processed
    • getOutboundWrapupcodemappings

      public WrapUpCodeMapping getOutboundWrapupcodemappings(GetOutboundWrapupcodemappingsRequest request) throws IOException, ApiException
      Get the Dialer wrap up code mapping.
      Parameters:
      request - The request object
      Returns:
      WrapUpCodeMapping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getOutboundWrapupcodemappings

      public ApiResponse<WrapUpCodeMapping> getOutboundWrapupcodemappings(ApiRequest<Void> request) throws IOException
      Get the Dialer wrap up code mapping.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundCampaign

      public void patchOutboundCampaign(String campaignId, CampaignPatchRequest body) throws IOException, ApiException
      Update a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      body - CampaignPatchRequest (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundCampaignWithHttpInfo

      public ApiResponse<Void> patchOutboundCampaignWithHttpInfo(String campaignId, CampaignPatchRequest body) throws IOException
      Update a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      body - CampaignPatchRequest (required)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundCampaign

      public void patchOutboundCampaign(PatchOutboundCampaignRequest request) throws IOException, ApiException
      Update a campaign.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundCampaign

      public ApiResponse<Void> patchOutboundCampaign(ApiRequest<CampaignPatchRequest> request) throws IOException
      Update a campaign.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistCustomexclusioncolumns

      public void patchOutboundDnclistCustomexclusioncolumns(String dncListId, DncPatchCustomExclusionColumnsRequest body) throws IOException, ApiException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Custom exclusion column entries (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistCustomexclusioncolumnsWithHttpInfo

      public ApiResponse<Void> patchOutboundDnclistCustomexclusioncolumnsWithHttpInfo(String dncListId, DncPatchCustomExclusionColumnsRequest body) throws IOException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Custom exclusion column entries (required)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistCustomexclusioncolumns

      public void patchOutboundDnclistCustomexclusioncolumns(PatchOutboundDnclistCustomexclusioncolumnsRequest request) throws IOException, ApiException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistCustomexclusioncolumns

      public ApiResponse<Void> patchOutboundDnclistCustomexclusioncolumns(ApiRequest<DncPatchCustomExclusionColumnsRequest> request) throws IOException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistEmailaddresses

      public void patchOutboundDnclistEmailaddresses(String dncListId, DncPatchEmailsRequest body) throws IOException, ApiException
      Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Emails (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistEmailaddressesWithHttpInfo

      public ApiResponse<Void> patchOutboundDnclistEmailaddressesWithHttpInfo(String dncListId, DncPatchEmailsRequest body) throws IOException
      Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Emails (required)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistEmailaddresses

      public void patchOutboundDnclistEmailaddresses(PatchOutboundDnclistEmailaddressesRequest request) throws IOException, ApiException
      Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistEmailaddresses

      public ApiResponse<Void> patchOutboundDnclistEmailaddresses(ApiRequest<DncPatchEmailsRequest> request) throws IOException
      Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistPhonenumbers

      public void patchOutboundDnclistPhonenumbers(String dncListId, DncPatchPhoneNumbersRequest body) throws IOException, ApiException
      Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Phone Numbers (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistPhonenumbersWithHttpInfo

      public ApiResponse<Void> patchOutboundDnclistPhonenumbersWithHttpInfo(String dncListId, DncPatchPhoneNumbersRequest body) throws IOException
      Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Phone Numbers (required)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistPhonenumbers

      public void patchOutboundDnclistPhonenumbers(PatchOutboundDnclistPhonenumbersRequest request) throws IOException, ApiException
      Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistPhonenumbers

      public ApiResponse<Void> patchOutboundDnclistPhonenumbers(ApiRequest<DncPatchPhoneNumbersRequest> request) throws IOException
      Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistWhatsappnumbers

      public void patchOutboundDnclistWhatsappnumbers(String dncListId, DncPatchWhatsAppNumbersRequest body) throws IOException, ApiException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC whatsApp numbers (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistWhatsappnumbersWithHttpInfo

      public ApiResponse<Void> patchOutboundDnclistWhatsappnumbersWithHttpInfo(String dncListId, DncPatchWhatsAppNumbersRequest body) throws IOException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      dncListId - DncList ID (required)
      body - DNC whatsApp numbers (required)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundDnclistWhatsappnumbers

      public void patchOutboundDnclistWhatsappnumbers(PatchOutboundDnclistWhatsappnumbersRequest request) throws IOException, ApiException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundDnclistWhatsappnumbers

      public ApiResponse<Void> patchOutboundDnclistWhatsappnumbers(ApiRequest<DncPatchWhatsAppNumbersRequest> request) throws IOException
      Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundSettings

      public void patchOutboundSettings(OutboundSettings body, Boolean useMaxCallsPerAgentDecimal) throws IOException, ApiException
      Update the outbound settings for this organization
      Parameters:
      body - outboundSettings (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundSettingsWithHttpInfo

      public ApiResponse<Void> patchOutboundSettingsWithHttpInfo(OutboundSettings body, Boolean useMaxCallsPerAgentDecimal) throws IOException
      Update the outbound settings for this organization
      Parameters:
      body - outboundSettings (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Throws:
      IOException - if the request fails to be processed
    • patchOutboundSettings

      public void patchOutboundSettings(PatchOutboundSettingsRequest request) throws IOException, ApiException
      Update the outbound settings for this organization
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchOutboundSettings

      public ApiResponse<Void> patchOutboundSettings(ApiRequest<OutboundSettings> request) throws IOException
      Update the outbound settings for this organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundAttemptlimits

      public AttemptLimits postOutboundAttemptlimits(AttemptLimits body) throws IOException, ApiException
      Create attempt limits
      Parameters:
      body - AttemptLimits (required)
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundAttemptlimitsWithHttpInfo

      public ApiResponse<AttemptLimits> postOutboundAttemptlimitsWithHttpInfo(AttemptLimits body) throws IOException
      Create attempt limits
      Parameters:
      body - AttemptLimits (required)
      Returns:
      AttemptLimits
      Throws:
      IOException - if the request fails to be processed
    • postOutboundAttemptlimits

      public AttemptLimits postOutboundAttemptlimits(PostOutboundAttemptlimitsRequest request) throws IOException, ApiException
      Create attempt limits
      Parameters:
      request - The request object
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundAttemptlimits

      public ApiResponse<AttemptLimits> postOutboundAttemptlimits(ApiRequest<AttemptLimits> request) throws IOException
      Create attempt limits
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCallabletimesets

      public CallableTimeSet postOutboundCallabletimesets(CallableTimeSet body) throws IOException, ApiException
      Create callable time set
      Parameters:
      body - DialerCallableTimeSet (required)
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCallabletimesetsWithHttpInfo

      public ApiResponse<CallableTimeSet> postOutboundCallabletimesetsWithHttpInfo(CallableTimeSet body) throws IOException
      Create callable time set
      Parameters:
      body - DialerCallableTimeSet (required)
      Returns:
      CallableTimeSet
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCallabletimesets

      public CallableTimeSet postOutboundCallabletimesets(PostOutboundCallabletimesetsRequest request) throws IOException, ApiException
      Create callable time set
      Parameters:
      request - The request object
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCallabletimesets

      public ApiResponse<CallableTimeSet> postOutboundCallabletimesets(ApiRequest<CallableTimeSet> request) throws IOException
      Create callable time set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCallanalysisresponsesets

      public ResponseSet postOutboundCallanalysisresponsesets(ResponseSet body) throws IOException, ApiException
      Create a dialer call analysis response set.
      Parameters:
      body - ResponseSet (required)
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCallanalysisresponsesetsWithHttpInfo

      public ApiResponse<ResponseSet> postOutboundCallanalysisresponsesetsWithHttpInfo(ResponseSet body) throws IOException
      Create a dialer call analysis response set.
      Parameters:
      body - ResponseSet (required)
      Returns:
      ResponseSet
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCallanalysisresponsesets

      public ResponseSet postOutboundCallanalysisresponsesets(PostOutboundCallanalysisresponsesetsRequest request) throws IOException, ApiException
      Create a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCallanalysisresponsesets

      public ApiResponse<ResponseSet> postOutboundCallanalysisresponsesets(ApiRequest<ResponseSet> request) throws IOException
      Create a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignAgentownedmappingpreview

      public Empty postOutboundCampaignAgentownedmappingpreview(String campaignId) throws IOException, ApiException
      Initiate request for a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignAgentownedmappingpreviewWithHttpInfo

      public ApiResponse<Empty> postOutboundCampaignAgentownedmappingpreviewWithHttpInfo(String campaignId) throws IOException
      Initiate request for a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      campaignId - Campaign ID (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignAgentownedmappingpreview

      public Empty postOutboundCampaignAgentownedmappingpreview(PostOutboundCampaignAgentownedmappingpreviewRequest request) throws IOException, ApiException
      Initiate request for a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignAgentownedmappingpreview

      public ApiResponse<Empty> postOutboundCampaignAgentownedmappingpreview(ApiRequest<Void> request) throws IOException
      Initiate request for a preview of how agents will be mapped to this campaign's contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignCallbackSchedule

      public ContactCallbackRequest postOutboundCampaignCallbackSchedule(String campaignId, ContactCallbackRequest body) throws IOException, ApiException
      Deprecated.
      Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
      Parameters:
      campaignId - Campaign ID (required)
      body - ContactCallbackRequest (required)
      Returns:
      ContactCallbackRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignCallbackScheduleWithHttpInfo

      public ApiResponse<ContactCallbackRequest> postOutboundCampaignCallbackScheduleWithHttpInfo(String campaignId, ContactCallbackRequest body) throws IOException
      Deprecated.
      Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
      Parameters:
      campaignId - Campaign ID (required)
      body - ContactCallbackRequest (required)
      Returns:
      ContactCallbackRequest
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignCallbackSchedule

      public ContactCallbackRequest postOutboundCampaignCallbackSchedule(PostOutboundCampaignCallbackScheduleRequest request) throws IOException, ApiException
      Deprecated.
      Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
      Parameters:
      request - The request object
      Returns:
      ContactCallbackRequest
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignCallbackSchedule

      public ApiResponse<ContactCallbackRequest> postOutboundCampaignCallbackSchedule(ApiRequest<ContactCallbackRequest> request) throws IOException
      Deprecated.
      Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignStart

      public void postOutboundCampaignStart(String campaignId) throws IOException, ApiException
      Start the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignStartWithHttpInfo

      public ApiResponse<Void> postOutboundCampaignStartWithHttpInfo(String campaignId) throws IOException
      Start the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignStart

      public void postOutboundCampaignStart(PostOutboundCampaignStartRequest request) throws IOException, ApiException
      Start the campaign
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignStart

      public ApiResponse<Void> postOutboundCampaignStart(ApiRequest<Void> request) throws IOException
      Start the campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignStop

      public void postOutboundCampaignStop(String campaignId) throws IOException, ApiException
      Stop the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignStopWithHttpInfo

      public ApiResponse<Void> postOutboundCampaignStopWithHttpInfo(String campaignId) throws IOException
      Stop the campaign
      Parameters:
      campaignId - Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignStop

      public void postOutboundCampaignStop(PostOutboundCampaignStopRequest request) throws IOException, ApiException
      Stop the campaign
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignStop

      public ApiResponse<Void> postOutboundCampaignStop(ApiRequest<Void> request) throws IOException
      Stop the campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignrules

      public CampaignRule postOutboundCampaignrules(CampaignRule body) throws IOException, ApiException
      Create Campaign Rule
      Parameters:
      body - CampaignRule (required)
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignrulesWithHttpInfo

      public ApiResponse<CampaignRule> postOutboundCampaignrulesWithHttpInfo(CampaignRule body) throws IOException
      Create Campaign Rule
      Parameters:
      body - CampaignRule (required)
      Returns:
      CampaignRule
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignrules

      public CampaignRule postOutboundCampaignrules(PostOutboundCampaignrulesRequest request) throws IOException, ApiException
      Create Campaign Rule
      Parameters:
      request - The request object
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignrules

      public ApiResponse<CampaignRule> postOutboundCampaignrules(ApiRequest<CampaignRule> request) throws IOException
      Create Campaign Rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaigns

      public Campaign postOutboundCampaigns(Campaign body, Boolean useMaxCallsPerAgentDecimal) throws IOException, ApiException
      Create a campaign.
      Parameters:
      body - Campaign (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignsWithHttpInfo

      public ApiResponse<Campaign> postOutboundCampaignsWithHttpInfo(Campaign body, Boolean useMaxCallsPerAgentDecimal) throws IOException
      Create a campaign.
      Parameters:
      body - Campaign (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Returns:
      Campaign
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaigns

      public Campaign postOutboundCampaigns(PostOutboundCampaignsRequest request) throws IOException, ApiException
      Create a campaign.
      Parameters:
      request - The request object
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaigns

      public ApiResponse<Campaign> postOutboundCampaigns(ApiRequest<Campaign> request) throws IOException
      Create a campaign.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignsPerformanceQuery

      public CampaignPerformanceDataListing postOutboundCampaignsPerformanceQuery(List<String> body) throws IOException, ApiException
      Get performance data for a list of campaigns
      Parameters:
      body - Campaign IDs. Maximum of 50 IDs allowed. (required)
      Returns:
      CampaignPerformanceDataListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignsPerformanceQueryWithHttpInfo

      public ApiResponse<CampaignPerformanceDataListing> postOutboundCampaignsPerformanceQueryWithHttpInfo(List<String> body) throws IOException
      Get performance data for a list of campaigns
      Parameters:
      body - Campaign IDs. Maximum of 50 IDs allowed. (required)
      Returns:
      CampaignPerformanceDataListing
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignsPerformanceQuery

      public CampaignPerformanceDataListing postOutboundCampaignsPerformanceQuery(PostOutboundCampaignsPerformanceQueryRequest request) throws IOException, ApiException
      Get performance data for a list of campaigns
      Parameters:
      request - The request object
      Returns:
      CampaignPerformanceDataListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignsPerformanceQuery

      public ApiResponse<CampaignPerformanceDataListing> postOutboundCampaignsPerformanceQuery(ApiRequest<List<String>> request) throws IOException
      Get performance data for a list of campaigns
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignsProgress

      public List<CampaignProgress> postOutboundCampaignsProgress(List<String> body) throws IOException, ApiException
      Get progress for a list of campaigns
      Parameters:
      body - Campaign IDs (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignsProgressWithHttpInfo

      public ApiResponse<List<CampaignProgress>> postOutboundCampaignsProgressWithHttpInfo(List<String> body) throws IOException
      Get progress for a list of campaigns
      Parameters:
      body - Campaign IDs (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • postOutboundCampaignsProgress

      public List<CampaignProgress> postOutboundCampaignsProgress(PostOutboundCampaignsProgressRequest request) throws IOException, ApiException
      Get progress for a list of campaigns
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundCampaignsProgress

      public ApiResponse<List<CampaignProgress>> postOutboundCampaignsProgress(ApiRequest<List<String>> request) throws IOException
      Get progress for a list of campaigns
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistClear

      public void postOutboundContactlistClear(String contactListId) throws IOException, ApiException
      Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
      Parameters:
      contactListId - Contact List ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistClearWithHttpInfo

      public ApiResponse<Void> postOutboundContactlistClearWithHttpInfo(String contactListId) throws IOException
      Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
      Parameters:
      contactListId - Contact List ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistClear

      public void postOutboundContactlistClear(PostOutboundContactlistClearRequest request) throws IOException, ApiException
      Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistClear

      public ApiResponse<Void> postOutboundContactlistClear(ApiRequest<Void> request) throws IOException
      Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContacts

      public List<DialerContact> postOutboundContactlistContacts(String contactListId, List<WritableDialerContact> body, Boolean priority, Boolean clearSystemData, Boolean doNotQueue) throws IOException, ApiException
      Add contacts to a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact (required)
      priority - Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. (optional)
      clearSystemData - Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. (optional)
      doNotQueue - Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter. (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsWithHttpInfo

      public ApiResponse<List<DialerContact>> postOutboundContactlistContactsWithHttpInfo(String contactListId, List<WritableDialerContact> body, Boolean priority, Boolean clearSystemData, Boolean doNotQueue) throws IOException
      Add contacts to a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact (required)
      priority - Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. (optional)
      clearSystemData - Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. (optional)
      doNotQueue - Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter. (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContacts

      public List<DialerContact> postOutboundContactlistContacts(PostOutboundContactlistContactsRequest request) throws IOException, ApiException
      Add contacts to a contact list.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContacts

      public ApiResponse<List<DialerContact>> postOutboundContactlistContacts(ApiRequest<List<WritableDialerContact>> request) throws IOException
      Add contacts to a contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulk

      public List<DialerContact> postOutboundContactlistContactsBulk(String contactListId, List<String> body) throws IOException, ApiException
      Get contacts from a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - ContactIds to get. (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkWithHttpInfo

      public ApiResponse<List<DialerContact>> postOutboundContactlistContactsBulkWithHttpInfo(String contactListId, List<String> body) throws IOException
      Get contacts from a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - ContactIds to get. (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulk

      public List<DialerContact> postOutboundContactlistContactsBulk(PostOutboundContactlistContactsBulkRequest request) throws IOException, ApiException
      Get contacts from a contact list.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulk

      public ApiResponse<List<DialerContact>> postOutboundContactlistContactsBulk(ApiRequest<List<String>> request) throws IOException
      Get contacts from a contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkRemove

      public ContactsBulkOperationJob postOutboundContactlistContactsBulkRemove(String contactListId, ContactBulkSearchParameters body) throws IOException, ApiException
      Start an async job to delete contacts using a filter.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact filter information. (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkRemoveWithHttpInfo

      public ApiResponse<ContactsBulkOperationJob> postOutboundContactlistContactsBulkRemoveWithHttpInfo(String contactListId, ContactBulkSearchParameters body) throws IOException
      Start an async job to delete contacts using a filter.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact filter information. (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkRemove

      public ContactsBulkOperationJob postOutboundContactlistContactsBulkRemove(PostOutboundContactlistContactsBulkRemoveRequest request) throws IOException, ApiException
      Start an async job to delete contacts using a filter.
      Parameters:
      request - The request object
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkRemove

      public ApiResponse<ContactsBulkOperationJob> postOutboundContactlistContactsBulkRemove(ApiRequest<ContactBulkSearchParameters> request) throws IOException
      Start an async job to delete contacts using a filter.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkUpdate

      public ContactsBulkOperationJob postOutboundContactlistContactsBulkUpdate(String contactListId, ContactBulkEditRequest body) throws IOException, ApiException
      Start an async job to bulk edit contacts.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact bulk edit request information. (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkUpdateWithHttpInfo

      public ApiResponse<ContactsBulkOperationJob> postOutboundContactlistContactsBulkUpdateWithHttpInfo(String contactListId, ContactBulkEditRequest body) throws IOException
      Start an async job to bulk edit contacts.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact bulk edit request information. (required)
      Returns:
      ContactsBulkOperationJob
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkUpdate

      public ContactsBulkOperationJob postOutboundContactlistContactsBulkUpdate(PostOutboundContactlistContactsBulkUpdateRequest request) throws IOException, ApiException
      Start an async job to bulk edit contacts.
      Parameters:
      request - The request object
      Returns:
      ContactsBulkOperationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsBulkUpdate

      public ApiResponse<ContactsBulkOperationJob> postOutboundContactlistContactsBulkUpdate(ApiRequest<ContactBulkEditRequest> request) throws IOException
      Start an async job to bulk edit contacts.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsSearch

      public ContactListingResponse postOutboundContactlistContactsSearch(String contactListId, ContactListingRequest body) throws IOException, ApiException
      Query contacts from a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact search parameters. (required)
      Returns:
      ContactListingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsSearchWithHttpInfo

      public ApiResponse<ContactListingResponse> postOutboundContactlistContactsSearchWithHttpInfo(String contactListId, ContactListingRequest body) throws IOException
      Query contacts from a contact list.
      Parameters:
      contactListId - Contact List ID (required)
      body - Contact search parameters. (required)
      Returns:
      ContactListingResponse
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsSearch

      public ContactListingResponse postOutboundContactlistContactsSearch(PostOutboundContactlistContactsSearchRequest request) throws IOException, ApiException
      Query contacts from a contact list.
      Parameters:
      request - The request object
      Returns:
      ContactListingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistContactsSearch

      public ApiResponse<ContactListingResponse> postOutboundContactlistContactsSearch(ApiRequest<ContactListingRequest> request) throws IOException
      Query contacts from a contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistExport

      public DomainEntityRef postOutboundContactlistExport(String contactListId, ContactsExportRequest body) throws IOException, ApiException
      Initiate the export of a contact list. Returns 200 if received OK.
      Parameters:
      contactListId - ContactList ID (required)
      body - Export information to get (optional)
      Returns:
      DomainEntityRef
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistExportWithHttpInfo

      public ApiResponse<DomainEntityRef> postOutboundContactlistExportWithHttpInfo(String contactListId, ContactsExportRequest body) throws IOException
      Initiate the export of a contact list. Returns 200 if received OK.
      Parameters:
      contactListId - ContactList ID (required)
      body - Export information to get (optional)
      Returns:
      DomainEntityRef
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistExport

      public DomainEntityRef postOutboundContactlistExport(PostOutboundContactlistExportRequest request) throws IOException, ApiException
      Initiate the export of a contact list. Returns 200 if received OK.
      Parameters:
      request - The request object
      Returns:
      DomainEntityRef
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistExport

      public ApiResponse<DomainEntityRef> postOutboundContactlistExport(ApiRequest<ContactsExportRequest> request) throws IOException
      Initiate the export of a contact list. Returns 200 if received OK.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfilters

      public ContactListFilter postOutboundContactlistfilters(ContactListFilter body) throws IOException, ApiException
      Create Contact List Filter
      Parameters:
      body - ContactListFilter (required)
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersWithHttpInfo

      public ApiResponse<ContactListFilter> postOutboundContactlistfiltersWithHttpInfo(ContactListFilter body) throws IOException
      Create Contact List Filter
      Parameters:
      body - ContactListFilter (required)
      Returns:
      ContactListFilter
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfilters

      public ContactListFilter postOutboundContactlistfilters(PostOutboundContactlistfiltersRequest request) throws IOException, ApiException
      Create Contact List Filter
      Parameters:
      request - The request object
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfilters

      public ApiResponse<ContactListFilter> postOutboundContactlistfilters(ApiRequest<ContactListFilter> request) throws IOException
      Create Contact List Filter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersBulkRetrieve

      public ContactListFilterEntityListing postOutboundContactlistfiltersBulkRetrieve(ContactListFilterBulkRetrieveBody body) throws IOException, ApiException
      Retrieve multiple contact list filters
      Parameters:
      body - The contact list filters to retrieve (required)
      Returns:
      ContactListFilterEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersBulkRetrieveWithHttpInfo

      public ApiResponse<ContactListFilterEntityListing> postOutboundContactlistfiltersBulkRetrieveWithHttpInfo(ContactListFilterBulkRetrieveBody body) throws IOException
      Retrieve multiple contact list filters
      Parameters:
      body - The contact list filters to retrieve (required)
      Returns:
      ContactListFilterEntityListing
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersBulkRetrieve

      public ContactListFilterEntityListing postOutboundContactlistfiltersBulkRetrieve(PostOutboundContactlistfiltersBulkRetrieveRequest request) throws IOException, ApiException
      Retrieve multiple contact list filters
      Parameters:
      request - The request object
      Returns:
      ContactListFilterEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersBulkRetrieve

      public ApiResponse<ContactListFilterEntityListing> postOutboundContactlistfiltersBulkRetrieve(ApiRequest<ContactListFilterBulkRetrieveBody> request) throws IOException
      Retrieve multiple contact list filters
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersPreview

      public FilterPreviewResponse postOutboundContactlistfiltersPreview(ContactListFilter body) throws IOException, ApiException
      Get a preview of the output of a contact list filter
      Parameters:
      body - ContactListFilter (required)
      Returns:
      FilterPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersPreviewWithHttpInfo

      public ApiResponse<FilterPreviewResponse> postOutboundContactlistfiltersPreviewWithHttpInfo(ContactListFilter body) throws IOException
      Get a preview of the output of a contact list filter
      Parameters:
      body - ContactListFilter (required)
      Returns:
      FilterPreviewResponse
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersPreview

      public FilterPreviewResponse postOutboundContactlistfiltersPreview(PostOutboundContactlistfiltersPreviewRequest request) throws IOException, ApiException
      Get a preview of the output of a contact list filter
      Parameters:
      request - The request object
      Returns:
      FilterPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistfiltersPreview

      public ApiResponse<FilterPreviewResponse> postOutboundContactlistfiltersPreview(ApiRequest<ContactListFilter> request) throws IOException
      Get a preview of the output of a contact list filter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlists

      public ContactList postOutboundContactlists(ContactList body) throws IOException, ApiException
      Create a contact List.
      Parameters:
      body - ContactList (required)
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistsWithHttpInfo

      public ApiResponse<ContactList> postOutboundContactlistsWithHttpInfo(ContactList body) throws IOException
      Create a contact List.
      Parameters:
      body - ContactList (required)
      Returns:
      ContactList
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlists

      public ContactList postOutboundContactlists(PostOutboundContactlistsRequest request) throws IOException, ApiException
      Create a contact List.
      Parameters:
      request - The request object
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlists

      public ApiResponse<ContactList> postOutboundContactlists(ApiRequest<ContactList> request) throws IOException
      Create a contact List.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistsUploads

      public UploadUrlResponse postOutboundContactlistsUploads(ContactListUploadUrlRequest body) throws IOException, ApiException
      Generate presigned upload URL for contact list.
      Parameters:
      body - contactListUploadUrlRequest (required)
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistsUploadsWithHttpInfo

      public ApiResponse<UploadUrlResponse> postOutboundContactlistsUploadsWithHttpInfo(ContactListUploadUrlRequest body) throws IOException
      Generate presigned upload URL for contact list.
      Parameters:
      body - contactListUploadUrlRequest (required)
      Returns:
      UploadUrlResponse
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlistsUploads

      public UploadUrlResponse postOutboundContactlistsUploads(PostOutboundContactlistsUploadsRequest request) throws IOException, ApiException
      Generate presigned upload URL for contact list.
      Parameters:
      request - The request object
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlistsUploads

      public ApiResponse<UploadUrlResponse> postOutboundContactlistsUploads(ApiRequest<ContactListUploadUrlRequest> request) throws IOException
      Generate presigned upload URL for contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplates

      public ContactListTemplate postOutboundContactlisttemplates(ContactListTemplate body) throws IOException, ApiException
      Create Contact List Template
      Parameters:
      body - ContactListTemplate (required)
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesWithHttpInfo

      public ApiResponse<ContactListTemplate> postOutboundContactlisttemplatesWithHttpInfo(ContactListTemplate body) throws IOException
      Create Contact List Template
      Parameters:
      body - ContactListTemplate (required)
      Returns:
      ContactListTemplate
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplates

      public ContactListTemplate postOutboundContactlisttemplates(PostOutboundContactlisttemplatesRequest request) throws IOException, ApiException
      Create Contact List Template
      Parameters:
      request - The request object
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplates

      public ApiResponse<ContactListTemplate> postOutboundContactlisttemplates(ApiRequest<ContactListTemplate> request) throws IOException
      Create Contact List Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkAdd

      public ContactListTemplateEntityListing postOutboundContactlisttemplatesBulkAdd(List<ContactListTemplate> body) throws IOException, ApiException
      Add multiple contact list templates
      Parameters:
      body - contact list template(s) to add (required)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkAddWithHttpInfo

      public ApiResponse<ContactListTemplateEntityListing> postOutboundContactlisttemplatesBulkAddWithHttpInfo(List<ContactListTemplate> body) throws IOException
      Add multiple contact list templates
      Parameters:
      body - contact list template(s) to add (required)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkAdd

      public ContactListTemplateEntityListing postOutboundContactlisttemplatesBulkAdd(PostOutboundContactlisttemplatesBulkAddRequest request) throws IOException, ApiException
      Add multiple contact list templates
      Parameters:
      request - The request object
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkAdd

      public ApiResponse<ContactListTemplateEntityListing> postOutboundContactlisttemplatesBulkAdd(ApiRequest<List<ContactListTemplate>> request) throws IOException
      Add multiple contact list templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkRetrieve

      public ContactListTemplateEntityListing postOutboundContactlisttemplatesBulkRetrieve(ContactListTemplateBulkRetrieveBody body) throws IOException, ApiException
      Get multiple contact list templates
      Parameters:
      body - contact list templates to get (required)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkRetrieveWithHttpInfo

      public ApiResponse<ContactListTemplateEntityListing> postOutboundContactlisttemplatesBulkRetrieveWithHttpInfo(ContactListTemplateBulkRetrieveBody body) throws IOException
      Get multiple contact list templates
      Parameters:
      body - contact list templates to get (required)
      Returns:
      ContactListTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkRetrieve

      public ContactListTemplateEntityListing postOutboundContactlisttemplatesBulkRetrieve(PostOutboundContactlisttemplatesBulkRetrieveRequest request) throws IOException, ApiException
      Get multiple contact list templates
      Parameters:
      request - The request object
      Returns:
      ContactListTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundContactlisttemplatesBulkRetrieve

      public ApiResponse<ContactListTemplateEntityListing> postOutboundContactlisttemplatesBulkRetrieve(ApiRequest<ContactListTemplateBulkRetrieveBody> request) throws IOException
      Get multiple contact list templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundConversationDnc

      public void postOutboundConversationDnc(String conversationId) throws IOException, ApiException
      Add phone numbers to a Dialer DNC list.
      Parameters:
      conversationId - Conversation ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundConversationDncWithHttpInfo

      public ApiResponse<Void> postOutboundConversationDncWithHttpInfo(String conversationId) throws IOException
      Add phone numbers to a Dialer DNC list.
      Parameters:
      conversationId - Conversation ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundConversationDnc

      public void postOutboundConversationDnc(PostOutboundConversationDncRequest request) throws IOException, ApiException
      Add phone numbers to a Dialer DNC list.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundConversationDnc

      public ApiResponse<Void> postOutboundConversationDnc(ApiRequest<Void> request) throws IOException
      Add phone numbers to a Dialer DNC list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDigitalrulesets

      public DigitalRuleSet postOutboundDigitalrulesets(DigitalRuleSet body) throws IOException, ApiException
      Create an Outbound Digital Rule Set
      Parameters:
      body - Digital Rule Set (required)
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDigitalrulesetsWithHttpInfo

      public ApiResponse<DigitalRuleSet> postOutboundDigitalrulesetsWithHttpInfo(DigitalRuleSet body) throws IOException
      Create an Outbound Digital Rule Set
      Parameters:
      body - Digital Rule Set (required)
      Returns:
      DigitalRuleSet
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDigitalrulesets

      public DigitalRuleSet postOutboundDigitalrulesets(PostOutboundDigitalrulesetsRequest request) throws IOException, ApiException
      Create an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDigitalrulesets

      public ApiResponse<DigitalRuleSet> postOutboundDigitalrulesets(ApiRequest<DigitalRuleSet> request) throws IOException
      Create an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistEmailaddresses

      public void postOutboundDnclistEmailaddresses(String dncListId, List<String> body) throws IOException, ApiException
      Add email addresses to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      dncListId - DncList ID (required)
      body - DNC email addresses (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistEmailaddressesWithHttpInfo

      public ApiResponse<Void> postOutboundDnclistEmailaddressesWithHttpInfo(String dncListId, List<String> body) throws IOException
      Add email addresses to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      dncListId - DncList ID (required)
      body - DNC email addresses (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistEmailaddresses

      public void postOutboundDnclistEmailaddresses(PostOutboundDnclistEmailaddressesRequest request) throws IOException, ApiException
      Add email addresses to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistEmailaddresses

      public ApiResponse<Void> postOutboundDnclistEmailaddresses(ApiRequest<List<String>> request) throws IOException
      Add email addresses to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistExport

      public DomainEntityRef postOutboundDnclistExport(String dncListId) throws IOException, ApiException
      Initiate the export of a dnc list. Returns 200 if received OK.
      Parameters:
      dncListId - DncList ID (required)
      Returns:
      DomainEntityRef
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistExportWithHttpInfo

      public ApiResponse<DomainEntityRef> postOutboundDnclistExportWithHttpInfo(String dncListId) throws IOException
      Initiate the export of a dnc list. Returns 200 if received OK.
      Parameters:
      dncListId - DncList ID (required)
      Returns:
      DomainEntityRef
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistExport

      public DomainEntityRef postOutboundDnclistExport(PostOutboundDnclistExportRequest request) throws IOException, ApiException
      Initiate the export of a dnc list. Returns 200 if received OK.
      Parameters:
      request - The request object
      Returns:
      DomainEntityRef
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistExport

      public ApiResponse<DomainEntityRef> postOutboundDnclistExport(ApiRequest<Void> request) throws IOException
      Initiate the export of a dnc list. Returns 200 if received OK.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistPhonenumbers

      public void postOutboundDnclistPhonenumbers(String dncListId, List<String> body, String expirationDateTime) throws IOException, ApiException
      Add phone numbers to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Phone Numbers (required)
      expirationDateTime - Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistPhonenumbersWithHttpInfo

      public ApiResponse<Void> postOutboundDnclistPhonenumbersWithHttpInfo(String dncListId, List<String> body, String expirationDateTime) throws IOException
      Add phone numbers to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      dncListId - DncList ID (required)
      body - DNC Phone Numbers (required)
      expirationDateTime - Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format (optional)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistPhonenumbers

      public void postOutboundDnclistPhonenumbers(PostOutboundDnclistPhonenumbersRequest request) throws IOException, ApiException
      Add phone numbers to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistPhonenumbers

      public ApiResponse<Void> postOutboundDnclistPhonenumbers(ApiRequest<List<String>> request) throws IOException
      Add phone numbers to a DNC list. Only Internal DNC lists may be appended to
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclists

      public DncList postOutboundDnclists(DncListCreate body) throws IOException, ApiException
      Create dialer DNC list
      Parameters:
      body - DncList (required)
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistsWithHttpInfo

      public ApiResponse<DncList> postOutboundDnclistsWithHttpInfo(DncListCreate body) throws IOException
      Create dialer DNC list
      Parameters:
      body - DncList (required)
      Returns:
      DncList
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclists

      public DncList postOutboundDnclists(PostOutboundDnclistsRequest request) throws IOException, ApiException
      Create dialer DNC list
      Parameters:
      request - The request object
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclists

      public ApiResponse<DncList> postOutboundDnclists(ApiRequest<DncListCreate> request) throws IOException
      Create dialer DNC list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistsUploads

      public UploadUrlResponse postOutboundDnclistsUploads(DNCListUploadUrlRequest body) throws IOException, ApiException
      Generate presigned upload URL for dnc list.
      Parameters:
      body - dncListUploadUrlRequest (required)
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistsUploadsWithHttpInfo

      public ApiResponse<UploadUrlResponse> postOutboundDnclistsUploadsWithHttpInfo(DNCListUploadUrlRequest body) throws IOException
      Generate presigned upload URL for dnc list.
      Parameters:
      body - dncListUploadUrlRequest (required)
      Returns:
      UploadUrlResponse
      Throws:
      IOException - if the request fails to be processed
    • postOutboundDnclistsUploads

      public UploadUrlResponse postOutboundDnclistsUploads(PostOutboundDnclistsUploadsRequest request) throws IOException, ApiException
      Generate presigned upload URL for dnc list.
      Parameters:
      request - The request object
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundDnclistsUploads

      public ApiResponse<UploadUrlResponse> postOutboundDnclistsUploads(ApiRequest<DNCListUploadUrlRequest> request) throws IOException
      Generate presigned upload URL for dnc list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundFilespecificationtemplates

      public FileSpecificationTemplate postOutboundFilespecificationtemplates(FileSpecificationTemplate body) throws IOException, ApiException
      Create File Specification Template
      Parameters:
      body - FileSpecificationTemplate (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundFilespecificationtemplatesWithHttpInfo

      public ApiResponse<FileSpecificationTemplate> postOutboundFilespecificationtemplatesWithHttpInfo(FileSpecificationTemplate body) throws IOException
      Create File Specification Template
      Parameters:
      body - FileSpecificationTemplate (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      IOException - if the request fails to be processed
    • postOutboundFilespecificationtemplates

      public FileSpecificationTemplate postOutboundFilespecificationtemplates(PostOutboundFilespecificationtemplatesRequest request) throws IOException, ApiException
      Create File Specification Template
      Parameters:
      request - The request object
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundFilespecificationtemplates

      public ApiResponse<FileSpecificationTemplate> postOutboundFilespecificationtemplates(ApiRequest<FileSpecificationTemplate> request) throws IOException
      Create File Specification Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundImporttemplates

      public ImportTemplate postOutboundImporttemplates(ImportTemplate body) throws IOException, ApiException
      Create Import Template
      Parameters:
      body - ImportTemplate (required)
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundImporttemplatesWithHttpInfo

      public ApiResponse<ImportTemplate> postOutboundImporttemplatesWithHttpInfo(ImportTemplate body) throws IOException
      Create Import Template
      Parameters:
      body - ImportTemplate (required)
      Returns:
      ImportTemplate
      Throws:
      IOException - if the request fails to be processed
    • postOutboundImporttemplates

      public ImportTemplate postOutboundImporttemplates(PostOutboundImporttemplatesRequest request) throws IOException, ApiException
      Create Import Template
      Parameters:
      request - The request object
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundImporttemplates

      public ApiResponse<ImportTemplate> postOutboundImporttemplates(ApiRequest<ImportTemplate> request) throws IOException
      Create Import Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundImporttemplatesBulkAdd

      public ImportTemplateEntityListing postOutboundImporttemplatesBulkAdd(List<ImportTemplate> body) throws IOException, ApiException
      Add multiple import templates
      Parameters:
      body - import template(s) to add (required)
      Returns:
      ImportTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundImporttemplatesBulkAddWithHttpInfo

      public ApiResponse<ImportTemplateEntityListing> postOutboundImporttemplatesBulkAddWithHttpInfo(List<ImportTemplate> body) throws IOException
      Add multiple import templates
      Parameters:
      body - import template(s) to add (required)
      Returns:
      ImportTemplateEntityListing
      Throws:
      IOException - if the request fails to be processed
    • postOutboundImporttemplatesBulkAdd

      public ImportTemplateEntityListing postOutboundImporttemplatesBulkAdd(PostOutboundImporttemplatesBulkAddRequest request) throws IOException, ApiException
      Add multiple import templates
      Parameters:
      request - The request object
      Returns:
      ImportTemplateEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundImporttemplatesBulkAdd

      public ApiResponse<ImportTemplateEntityListing> postOutboundImporttemplatesBulkAdd(ApiRequest<List<ImportTemplate>> request) throws IOException
      Add multiple import templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStart

      public void postOutboundMessagingcampaignStart(String messagingCampaignId) throws IOException, ApiException
      Start the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStartWithHttpInfo

      public ApiResponse<Void> postOutboundMessagingcampaignStartWithHttpInfo(String messagingCampaignId) throws IOException
      Start the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStart

      public void postOutboundMessagingcampaignStart(PostOutboundMessagingcampaignStartRequest request) throws IOException, ApiException
      Start the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStart

      public ApiResponse<Void> postOutboundMessagingcampaignStart(ApiRequest<Void> request) throws IOException
      Start the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStop

      public void postOutboundMessagingcampaignStop(String messagingCampaignId) throws IOException, ApiException
      Stop the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStopWithHttpInfo

      public ApiResponse<Void> postOutboundMessagingcampaignStopWithHttpInfo(String messagingCampaignId) throws IOException
      Stop the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStop

      public void postOutboundMessagingcampaignStop(PostOutboundMessagingcampaignStopRequest request) throws IOException, ApiException
      Stop the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignStop

      public ApiResponse<Void> postOutboundMessagingcampaignStop(ApiRequest<Void> request) throws IOException
      Stop the campaign Documented permissions are applicable based on campaign type.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaigns

      public MessagingCampaign postOutboundMessagingcampaigns(MessagingCampaign body) throws IOException, ApiException
      Create a Messaging Campaign
      Parameters:
      body - Messaging Campaign (required)
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignsWithHttpInfo

      public ApiResponse<MessagingCampaign> postOutboundMessagingcampaignsWithHttpInfo(MessagingCampaign body) throws IOException
      Create a Messaging Campaign
      Parameters:
      body - Messaging Campaign (required)
      Returns:
      MessagingCampaign
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaigns

      public MessagingCampaign postOutboundMessagingcampaigns(PostOutboundMessagingcampaignsRequest request) throws IOException, ApiException
      Create a Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaigns

      public ApiResponse<MessagingCampaign> postOutboundMessagingcampaigns(ApiRequest<MessagingCampaign> request) throws IOException
      Create a Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignsProgress

      public List<CampaignProgress> postOutboundMessagingcampaignsProgress(List<String> body) throws IOException, ApiException
      Get progress for a list of messaging campaigns
      Parameters:
      body - Messaging Campaign IDs (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignsProgressWithHttpInfo

      public ApiResponse<List<CampaignProgress>> postOutboundMessagingcampaignsProgressWithHttpInfo(List<String> body) throws IOException
      Get progress for a list of messaging campaigns
      Parameters:
      body - Messaging Campaign IDs (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignsProgress

      public List<CampaignProgress> postOutboundMessagingcampaignsProgress(PostOutboundMessagingcampaignsProgressRequest request) throws IOException, ApiException
      Get progress for a list of messaging campaigns
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundMessagingcampaignsProgress

      public ApiResponse<List<CampaignProgress>> postOutboundMessagingcampaignsProgress(ApiRequest<List<String>> request) throws IOException
      Get progress for a list of messaging campaigns
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundRulesets

      public RuleSet postOutboundRulesets(RuleSet body) throws IOException, ApiException
      Create a Rule Set.
      Parameters:
      body - RuleSet (required)
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundRulesetsWithHttpInfo

      public ApiResponse<RuleSet> postOutboundRulesetsWithHttpInfo(RuleSet body) throws IOException
      Create a Rule Set.
      Parameters:
      body - RuleSet (required)
      Returns:
      RuleSet
      Throws:
      IOException - if the request fails to be processed
    • postOutboundRulesets

      public RuleSet postOutboundRulesets(PostOutboundRulesetsRequest request) throws IOException, ApiException
      Create a Rule Set.
      Parameters:
      request - The request object
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundRulesets

      public ApiResponse<RuleSet> postOutboundRulesets(ApiRequest<RuleSet> request) throws IOException
      Create a Rule Set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postOutboundSequences

      public CampaignSequence postOutboundSequences(CampaignSequence body) throws IOException, ApiException
      Create a new campaign sequence.
      Parameters:
      body - Organization (required)
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundSequencesWithHttpInfo

      public ApiResponse<CampaignSequence> postOutboundSequencesWithHttpInfo(CampaignSequence body) throws IOException
      Create a new campaign sequence.
      Parameters:
      body - Organization (required)
      Returns:
      CampaignSequence
      Throws:
      IOException - if the request fails to be processed
    • postOutboundSequences

      public CampaignSequence postOutboundSequences(PostOutboundSequencesRequest request) throws IOException, ApiException
      Create a new campaign sequence.
      Parameters:
      request - The request object
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postOutboundSequences

      public ApiResponse<CampaignSequence> postOutboundSequences(ApiRequest<CampaignSequence> request) throws IOException
      Create a new campaign sequence.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundAttemptlimit

      public AttemptLimits putOutboundAttemptlimit(String attemptLimitsId, AttemptLimits body) throws IOException, ApiException
      Update attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      body - AttemptLimits (required)
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundAttemptlimitWithHttpInfo

      public ApiResponse<AttemptLimits> putOutboundAttemptlimitWithHttpInfo(String attemptLimitsId, AttemptLimits body) throws IOException
      Update attempt limits
      Parameters:
      attemptLimitsId - Attempt limits ID (required)
      body - AttemptLimits (required)
      Returns:
      AttemptLimits
      Throws:
      IOException - if the request fails to be processed
    • putOutboundAttemptlimit

      public AttemptLimits putOutboundAttemptlimit(PutOutboundAttemptlimitRequest request) throws IOException, ApiException
      Update attempt limits
      Parameters:
      request - The request object
      Returns:
      AttemptLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundAttemptlimit

      public ApiResponse<AttemptLimits> putOutboundAttemptlimit(ApiRequest<AttemptLimits> request) throws IOException
      Update attempt limits
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCallabletimeset

      public CallableTimeSet putOutboundCallabletimeset(String callableTimeSetId, CallableTimeSet body) throws IOException, ApiException
      Update callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      body - DialerCallableTimeSet (required)
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCallabletimesetWithHttpInfo

      public ApiResponse<CallableTimeSet> putOutboundCallabletimesetWithHttpInfo(String callableTimeSetId, CallableTimeSet body) throws IOException
      Update callable time set
      Parameters:
      callableTimeSetId - Callable Time Set ID (required)
      body - DialerCallableTimeSet (required)
      Returns:
      CallableTimeSet
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCallabletimeset

      public CallableTimeSet putOutboundCallabletimeset(PutOutboundCallabletimesetRequest request) throws IOException, ApiException
      Update callable time set
      Parameters:
      request - The request object
      Returns:
      CallableTimeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCallabletimeset

      public ApiResponse<CallableTimeSet> putOutboundCallabletimeset(ApiRequest<CallableTimeSet> request) throws IOException
      Update callable time set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCallanalysisresponseset

      public ResponseSet putOutboundCallanalysisresponseset(String callAnalysisSetId, ResponseSet body) throws IOException, ApiException
      Update a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      body - ResponseSet (required)
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCallanalysisresponsesetWithHttpInfo

      public ApiResponse<ResponseSet> putOutboundCallanalysisresponsesetWithHttpInfo(String callAnalysisSetId, ResponseSet body) throws IOException
      Update a dialer call analysis response set.
      Parameters:
      callAnalysisSetId - Call Analysis Response Set ID (required)
      body - ResponseSet (required)
      Returns:
      ResponseSet
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCallanalysisresponseset

      public ResponseSet putOutboundCallanalysisresponseset(PutOutboundCallanalysisresponsesetRequest request) throws IOException, ApiException
      Update a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      ResponseSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCallanalysisresponseset

      public ApiResponse<ResponseSet> putOutboundCallanalysisresponseset(ApiRequest<ResponseSet> request) throws IOException
      Update a dialer call analysis response set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaign

      public Campaign putOutboundCampaign(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal) throws IOException, ApiException
      Update a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      body - Campaign (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCampaignWithHttpInfo

      public ApiResponse<Campaign> putOutboundCampaignWithHttpInfo(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal) throws IOException
      Update a campaign.
      Parameters:
      campaignId - Campaign ID (required)
      body - Campaign (required)
      useMaxCallsPerAgentDecimal - Use maxCallsPerAgent with decimal precision (optional)
      Returns:
      Campaign
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaign

      public Campaign putOutboundCampaign(PutOutboundCampaignRequest request) throws IOException, ApiException
      Update a campaign.
      Parameters:
      request - The request object
      Returns:
      Campaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCampaign

      public ApiResponse<Campaign> putOutboundCampaign(ApiRequest<Campaign> request) throws IOException
      Update a campaign.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaignAgent

      public String putOutboundCampaignAgent(String campaignId, String userId, Agent body) throws IOException, ApiException
      Send notification that an agent's state changed New agent state.
      Parameters:
      campaignId - Campaign ID (required)
      userId - Agent's user ID (required)
      body - agent (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCampaignAgentWithHttpInfo

      public ApiResponse<String> putOutboundCampaignAgentWithHttpInfo(String campaignId, String userId, Agent body) throws IOException
      Send notification that an agent's state changed New agent state.
      Parameters:
      campaignId - Campaign ID (required)
      userId - Agent's user ID (required)
      body - agent (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaignAgent

      public String putOutboundCampaignAgent(PutOutboundCampaignAgentRequest request) throws IOException, ApiException
      Send notification that an agent's state changed New agent 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
    • putOutboundCampaignAgent

      public ApiResponse<String> putOutboundCampaignAgent(ApiRequest<Agent> request) throws IOException
      Send notification that an agent's state changed New agent state.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaignrule

      public CampaignRule putOutboundCampaignrule(String campaignRuleId, CampaignRule body) throws IOException, ApiException
      Update Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      body - CampaignRule (required)
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCampaignruleWithHttpInfo

      public ApiResponse<CampaignRule> putOutboundCampaignruleWithHttpInfo(String campaignRuleId, CampaignRule body) throws IOException
      Update Campaign Rule
      Parameters:
      campaignRuleId - Campaign Rule ID (required)
      body - CampaignRule (required)
      Returns:
      CampaignRule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundCampaignrule

      public CampaignRule putOutboundCampaignrule(PutOutboundCampaignruleRequest request) throws IOException, ApiException
      Update Campaign Rule
      Parameters:
      request - The request object
      Returns:
      CampaignRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundCampaignrule

      public ApiResponse<CampaignRule> putOutboundCampaignrule(ApiRequest<CampaignRule> request) throws IOException
      Update Campaign Rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlist

      public ContactList putOutboundContactlist(String contactListId, ContactList body) throws IOException, ApiException
      Update a contact list.
      Parameters:
      contactListId - ContactList ID (required)
      body - ContactList (required)
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlistWithHttpInfo

      public ApiResponse<ContactList> putOutboundContactlistWithHttpInfo(String contactListId, ContactList body) throws IOException
      Update a contact list.
      Parameters:
      contactListId - ContactList ID (required)
      body - ContactList (required)
      Returns:
      ContactList
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlist

      public ContactList putOutboundContactlist(PutOutboundContactlistRequest request) throws IOException, ApiException
      Update a contact list.
      Parameters:
      request - The request object
      Returns:
      ContactList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlist

      public ApiResponse<ContactList> putOutboundContactlist(ApiRequest<ContactList> request) throws IOException
      Update a contact list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlistContact

      public DialerContact putOutboundContactlistContact(String contactListId, String contactId, DialerContact body) throws IOException, ApiException
      Update a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      body - Contact (required)
      Returns:
      DialerContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlistContactWithHttpInfo

      public ApiResponse<DialerContact> putOutboundContactlistContactWithHttpInfo(String contactListId, String contactId, DialerContact body) throws IOException
      Update a contact.
      Parameters:
      contactListId - Contact List ID (required)
      contactId - Contact ID (required)
      body - Contact (required)
      Returns:
      DialerContact
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlistContact

      public DialerContact putOutboundContactlistContact(PutOutboundContactlistContactRequest request) throws IOException, ApiException
      Update a contact.
      Parameters:
      request - The request object
      Returns:
      DialerContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlistContact

      public ApiResponse<DialerContact> putOutboundContactlistContact(ApiRequest<DialerContact> request) throws IOException
      Update a contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlistfilter

      public ContactListFilter putOutboundContactlistfilter(String contactListFilterId, ContactListFilter body) throws IOException, ApiException
      Update Contact List Filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      body - ContactListFilter (required)
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlistfilterWithHttpInfo

      public ApiResponse<ContactListFilter> putOutboundContactlistfilterWithHttpInfo(String contactListFilterId, ContactListFilter body) throws IOException
      Update Contact List Filter
      Parameters:
      contactListFilterId - Contact List Filter ID (required)
      body - ContactListFilter (required)
      Returns:
      ContactListFilter
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlistfilter

      public ContactListFilter putOutboundContactlistfilter(PutOutboundContactlistfilterRequest request) throws IOException, ApiException
      Update Contact List Filter
      Parameters:
      request - The request object
      Returns:
      ContactListFilter
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlistfilter

      public ApiResponse<ContactListFilter> putOutboundContactlistfilter(ApiRequest<ContactListFilter> request) throws IOException
      Update Contact List Filter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlisttemplate

      public ContactListTemplate putOutboundContactlisttemplate(String contactListTemplateId, ContactListTemplate body) throws IOException, ApiException
      Update a contact list template.
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      body - ContactListTemplate (required)
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlisttemplateWithHttpInfo

      public ApiResponse<ContactListTemplate> putOutboundContactlisttemplateWithHttpInfo(String contactListTemplateId, ContactListTemplate body) throws IOException
      Update a contact list template.
      Parameters:
      contactListTemplateId - ContactListTemplate ID (required)
      body - ContactListTemplate (required)
      Returns:
      ContactListTemplate
      Throws:
      IOException - if the request fails to be processed
    • putOutboundContactlisttemplate

      public ContactListTemplate putOutboundContactlisttemplate(PutOutboundContactlisttemplateRequest request) throws IOException, ApiException
      Update a contact list template.
      Parameters:
      request - The request object
      Returns:
      ContactListTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundContactlisttemplate

      public ApiResponse<ContactListTemplate> putOutboundContactlisttemplate(ApiRequest<ContactListTemplate> request) throws IOException
      Update a contact list template.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundDigitalruleset

      public DigitalRuleSet putOutboundDigitalruleset(String digitalRuleSetId, DigitalRuleSet body) throws IOException, ApiException
      Update an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      body - Digital Rule Set (required)
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundDigitalrulesetWithHttpInfo

      public ApiResponse<DigitalRuleSet> putOutboundDigitalrulesetWithHttpInfo(String digitalRuleSetId, DigitalRuleSet body) throws IOException
      Update an Outbound Digital Rule Set
      Parameters:
      digitalRuleSetId - The Digital Rule Set ID (required)
      body - Digital Rule Set (required)
      Returns:
      DigitalRuleSet
      Throws:
      IOException - if the request fails to be processed
    • putOutboundDigitalruleset

      public DigitalRuleSet putOutboundDigitalruleset(PutOutboundDigitalrulesetRequest request) throws IOException, ApiException
      Update an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      DigitalRuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundDigitalruleset

      public ApiResponse<DigitalRuleSet> putOutboundDigitalruleset(ApiRequest<DigitalRuleSet> request) throws IOException
      Update an Outbound Digital Rule Set
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundDnclist

      public DncList putOutboundDnclist(String dncListId, DncList body) throws IOException, ApiException
      Update dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      body - DncList (required)
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundDnclistWithHttpInfo

      public ApiResponse<DncList> putOutboundDnclistWithHttpInfo(String dncListId, DncList body) throws IOException
      Update dialer DNC list
      Parameters:
      dncListId - DncList ID (required)
      body - DncList (required)
      Returns:
      DncList
      Throws:
      IOException - if the request fails to be processed
    • putOutboundDnclist

      public DncList putOutboundDnclist(PutOutboundDnclistRequest request) throws IOException, ApiException
      Update dialer DNC list
      Parameters:
      request - The request object
      Returns:
      DncList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundDnclist

      public ApiResponse<DncList> putOutboundDnclist(ApiRequest<DncList> request) throws IOException
      Update dialer DNC list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundFilespecificationtemplate

      public FileSpecificationTemplate putOutboundFilespecificationtemplate(String fileSpecificationTemplateId, FileSpecificationTemplate body) throws IOException, ApiException
      Update File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      body - fileSpecificationTemplate (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundFilespecificationtemplateWithHttpInfo

      public ApiResponse<FileSpecificationTemplate> putOutboundFilespecificationtemplateWithHttpInfo(String fileSpecificationTemplateId, FileSpecificationTemplate body) throws IOException
      Update File Specification Template
      Parameters:
      fileSpecificationTemplateId - File Specification Template ID (required)
      body - fileSpecificationTemplate (required)
      Returns:
      FileSpecificationTemplate
      Throws:
      IOException - if the request fails to be processed
    • putOutboundFilespecificationtemplate

      public FileSpecificationTemplate putOutboundFilespecificationtemplate(PutOutboundFilespecificationtemplateRequest request) throws IOException, ApiException
      Update File Specification Template
      Parameters:
      request - The request object
      Returns:
      FileSpecificationTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundFilespecificationtemplate

      public ApiResponse<FileSpecificationTemplate> putOutboundFilespecificationtemplate(ApiRequest<FileSpecificationTemplate> request) throws IOException
      Update File Specification Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundImporttemplate

      public ImportTemplate putOutboundImporttemplate(String importTemplateId, ImportTemplate body) throws IOException, ApiException
      Update Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      body - importTemplate (required)
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundImporttemplateWithHttpInfo

      public ApiResponse<ImportTemplate> putOutboundImporttemplateWithHttpInfo(String importTemplateId, ImportTemplate body) throws IOException
      Update Import Template
      Parameters:
      importTemplateId - Import Template ID (required)
      body - importTemplate (required)
      Returns:
      ImportTemplate
      Throws:
      IOException - if the request fails to be processed
    • putOutboundImporttemplate

      public ImportTemplate putOutboundImporttemplate(PutOutboundImporttemplateRequest request) throws IOException, ApiException
      Update Import Template
      Parameters:
      request - The request object
      Returns:
      ImportTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundImporttemplate

      public ApiResponse<ImportTemplate> putOutboundImporttemplate(ApiRequest<ImportTemplate> request) throws IOException
      Update Import Template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundMessagingcampaign

      public MessagingCampaign putOutboundMessagingcampaign(String messagingCampaignId, MessagingCampaign body) throws IOException, ApiException
      Update an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      body - MessagingCampaign (required)
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundMessagingcampaignWithHttpInfo

      public ApiResponse<MessagingCampaign> putOutboundMessagingcampaignWithHttpInfo(String messagingCampaignId, MessagingCampaign body) throws IOException
      Update an Outbound Messaging Campaign
      Parameters:
      messagingCampaignId - The Messaging Campaign ID (required)
      body - MessagingCampaign (required)
      Returns:
      MessagingCampaign
      Throws:
      IOException - if the request fails to be processed
    • putOutboundMessagingcampaign

      public MessagingCampaign putOutboundMessagingcampaign(PutOutboundMessagingcampaignRequest request) throws IOException, ApiException
      Update an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      MessagingCampaign
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundMessagingcampaign

      public ApiResponse<MessagingCampaign> putOutboundMessagingcampaign(ApiRequest<MessagingCampaign> request) throws IOException
      Update an Outbound Messaging Campaign
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundRuleset

      public RuleSet putOutboundRuleset(String ruleSetId, RuleSet body) throws IOException, ApiException
      Update a Rule Set.
      Parameters:
      ruleSetId - Rule Set ID (required)
      body - RuleSet (required)
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundRulesetWithHttpInfo

      public ApiResponse<RuleSet> putOutboundRulesetWithHttpInfo(String ruleSetId, RuleSet body) throws IOException
      Update a Rule Set.
      Parameters:
      ruleSetId - Rule Set ID (required)
      body - RuleSet (required)
      Returns:
      RuleSet
      Throws:
      IOException - if the request fails to be processed
    • putOutboundRuleset

      public RuleSet putOutboundRuleset(PutOutboundRulesetRequest request) throws IOException, ApiException
      Update a Rule Set.
      Parameters:
      request - The request object
      Returns:
      RuleSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundRuleset

      public ApiResponse<RuleSet> putOutboundRuleset(ApiRequest<RuleSet> request) throws IOException
      Update a Rule Set.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesCampaign

      public CampaignSchedule putOutboundSchedulesCampaign(String campaignId, CampaignSchedule body) throws IOException, ApiException
      Update a new campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      body - CampaignSchedule (required)
      Returns:
      CampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesCampaignWithHttpInfo

      public ApiResponse<CampaignSchedule> putOutboundSchedulesCampaignWithHttpInfo(String campaignId, CampaignSchedule body) throws IOException
      Update a new campaign schedule.
      Parameters:
      campaignId - Campaign ID (required)
      body - CampaignSchedule (required)
      Returns:
      CampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesCampaign

      public CampaignSchedule putOutboundSchedulesCampaign(PutOutboundSchedulesCampaignRequest request) throws IOException, ApiException
      Update a new campaign schedule.
      Parameters:
      request - The request object
      Returns:
      CampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesCampaign

      public ApiResponse<CampaignSchedule> putOutboundSchedulesCampaign(ApiRequest<CampaignSchedule> request) throws IOException
      Update a new campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesEmailcampaign

      public EmailCampaignSchedule putOutboundSchedulesEmailcampaign(String emailCampaignId, EmailCampaignSchedule body) throws IOException, ApiException
      Update an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      body - EmailCampaignSchedule (required)
      Returns:
      EmailCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesEmailcampaignWithHttpInfo

      public ApiResponse<EmailCampaignSchedule> putOutboundSchedulesEmailcampaignWithHttpInfo(String emailCampaignId, EmailCampaignSchedule body) throws IOException
      Update an email campaign schedule.
      Parameters:
      emailCampaignId - Email Campaign ID (required)
      body - EmailCampaignSchedule (required)
      Returns:
      EmailCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesEmailcampaign

      public EmailCampaignSchedule putOutboundSchedulesEmailcampaign(PutOutboundSchedulesEmailcampaignRequest request) throws IOException, ApiException
      Update an email campaign schedule.
      Parameters:
      request - The request object
      Returns:
      EmailCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesEmailcampaign

      public ApiResponse<EmailCampaignSchedule> putOutboundSchedulesEmailcampaign(ApiRequest<EmailCampaignSchedule> request) throws IOException
      Update an email campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesMessagingcampaign

      public MessagingCampaignSchedule putOutboundSchedulesMessagingcampaign(String messagingCampaignId, MessagingCampaignSchedule body) throws IOException, ApiException
      Update a new messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      body - MessagingCampaignSchedule (required)
      Returns:
      MessagingCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesMessagingcampaignWithHttpInfo

      public ApiResponse<MessagingCampaignSchedule> putOutboundSchedulesMessagingcampaignWithHttpInfo(String messagingCampaignId, MessagingCampaignSchedule body) throws IOException
      Update a new messaging campaign schedule.
      Parameters:
      messagingCampaignId - Messaging Campaign ID (required)
      body - MessagingCampaignSchedule (required)
      Returns:
      MessagingCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesMessagingcampaign

      public MessagingCampaignSchedule putOutboundSchedulesMessagingcampaign(PutOutboundSchedulesMessagingcampaignRequest request) throws IOException, ApiException
      Update a new messaging campaign schedule.
      Parameters:
      request - The request object
      Returns:
      MessagingCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesMessagingcampaign

      public ApiResponse<MessagingCampaignSchedule> putOutboundSchedulesMessagingcampaign(ApiRequest<MessagingCampaignSchedule> request) throws IOException
      Update a new messaging campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesSequence

      public SequenceSchedule putOutboundSchedulesSequence(String sequenceId, SequenceSchedule body) throws IOException, ApiException
      Update a new sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      body - SequenceSchedule (required)
      Returns:
      SequenceSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesSequenceWithHttpInfo

      public ApiResponse<SequenceSchedule> putOutboundSchedulesSequenceWithHttpInfo(String sequenceId, SequenceSchedule body) throws IOException
      Update a new sequence schedule.
      Parameters:
      sequenceId - Sequence ID (required)
      body - SequenceSchedule (required)
      Returns:
      SequenceSchedule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesSequence

      public SequenceSchedule putOutboundSchedulesSequence(PutOutboundSchedulesSequenceRequest request) throws IOException, ApiException
      Update a new sequence schedule.
      Parameters:
      request - The request object
      Returns:
      SequenceSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesSequence

      public ApiResponse<SequenceSchedule> putOutboundSchedulesSequence(ApiRequest<SequenceSchedule> request) throws IOException
      Update a new sequence schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesWhatsappcampaign

      public WhatsAppCampaignSchedule putOutboundSchedulesWhatsappcampaign(String whatsAppCampaignId, WhatsAppCampaignSchedule body) throws IOException, ApiException
      Update a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      body - WhatsAppCampaignSchedule (required)
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesWhatsappcampaignWithHttpInfo

      public ApiResponse<WhatsAppCampaignSchedule> putOutboundSchedulesWhatsappcampaignWithHttpInfo(String whatsAppCampaignId, WhatsAppCampaignSchedule body) throws IOException
      Update a WhatsApp campaign schedule.
      Parameters:
      whatsAppCampaignId - WhatsApp Campaign ID (required)
      body - WhatsAppCampaignSchedule (required)
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSchedulesWhatsappcampaign

      public WhatsAppCampaignSchedule putOutboundSchedulesWhatsappcampaign(PutOutboundSchedulesWhatsappcampaignRequest request) throws IOException, ApiException
      Update a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Returns:
      WhatsAppCampaignSchedule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSchedulesWhatsappcampaign

      public ApiResponse<WhatsAppCampaignSchedule> putOutboundSchedulesWhatsappcampaign(ApiRequest<WhatsAppCampaignSchedule> request) throws IOException
      Update a WhatsApp campaign schedule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSequence

      public CampaignSequence putOutboundSequence(String sequenceId, CampaignSequence body) throws IOException, ApiException
      Update a new campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      body - Organization (required)
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSequenceWithHttpInfo

      public ApiResponse<CampaignSequence> putOutboundSequenceWithHttpInfo(String sequenceId, CampaignSequence body) throws IOException
      Update a new campaign sequence.
      Parameters:
      sequenceId - Campaign Sequence ID (required)
      body - Organization (required)
      Returns:
      CampaignSequence
      Throws:
      IOException - if the request fails to be processed
    • putOutboundSequence

      public CampaignSequence putOutboundSequence(PutOutboundSequenceRequest request) throws IOException, ApiException
      Update a new campaign sequence.
      Parameters:
      request - The request object
      Returns:
      CampaignSequence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundSequence

      public ApiResponse<CampaignSequence> putOutboundSequence(ApiRequest<CampaignSequence> request) throws IOException
      Update a new campaign sequence.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putOutboundWrapupcodemappings

      public WrapUpCodeMapping putOutboundWrapupcodemappings(WrapUpCodeMapping body) throws IOException, ApiException
      Update the Dialer wrap up code mapping.
      Parameters:
      body - wrapUpCodeMapping (required)
      Returns:
      WrapUpCodeMapping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundWrapupcodemappingsWithHttpInfo

      public ApiResponse<WrapUpCodeMapping> putOutboundWrapupcodemappingsWithHttpInfo(WrapUpCodeMapping body) throws IOException
      Update the Dialer wrap up code mapping.
      Parameters:
      body - wrapUpCodeMapping (required)
      Returns:
      WrapUpCodeMapping
      Throws:
      IOException - if the request fails to be processed
    • putOutboundWrapupcodemappings

      public WrapUpCodeMapping putOutboundWrapupcodemappings(PutOutboundWrapupcodemappingsRequest request) throws IOException, ApiException
      Update the Dialer wrap up code mapping.
      Parameters:
      request - The request object
      Returns:
      WrapUpCodeMapping
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putOutboundWrapupcodemappings

      public ApiResponse<WrapUpCodeMapping> putOutboundWrapupcodemappings(ApiRequest<WrapUpCodeMapping> request) throws IOException
      Update the Dialer wrap up code mapping.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed