Interface ICampaignManager

All Superinterfaces:

IDisposable, IEntity

public interface ICampaignManager
extends IEntity

Manages the campaigns.

Method Summary

Modifier and Type	Method	Description
void	assignAgent(String campaignName, String agentName)	Assigns an agent to the campaign.
void	assignCategory(String campaignName, int categoryId)	Assigns a category to the campaign.
void	assignTeam(String campaignName, String teamName)	Assigns a team to the campaign.
void	automaticStartStopContactList(String campaignName, String contactListName)	Enables automatic start and stop of a contact list.
int	cancelContacts(String campaignName, String sql)	Cancel contacts, non-connected interactions or workflow tasks.
int	createCampaign(CampaignCreateRequest request)	Creates a campaign
int	createContact(String campaignName, ContactCreateRequest contactCreateRequest)	Creates a contact.
void	deAssignAgent(String campaignName, String agentName)	Deassigns an agent to the campaign.
void	deAssignCategory(String campaignName, int categoryId)	Deassigns a category to the campaign.
void	deAssignTeam(String campaignName, String teamName)	Deassigns a team to the campaign.
void	deleteCampaign(String campaignName)	Deletes a campaign.
void	deleteContact(String campaignName, int contactId)	Deletes a contact.
int	deleteContacts(String campaignName, String sql)	Deletes contacts by starting a background task on the Altitude uCI Server.
int	duplicateCampaign(String campaignName, CampaignCreateRequest request)	Duplicates the current campaign.
void	forcedDeAssignAgent(String campaignName, String agentName)	Deassigns an agent to the campaign regardless of the current state of the campaign.
void	forcedDeAssignTeam(String campaignName, String teamName)	Deassigns a team to the campaign regardless of the current state of the campaign.
AgentData[]	getAssignedAgents(String campaignName, AssignmentMode assignmentMode)	Gets the data of the agents assigned to the campaign.
AgentInCampaignInfo[]	getAssignedAgentsInfo(String campaignName)	Gets information about the agents assigned to the campaign.
CategoryData[]	getAssignedCategories(String campaignName)	Returns the categories assigned to the campaign.
String[]	getAssignedDirectoryNames(String campaignName)	Gets the names of the directories assigned to the campaign.
TeamData[]	getAssignedTeams(String campaignName)	Gets the data of the teams assigned to the campaign.
Attribute[]	getAttributes(String campaignName)	Gets the attributes of the campaign.
ICampaignCursor	getCampaignCursor(int cursorId)	Gets a campaign cursor open in the instance.
ICampaignCursor[]	getCampaignCursors()	Returns the campaign cursors open in the instance.
CampaignData	getCampaignDataById(int campaignId)	Returns a CampaignData object with data about the campaign.
CampaignData	getCampaignDataByName(String campaignName)	Returns a CampaignData object with data about the campaign.
TableSchema	getCampaignTableSchema()	Gets the table schema of the campaign.
IContactHistoryCursor	getContactHistoryCursor(int cursorId)	Gets a contact history cursor open in the instance.
IContactHistoryCursor[]	getContactHistoryCursors()	Returns the contact history cursors open in the instance.
ContactHistoryEntry	getContactHistoryEntry(String campaignName, int contactId, long contactHistoryEntryId)	Returns a ContactHistoryEntry object with data about the contact history entry.
TableSchema	getContactHistoryTableSchema()	Gets the table schema of the contact history.
ContactList	getContactListById(String campaignName, int contactListId)	Gets a the contact list.
ContactList	getContactListByName(String campaignName, String contactListName)	Gets a the contact list.
ContactList[]	getContactLists(String campaignName)	Gets the contact lists of the campaign.
ContactListState	getContactListState(String campaignName, String contactListName)	Gets a the state of the contact list.
ICampaignContactUploader	getContactUploaderById(int contactUploaderId)	Gets a ICampaignContactUploader object by the identifier within the IntegrationServer.
ICampaignContactUploader	getContactUploaderByTaskId(int contactUploaderTaskId)	Returns a ICampaignContactUploader object that previously has started an upload task in the Altitude uCI Server.
ICampaignContactUploader[]	getContactUploaders()	Gets the ICampaignContactUploader objects.
CampaignInboundEmailAddress[]	getInboundEmailAddresses(String campaignName)	Gets an array with the campaign inbound email addresses.
CampaignInboundEmailFilter[]	getInboundEmailFilters(String campaignName)	Gets an array with the campaign inbound email filters.
IInstance	getInstance()	The instance.
CampaignInstantMessagingGatewayData[]	getInstantMessagingGateways(String campaignName)	Gets the instant messaging gateways the campaign.
CampaignOutboundEmailAddress[]	getOutboundEmailAddresses(String campaignName)	Gets the campaign outbound email addresses.
CampaignRolePermission[]	getPermissions(String campaignName)	Gets the list of role permissions.
CampaignScheduleDetail[]	getScheduleDetails(String campaignName)	Gets the campaign schedule details.
CampaignState	getState(String campaignName)	Gets the state of the campaign.
CampaignTelephonyGatewayData[]	getTelephonyGateways(String campaignName)	Gets the telephony gateways of the campaign.
void	manualStartContactList(String campaignName, String contactListName)	Manually starts a contact list.
void	manualStopContactList(String campaignName, String contactListName)	Manually stops a contact list.
ICampaignCursor	newCampaignCursor(String[] columns, String sql, CampaignAssignmentFilter assignmentFilter)	Opens a campaign cursor.
IContactHistoryCursor	newContactHistoryCursor(String campaignName, String[] columns, String sql)	Opens a contact history cursor.
ICampaignContactUploader	newContactUploader(String campaignName)	Creates an ICampaignContactUploader used to upload contacts.
int	resubmitContact(String campaignName, int contactId, ContactResubmitRequest request)	Resubmits a contact.
int	resubmitContacts(String campaignName, String sql, ContactResubmitRequest request)	Resubmits contacts.
void	sendMessage(String campaignName, String message)	Sends a message to a campaign.
void	setAgentNotReady(String campaignName, String agentName, String notReadyReason)	Sets the agent not ready in the campaign.
void	setAgentReady(String campaignName, String agentName)	Sets the agent ready in the campaign.
void	start(String campaignName)	Starts the campaign.
void	stop(String campaignName)	Stops the campaign.
void	suspend(String campaignName)	Suspends the campaign.
ICampaignCursor	tryGetCampaignCursor(int cursorId)	Gets a campaign cursor open in the instance or null if it doesn't exist.
IContactHistoryCursor	tryGetContactHistoryCursor(int cursorId)	Gets a contact history cursor open in the instance or null if it doesn't exist.
void	updateCampaign(String campaignName, CampaignUpdateRequest request)	Updates a campaign.
void	updateContact(String campaignName, int contactId, ContactUpdateRequest contactUpdateRequest)	Updates a contact.
void	updateQueuedEmail(String campaignName, int queuedEmailId, QueuedEmailUpdateRequest queuedEmailUpdateRequest)	Updates a queued email.
void	updateQueuedSocial(String campaignName, int queuedSocialDocumentId, QueuedSocialUpdateRequest queuedSocialUpdateRequest)	Updates a queued social.
UploadResult[]	uploadContacts(String campaignName, UploadRequest<ContactUploadRequest>[] requests)	Create or update a set of contacts.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

assignAgent

void assignAgent(String campaignName,
 String agentName)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Assigns an agent to the campaign.

Parameters:

campaignName - Name of the campaign.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

assignCategory

void assignCategory(String campaignName,
 int categoryId)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Assigns a category to the campaign.

Parameters:

campaignName - Name of the campaign.

categoryId - Identifier of the category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

assignTeam

void assignTeam(String campaignName,
 String teamName)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Assigns a team to the campaign.

Parameters:

campaignName - Name of the campaign.

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

automaticStartStopContactList

void automaticStartStopContactList(String campaignName,
 String contactListName)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Enables automatic start and stop of a contact list.

Parameters:

campaignName - Name of the campaign.

contactListName - Name of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelContacts

int cancelContacts(String campaignName,
 String sql)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Cancel contacts, non-connected interactions or workflow tasks.

Parameters:

campaignName - Name of the campaign.

sql - SQL.

Returns:

The identifier of the background task created on the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createCampaign

int createCampaign(CampaignCreateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a campaign

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createContact

int createContact(String campaignName,
 ContactCreateRequest contactCreateRequest)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a contact. For a massive contact insertion, please use the UploadContacts method.

Parameters:

campaignName - Name of the campaign.

contactCreateRequest - Contact data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignAgent

void deAssignAgent(String campaignName,
 String agentName)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns an agent to the campaign.

Parameters:

campaignName - Name of the campaign.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignCategory

void deAssignCategory(String campaignName,
 int categoryId)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns a category to the campaign.

Parameters:

campaignName - Name of the campaign.

categoryId - Identifier of the category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignTeam

void deAssignTeam(String campaignName,
 String teamName)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns a team to the campaign.

Parameters:

campaignName - Name of the campaign.

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteCampaign

void deleteCampaign(String campaignName)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteContact

void deleteContact(String campaignName,
 int contactId)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a contact.

Parameters:

campaignName - Name of the campaign.

contactId - Identifier of the contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteContacts

int deleteContacts(String campaignName,
 String sql)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes contacts by starting a background task on the Altitude uCI Server.

Parameters:

campaignName - Name of the campaign.

sql - Sql-like statement. The columns admitted are the ones returned by the GetContactTableSchema method. If null then all contacts from the specified campaign are deleted.

Returns:

The identifier of the background task created on the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

duplicateCampaign

int duplicateCampaign(String campaignName,
 CampaignCreateRequest request)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Duplicates the current campaign. The duplicated data includes configuration, gateways, agent, team, and knowledge base category assignments.

Parameters:

campaignName - Name of the campaign.

request - Contains the fields that must be overwritten

Returns:

Identifier of the duplicated campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

forcedDeAssignAgent

void forcedDeAssignAgent(String campaignName,
 String agentName)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns an agent to the campaign regardless of the current state of the campaign.

Parameters:

campaignName - Name of the campaign.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

forcedDeAssignTeam

void forcedDeAssignTeam(String campaignName,
 String teamName)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns a team to the campaign regardless of the current state of the campaign.

Parameters:

campaignName - Name of the campaign.

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedAgents

AgentData[] getAssignedAgents(String campaignName,
 AssignmentMode assignmentMode)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the agents assigned to the campaign.

Parameters:

campaignName - Name of the campaign.

assignmentMode - Type of mode. If AssignmentMode.NoValue, AssignmentMode.Direct is assumed.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedAgentsInfo

AgentInCampaignInfo[] getAssignedAgentsInfo(String campaignName)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the agents assigned to the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedCategories

CategoryData[] getAssignedCategories(String campaignName)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the categories assigned to the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedDirectoryNames

String[] getAssignedDirectoryNames(String campaignName)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the names of the directories assigned to the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedTeams

TeamData[] getAssignedTeams(String campaignName)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the teams assigned to the campaign.

Parameters:

campaignName - Name of the campaign

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttributes

Attribute[] getAttributes(String campaignName)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the attributes of the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignCursor

ICampaignCursor getCampaignCursor(int cursorId)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a campaign cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ICampaignCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignCursors

ICampaignCursor[] getCampaignCursors()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the campaign cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignDataById

CampaignData getCampaignDataById(int campaignId)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a CampaignData object with data about the campaign.

Parameters:

campaignId - Identifier of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignDataByName

CampaignData getCampaignDataByName(String campaignName)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a CampaignData object with data about the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignTableSchema

TableSchema getCampaignTableSchema()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactHistoryCursor

IContactHistoryCursor getContactHistoryCursor(int cursorId)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact history cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactHistoryCursors

IContactHistoryCursor[] getContactHistoryCursors()
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact history cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactHistoryEntry

ContactHistoryEntry getContactHistoryEntry(String campaignName,
 int contactId,
 long contactHistoryEntryId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a ContactHistoryEntry object with data about the contact history entry.

Parameters:

campaignName - Name of the campaign.

contactId - Identifier of the contact.

contactHistoryEntryId - Identifier of the contact history entry.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactHistoryTableSchema

TableSchema getContactHistoryTableSchema()
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact history.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactListById

ContactList getContactListById(String campaignName,
 int contactListId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a the contact list.

Parameters:

campaignName - Name of the campaign.

contactListId - Identifier of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactListByName

ContactList getContactListByName(String campaignName,
 String contactListName)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a the contact list.

Parameters:

campaignName - Name of the campaign.

contactListName - Name of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactLists

ContactList[] getContactLists(String campaignName)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact lists of the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactListState

ContactListState getContactListState(String campaignName,
 String contactListName)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a the state of the contact list.

Parameters:

campaignName - Name of the campaign.

contactListName - Name of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactUploaderById

ICampaignContactUploader getContactUploaderById(int contactUploaderId)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a ICampaignContactUploader object by the identifier within the IntegrationServer.

Parameters:

contactUploaderId - Identifier of the ICampaignContactUploader object.

Returns:

The ICampaignContactUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactUploaderByTaskId

ICampaignContactUploader getContactUploaderByTaskId(int contactUploaderTaskId)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a ICampaignContactUploader object that previously has started an upload task in the Altitude uCI Server.

Parameters:

contactUploaderTaskId - Identifier of the entity upload task returned by the ICampaignContactUploader.Start

Returns:

The ICampaignContactUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactUploaders

ICampaignContactUploader[] getContactUploaders()
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the ICampaignContactUploader objects.

Returns:

The ICampaignContactUploader objects.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInboundEmailAddresses

CampaignInboundEmailAddress[] getInboundEmailAddresses(String campaignName)
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an array with the campaign inbound email addresses.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInboundEmailFilters

CampaignInboundEmailFilter[] getInboundEmailFilters(String campaignName)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an array with the campaign inbound email filters.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstantMessagingGateways

CampaignInstantMessagingGatewayData[] getInstantMessagingGateways(String campaignName)
                                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the instant messaging gateways the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOutboundEmailAddresses

CampaignOutboundEmailAddress[] getOutboundEmailAddresses(String campaignName)
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign outbound email addresses.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPermissions

CampaignRolePermission[] getPermissions(String campaignName)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of role permissions.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScheduleDetails

CampaignScheduleDetail[] getScheduleDetails(String campaignName)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign schedule details.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

CampaignState getState(String campaignName)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the state of the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTelephonyGateways

CampaignTelephonyGatewayData[] getTelephonyGateways(String campaignName)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the telephony gateways of the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

manualStartContactList

void manualStartContactList(String campaignName,
 String contactListName)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Manually starts a contact list.

Parameters:

campaignName - Name of the campaign.

contactListName - Name of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

manualStopContactList

void manualStopContactList(String campaignName,
 String contactListName)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Manually stops a contact list.

Parameters:

campaignName - Name of the campaign.

contactListName - Name of the contact list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newCampaignCursor

ICampaignCursor newCampaignCursor(String[] columns,
 String sql,
 CampaignAssignmentFilter assignmentFilter)
                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a campaign cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

assignmentFilter - Assignment filter.

Returns:

The ICampaignCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactHistoryCursor

IContactHistoryCursor newContactHistoryCursor(String campaignName,
 String[] columns,
 String sql)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact history cursor.

Parameters:

campaignName - Name of the campaign.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactUploader

ICampaignContactUploader newContactUploader(String campaignName)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Creates an ICampaignContactUploader used to upload contacts.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

resubmitContact

int resubmitContact(String campaignName,
 int contactId,
 ContactResubmitRequest request)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Resubmits a contact.

Parameters:

campaignName - Name of the campaign.

contactId - Identifier of the contact.

request - Request data.

Returns:

The identifier of the background task created on the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

resubmitContacts

int resubmitContacts(String campaignName,
 String sql,
 ContactResubmitRequest request)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Resubmits contacts.

Parameters:

campaignName - Name of the campaign.

sql - SQL.

request - Request data.

Returns:

The identifier of the background task created on the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendMessage

void sendMessage(String campaignName,
 String message)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Sends a message to a campaign.

Parameters:

campaignName - Name of the campaign.

message - The message to send.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setAgentNotReady

void setAgentNotReady(String campaignName,
 String agentName,
 String notReadyReason)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the agent not ready in the campaign.

Parameters:

campaignName - Name of the campaign.

agentName - Name of the agent.

notReadyReason - The not ready reason.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setAgentReady

void setAgentReady(String campaignName,
 String agentName)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the agent ready in the campaign.

Parameters:

campaignName - Name of the campaign.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

start

void start(String campaignName)
    throws Exception,
altitude.integrationServer.exceptions.ISException

Starts the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

stop

void stop(String campaignName)
   throws Exception,
altitude.integrationServer.exceptions.ISException

Stops the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

suspend

void suspend(String campaignName)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Suspends the campaign.

Parameters:

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetCampaignCursor

ICampaignCursor tryGetCampaignCursor(int cursorId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a campaign cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ICampaignCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactHistoryCursor

IContactHistoryCursor tryGetContactHistoryCursor(int cursorId)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact history cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateCampaign

void updateCampaign(String campaignName,
 CampaignUpdateRequest request)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a campaign.

Parameters:

campaignName - Name of the campaign.

request - Describes what to update.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContact

void updateContact(String campaignName,
 int contactId,
 ContactUpdateRequest contactUpdateRequest)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a contact.

Parameters:

campaignName - Name of the campaign.

contactId - Identifier of the contact.

contactUpdateRequest - Contact data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateQueuedEmail

void updateQueuedEmail(String campaignName,
 int queuedEmailId,
 QueuedEmailUpdateRequest queuedEmailUpdateRequest)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a queued email.

Parameters:

campaignName - Name of the campaign.

queuedEmailId - Identifier of the queued email.

queuedEmailUpdateRequest - Queued email data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateQueuedSocial

void updateQueuedSocial(String campaignName,
 int queuedSocialDocumentId,
 QueuedSocialUpdateRequest queuedSocialUpdateRequest)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a queued social.

Parameters:

campaignName - Name of the campaign.

queuedSocialDocumentId - Identifier of the queued social document.

queuedSocialUpdateRequest - Queued social data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

uploadContacts

UploadResult[] uploadContacts(String campaignName,
 UploadRequest<ContactUploadRequest>[] requests)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Create or update a set of contacts.

Parameters:

campaignName - Name of the campaign.

requests - Requests with the data of the contacts to upload.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException