Uses of Class
com.mypurecloud.sdk.v2.model.Campaign

Packages that use Campaign

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.api.request
com.mypurecloud.sdk.v2.model

Uses of Campaign in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return Campaign

Modifier and Type	Method	Description
Campaign	OutboundApi.deleteOutboundCampaign(DeleteOutboundCampaignRequest request)	Delete a campaign.
Campaign	OutboundApi.deleteOutboundCampaign(String campaignId)	Delete a campaign.
Campaign	OutboundApi.getOutboundCampaign(GetOutboundCampaignRequest request)	Get dialer campaign.
Campaign	OutboundApi.getOutboundCampaign(String campaignId)	Get dialer campaign.
Campaign	OutboundApi.postOutboundCampaigns(PostOutboundCampaignsRequest request)	Create a campaign.
Campaign	OutboundApi.postOutboundCampaigns(Campaign body, Boolean useMaxCallsPerAgentDecimal)	Create a campaign.
Campaign	OutboundApi.putOutboundCampaign(PutOutboundCampaignRequest request)	Update a campaign.
Campaign	OutboundApi.putOutboundCampaign(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal)	Update a campaign.

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type Campaign

Modifier and Type	Method	Description
ApiResponse<Campaign>	OutboundApi.deleteOutboundCampaign(ApiRequest<Void> request)	Delete a campaign.
Future<Campaign>	OutboundApiAsync.deleteOutboundCampaignAsync(DeleteOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Delete a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.deleteOutboundCampaignAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Delete a campaign.
ApiResponse<Campaign>	OutboundApi.deleteOutboundCampaignWithHttpInfo(String campaignId)	Delete a campaign.
ApiResponse<Campaign>	OutboundApi.getOutboundCampaign(ApiRequest<Void> request)	Get dialer campaign.
Future<Campaign>	OutboundApiAsync.getOutboundCampaignAsync(GetOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Get dialer campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.getOutboundCampaignAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Get dialer campaign.
ApiResponse<Campaign>	OutboundApi.getOutboundCampaignWithHttpInfo(String campaignId)	Get dialer campaign.
ApiResponse<Campaign>	OutboundApi.postOutboundCampaigns(ApiRequest<Campaign> request)	Create a campaign.
Future<Campaign>	OutboundApiAsync.postOutboundCampaignsAsync(PostOutboundCampaignsRequest request, AsyncApiCallback<Campaign> callback)	Create a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.postOutboundCampaignsAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Create a campaign.
ApiResponse<Campaign>	OutboundApi.postOutboundCampaignsWithHttpInfo(Campaign body, Boolean useMaxCallsPerAgentDecimal)	Create a campaign.
ApiResponse<Campaign>	OutboundApi.putOutboundCampaign(ApiRequest<Campaign> request)	Update a campaign.
Future<Campaign>	OutboundApiAsync.putOutboundCampaignAsync(PutOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Update a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.putOutboundCampaignAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Update a campaign.
ApiResponse<Campaign>	OutboundApi.putOutboundCampaignWithHttpInfo(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal)	Update a campaign.

Methods in com.mypurecloud.sdk.v2.api with parameters of type Campaign

Modifier and Type	Method	Description
Campaign	OutboundApi.postOutboundCampaigns(Campaign body, Boolean useMaxCallsPerAgentDecimal)	Create a campaign.
ApiResponse<Campaign>	OutboundApi.postOutboundCampaignsWithHttpInfo(Campaign body, Boolean useMaxCallsPerAgentDecimal)	Create a campaign.
Campaign	OutboundApi.putOutboundCampaign(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal)	Update a campaign.
ApiResponse<Campaign>	OutboundApi.putOutboundCampaignWithHttpInfo(String campaignId, Campaign body, Boolean useMaxCallsPerAgentDecimal)	Update a campaign.

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type Campaign

Modifier and Type	Method	Description
Future<Campaign>	OutboundApiAsync.deleteOutboundCampaignAsync(DeleteOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Delete a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.deleteOutboundCampaignAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Delete a campaign.
Future<Campaign>	OutboundApiAsync.getOutboundCampaignAsync(GetOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Get dialer campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.getOutboundCampaignAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Get dialer campaign.
ApiResponse<Campaign>	OutboundApi.postOutboundCampaigns(ApiRequest<Campaign> request)	Create a campaign.
Future<Campaign>	OutboundApiAsync.postOutboundCampaignsAsync(PostOutboundCampaignsRequest request, AsyncApiCallback<Campaign> callback)	Create a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.postOutboundCampaignsAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Create a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.postOutboundCampaignsAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Create a campaign.
ApiResponse<Campaign>	OutboundApi.putOutboundCampaign(ApiRequest<Campaign> request)	Update a campaign.
Future<Campaign>	OutboundApiAsync.putOutboundCampaignAsync(PutOutboundCampaignRequest request, AsyncApiCallback<Campaign> callback)	Update a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.putOutboundCampaignAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Update a campaign.
Future<ApiResponse<Campaign>>	OutboundApiAsync.putOutboundCampaignAsync(ApiRequest<Campaign> request, AsyncApiCallback<ApiResponse<Campaign>> callback)	Update a campaign.

Uses of Campaign in com.mypurecloud.sdk.v2.api.request

Methods in com.mypurecloud.sdk.v2.api.request that return Campaign

Modifier and Type	Method	Description
Campaign	PostOutboundCampaignsRequest.getBody()
Campaign	PutOutboundCampaignRequest.getBody()

Methods in com.mypurecloud.sdk.v2.api.request that return types with arguments of type Campaign

Modifier and Type	Method	Description
ApiRequest<Campaign>	PostOutboundCampaignsRequest.withHttpInfo()
ApiRequest<Campaign>	PutOutboundCampaignRequest.withHttpInfo()

Methods in com.mypurecloud.sdk.v2.api.request with parameters of type Campaign

Modifier and Type	Method	Description
static PostOutboundCampaignsRequest.Builder	PostOutboundCampaignsRequest.builder(Campaign body)
static PutOutboundCampaignRequest.Builder	PutOutboundCampaignRequest.builder(String campaignId, Campaign body)
void	PostOutboundCampaignsRequest.setBody(Campaign body)
void	PutOutboundCampaignRequest.setBody(Campaign body)
PostOutboundCampaignsRequest.Builder	PostOutboundCampaignsRequest.Builder.withBody(Campaign body)
PostOutboundCampaignsRequest	PostOutboundCampaignsRequest.withBody(Campaign body)
PutOutboundCampaignRequest.Builder	PutOutboundCampaignRequest.Builder.withBody(Campaign body)
PutOutboundCampaignRequest	PutOutboundCampaignRequest.withBody(Campaign body)
PostOutboundCampaignsRequest.Builder	PostOutboundCampaignsRequest.Builder.withRequiredParams(Campaign body)
PutOutboundCampaignRequest.Builder	PutOutboundCampaignRequest.Builder.withRequiredParams(String campaignId, Campaign body)

Uses of Campaign in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return Campaign

Modifier and Type	Method	Description
Campaign	Campaign.abandonRate(Double abandonRate)	The targeted compliance abandon rate percentage.
Campaign	Campaign.agentOwnedColumn(String agentOwnedColumn)	Name of the contact list column containing the id of the agent who owns the record.
Campaign	Campaign.alwaysRunning(Boolean alwaysRunning)	Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign.
Campaign	Campaign.callableTimeSet(DomainEntityRef callableTimeSet)	The callable time set for this campaign to check before placing a call.
Campaign	Campaign.callAnalysisLanguage(String callAnalysisLanguage)	The language the edge will use to analyze the call.
Campaign	Campaign.callAnalysisResponseSet(DomainEntityRef callAnalysisResponseSet)	The call analysis response set to handle call analysis results from the edge.
Campaign	Campaign.callbackAutoAnswer(Boolean callbackAutoAnswer)	The option manages the auto-answer callback calls
Campaign	Campaign.callerAddress(String callerAddress)	The caller id phone number to be displayed on the outbound call.
Campaign	Campaign.callerName(String callerName)	The caller id name to be displayed on the outbound call.
Campaign	Campaign.campaignStatus(Campaign.CampaignStatusEnum campaignStatus)	The current status of the Campaign.
Campaign	Campaign.contactList(DomainEntityRef contactList)	The ContactList for this Campaign to dial.
Campaign	Campaign.contactListFilters(List<DomainEntityRef> contactListFilters)	Filter to apply to the contact list before dialing.
Campaign	Campaign.contactSort(ContactSort contactSort)	The order in which to sort contacts for dialing, based on a column.
Campaign	Campaign.contactSorts(List<ContactSort> contactSorts)	The order in which to sort contacts for dialing, based on up to four columns.
Campaign	Campaign.diagnosticsSettings(DiagnosticsSettings diagnosticsSettings)	Campaign diagnostics settings
Campaign	Campaign.dialingMode(Campaign.DialingModeEnum dialingMode)	The strategy this Campaign will use for dialing.
Campaign	Campaign.division(DomainEntityRef division)	The division this campaign belongs to.
Campaign	Campaign.dncLists(List<DomainEntityRef> dncLists)	DncLists for this Campaign to check before placing a call.
Campaign	Campaign.dynamicContactQueueingSettings(DynamicContactQueueingSettings dynamicContactQueueingSettings)	Settings for dynamic queueing of contacts.
Campaign	Campaign.dynamicLineBalancingSettings(DynamicLineBalancingSettings dynamicLineBalancingSettings)	Dynamic line balancing settings
Campaign	Campaign.edgeGroup(DomainEntityRef edgeGroup)	The EdgeGroup that will place the calls.
Campaign	CallHistoryParticipant.getOutboundCampaign()
Campaign	Campaign.maxCallsPerAgent(Integer maxCallsPerAgent)	The maximum number of calls that can be placed per agent on this campaign
Campaign	Campaign.maxCallsPerAgentDecimal(Double maxCallsPerAgentDecimal)	The maximum number of calls that can be placed per agent on this campaign with decimal precision
Campaign	Campaign.name(String name)	The name of the Campaign.
Campaign	Campaign.noAnswerTimeout(Integer noAnswerTimeout)	How long to wait before dispositioning a call as 'no-answer'.
Campaign	Campaign.outboundLineCount(Integer outboundLineCount)	The number of outbound lines to be concurrently dialed.
Campaign	Campaign.phoneColumns(List<PhoneColumn> phoneColumns)	The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.
Campaign	Campaign.previewAutoEnd(Boolean previewAutoEnd)	Option to enable preview auto end
Campaign	Campaign.previewTimeOutSeconds(Long previewTimeOutSeconds)	The number of seconds before a call will be automatically placed on a preview.
Campaign	Campaign.priority(Integer priority)	The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.
Campaign	Campaign.queue(DomainEntityRef queue)	The Queue for this Campaign to route calls to.
Campaign	Campaign.ruleSets(List<DomainEntityRef> ruleSets)	Rule sets to be applied while this campaign is dialing.
Campaign	Campaign.script(DomainEntityRef script)	The Script to be displayed to agents that are handling outbound calls.
Campaign	Campaign.site(DomainEntityRef site)	The identifier of the site to be used for dialing; can be set in place of an edge group.
Campaign	Campaign.skillColumns(List<String> skillColumns)	The skill columns on the ContactList that this Campaign should take into account when dialing
Campaign	Campaign.skipPreviewDisabled(Boolean skipPreviewDisabled)	Whether or not agents can skip previews without placing a call.
Campaign	Campaign.version(Integer version)	Required for updates, must match the version number of the most recent update

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type Campaign

Modifier and Type	Method	Description
List<Campaign>	CampaignEntityListing.getEntities()

Methods in com.mypurecloud.sdk.v2.model with parameters of type Campaign

Modifier and Type	Method	Description
CallHistoryParticipant	CallHistoryParticipant.outboundCampaign(Campaign outboundCampaign)	The outbound campaign associated with the participant
void	CallHistoryParticipant.setOutboundCampaign(Campaign outboundCampaign)

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type Campaign

Modifier and Type	Method	Description
CampaignEntityListing	CampaignEntityListing.entities(List<Campaign> entities)
void	CampaignEntityListing.setEntities(List<Campaign> entities)