Interface ICampaign

All Superinterfaces:

IDisposable, IEntity

public interface ICampaign
extends IEntity

Represents a campaign.

Method Summary

Modifier and Type	Method	Description
void	addCampaignMessageOfTheDayChangedListener(CampaignMessageOfTheDayChangedListener listener)	Registers the CampaignMessageOfTheDayChangedListener.
void	addSaveActivityErrorListener(SaveActivityErrorListener listener)	Registers the SaveActivityErrorListener.
int	createNewContact(Attribute[] attributes, String timeZone, String reschedulePhone, int directoryId, int contactProfileId)	Creates a new contact.
int	createNewContact(Attribute[] attributes, String timeZone, String reschedulePhone, int directoryId, int contactProfileId, String contactListName)	Creates a new contact.
int	createNewContact(Attribute[] attributes, String timeZone, String reschedulePhone, String reschedulePhoneScheduleRule, int directoryId, int contactProfileId, String contactListName)	Creates a new contact.
int	createNewContact(Attribute[] attributes, String timeZone, String reschedulePhone, String reschedulePhoneScheduleRule, int directoryId, int contactProfileId, String contactListName, String serviceAniListName)	Creates a new contact.
void	disableContact(int contactId)	Disables an existing contact.
AgentInCampaignInfo	getAgentInCampaignInfoById(int agentId)	Gets information about the specified campaign.
AgentInCampaignInfo	getAgentInCampaignInfoByName(String agentName)	Gets information about the agent working in the specified campaign.
AgentInCampaignMediaInfo	getAgentInCampaignMediaInfoById(int mediaId, int agentId)	Gets media information about the agent working in the specified campaign.
AgentInCampaignMediaInfo	getAgentInCampaignMediaInfoByName(int mediaId, String agentName)	Gets media information about the agent working in the specified campaign.
CampaignCanDo	getAllowedOperations()	Allowed operations for the campaign.
String[]	getAssignedAgentNames()	Gets the names of the agents assigned to this campaign.
Attribute[]	getAttributes()	Campaign attributes.
Attribute[]	getAttributesFormatted()	Gets the formatted campaign attributes.
Contact	getContactByContactProfileId(int directoryId, int contactProfileId, boolean fetchContactProfileAttributes)	Gets the contact.
Contact	getContactByContactProfileId(int directoryId, int contactProfileId, boolean fetchContactProfileAttributes, PurposeFilter purposeFilter)	Gets the contact.
Contact	getContactById(int contactId, boolean fetchContactProfileAttributes)	Gets the contact.
Contact	getContactById(int contactId, boolean fetchContactProfileAttributes, PurposeFilter purposeFilter)	Gets the contact.
int	getContactCount(int directoryId, String sql)	Gets the count of the contact.
IContactCursor	getContactCursor(int cursorId)	Gets a contact cursor open in the campaign.
IContactCursor[]	getContactCursors()	Gets the contact cursors open in the campaign.
String[]	getContactListNames()	Gets the names of the contact lists.
int	getContactProfileInProgressWorkflowCount(int directoryId, int contactProfileId, String sql)	Gets the count of the contact profile in progress workflow process task.
TableSchema	getContactProfileInProgressWorkflowTableSchema()	Gets the table schema of the contact profile in progress workflow.
int	getContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql)	Gets the count of the contact profile interaction history, without the outcomes of each interaction.
int	getContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql, boolean countOutcomes)	Gets the count of the contact profile interaction history.
TableSchema	getContactProfileInteractionHistoryTableSchema()	Gets the table schema of the contact profile interaction history.
TableSchema	getContactTableSchema(int directoryId)	Gets the table schema of the contact.
PurposeData	getDefaultPurpose()	Gets the campaign default purpose.
Directory[]	getDirectories()	Gets the directories assigned to the campaign.
String[]	getEmailOutboundFromAddresses()	Gets the email addresses used to send email.
int	getId()	Identifier of the campaign.
CampaignInfo	getInfo()	Gets information about the campaign.
IInstance	getInstance()	Instance associated to the campaign.
int	getInteractionThreadCount(int contactId, String sql)	Gets the count of the interaction thread.
CampaignMediaConfiguration	getMediaConfiguration()	Gets the campaign media configuration.
String	getMessageOfTheDay()	Message of the day of the campaign.
String	getName()	Name of the campaign.
int	getPendingWorkCount(String agentName, String sql, boolean onlyActivitiesWithAgent)	Gets the count of the pending work.
TableSchema	getPendingWorkTableSchema()	Gets the table schema of the pending work.
int	getQueuedAgentPickUpTaskCount(String sql, boolean onlyPickable)	Gets the count of the queued agent pick up task.
TableSchema	getQueuedAgentPickUpTaskTableSchema()	Gets the queuedchema of the agent pick up task.
int	getQueuedEmailCount(String sql, boolean onlyPickable)	Gets the count of the queued email.
TableSchema	getQueuedEmailTableSchema()	Gets the table schema of the queued email.
int	getQueuedSocialCount(String sql, boolean onlyPickable)	Gets the count of the queued social.
TableSchema	getQueuedSocialTableSchema()	Gets the table schema of the queued social.
boolean	getRecordAllCalls()	If true, all calls of the agents will be recorded.
boolean	getRecordAllScreens()	If true, all screens of the agents will be recorded.
int	getSentEmailCount(String sql)	Gets the count of the sent email.
TableSchema	getSentEmailTableSchema()	Gets the table schema of the sent email.
int	getSentSocialCount(String sql)	Gets the count of the sent social.
TableSchema	getSentSocialTableSchema()	Gets the table schema of the sent social.
IService	getService()	Service of the campaign.
SkillProfileMediaInfo	getSkillProfileInfo(String skillProfileName)	Gets media information about agents working with a skill profile.
SkillProfileMediaInfo	getSkillProfileInfoByMediaId(String skillProfileName, int mediaId)	Gets media information about agents working with a skill profile.
SkillProfileMediaInfo	getSkillProfileInfoByMediaName(String skillProfileName, String mediaName)	Gets media information about agents working with a skill profile.
CampaignState	getState()	State of the campaign.
CampaignType	getType()	Type of campaign
AgentInCampaignInfo[]	getWorkingAgents()	Gets information about the agents working in this campaign.
AgentInCampaignMediaInfo[]	getWorkingAgentsMedia(int mediaId)	Gets media information about the agents working in this campaign.
boolean	isInDoNotCallList(String number, String uniqueId)	Checks if a number is in the campaign service do not call list, or in the global do not call lists.
IContactCursor	newContactCursor(int directoryId, String[] columns, String sql)	Opens a contact cursor.
IContactCursor	newContactCursor(int directoryId, String[] columns, String sql, PurposeFilter purposeFilter)	Opens a contact cursor.
IContactProfileInProgressWorkflowCursor	newContactProfileInProgressWorkflowCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens a contact profile in progress workflow process task cursor.
IContactProfileInteractionHistoryCursor	newContactProfileInteractionHistoryCursor(int directoryId, int contactProfileId, String[] columns, String sql, boolean fetchOutcomes)	Opens a contact profile interaction history cursor.
IInteractionThreadCursor	newInteractionThreadCursor(int contactId, String[] columns, String sql)	Opens an interaction thread cursor.
IPendingWorkCursor	newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyActivitiesWithAgent)	Opens a pending work cursor.
IPendingWorkCursor	newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyActivitiesWithAgent, PurposeFilter purposeFilter)	Opens a pending work cursor.
IQueuedAgentPickUpTaskCursor	newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyPickable)	Opens a queued agent pick up task cursor.
IQueuedAgentPickUpTaskCursor	newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued agent pick up task cursor.
IQueuedEmailCursor	newQueuedEmailCursor(String[] columns, String sql, boolean onlyPickable)	Opens a queued email cursor.
IQueuedEmailCursor	newQueuedEmailCursor(String[] columns, String sql, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued email cursor.
IQueuedSocialCursor	newQueuedSocialCursor(String[] columns, String sql, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued social cursor.
ISentEmailCursor	newSentEmailCursor(String[] columns, String sql)	Opens a sent email cursor.
ISentEmailCursor	newSentEmailCursor(String[] columns, String sql, PurposeFilter purposeFilter)	Opens a sent email cursor.
ISentSocialCursor	newSentSocialCursor(String[] columns, String sql, PurposeFilter purposeFilter)	Opens a sent social cursor.
void	removeCampaignMessageOfTheDayChangedListener(CampaignMessageOfTheDayChangedListener listener)	Unregisters the CampaignMessageOfTheDayChangedListener.
void	removeSaveActivityErrorListener(SaveActivityErrorListener listener)	Unregisters the SaveActivityErrorListener.
void	restartContact(int contactId)	Restarts an existing contact.
int	scheduleContact(Attribute[] attributes, String timeZone, String reschedulePhone, String reschedulePhoneScheduleRule, Duration rescheduleTimeLimit, int directoryId, int contactProfileId, GregorianCalendar scheduleMoment, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills, String contactListName)	Schedules a contact for a contact profile.
int	scheduleContact(Attribute[] attributes, String timeZone, String reschedulePhone, String reschedulePhoneScheduleRule, Duration rescheduleTimeLimit, int directoryId, int contactProfileId, GregorianCalendar scheduleMoment, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills, String contactListName, String serviceAniListName)	Schedules a contact for a contact profile.
int	scheduleContact(Attribute[] attributes, String timeZone, String reschedulePhone, Duration rescheduleTimeLimit, int directoryId, int contactProfileId, GregorianCalendar scheduleMoment, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills)	Schedules a contact for a contact profile.
int	scheduleContact(Attribute[] attributes, String timeZone, String reschedulePhone, Duration rescheduleTimeLimit, int directoryId, int contactProfileId, GregorianCalendar scheduleMoment, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills, String contactListName)	Schedules a contact for a contact profile.
String	sendData(String agentName, Attribute[] attrs)	Sends data to the agent.
IContactCursor	tryGetContactCursor(int cursorId)	Gets a contact cursor open in the campaign or null if it doesn't exist.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addCampaignMessageOfTheDayChangedListener

void addCampaignMessageOfTheDayChangedListener(CampaignMessageOfTheDayChangedListener listener)

Registers the CampaignMessageOfTheDayChangedListener.

Parameters:

listener - Event listener to add.

removeCampaignMessageOfTheDayChangedListener

void removeCampaignMessageOfTheDayChangedListener(CampaignMessageOfTheDayChangedListener listener)

Unregisters the CampaignMessageOfTheDayChangedListener.

Parameters:

listener - Event listener to remove.

addSaveActivityErrorListener

void addSaveActivityErrorListener(SaveActivityErrorListener listener)

Registers the SaveActivityErrorListener.

Parameters:

listener - Event listener to add.

removeSaveActivityErrorListener

void removeSaveActivityErrorListener(SaveActivityErrorListener listener)

Unregisters the SaveActivityErrorListener.

Parameters:

listener - Event listener to remove.

createNewContact

int createNewContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 int directoryId,
 int contactProfileId)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a new contact. The state of the contact will be Created.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createNewContact

int createNewContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 int directoryId,
 int contactProfileId,
 String contactListName)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a new contact. The state of the contact will be Created.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

contactListName - Name of the contact list where the contact will be created.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createNewContact

int createNewContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 String reschedulePhoneScheduleRule,
 int directoryId,
 int contactProfileId,
 String contactListName)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a new contact. The state of the contact will be Created.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

reschedulePhoneScheduleRule - Reschedule phone schedule rule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

contactListName - Name of the contact list where the contact will be created.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createNewContact

int createNewContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 String reschedulePhoneScheduleRule,
 int directoryId,
 int contactProfileId,
 String contactListName,
 String serviceAniListName)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a new contact. The state of the contact will be Created.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

reschedulePhoneScheduleRule - Reschedule phone schedule rule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

contactListName - Name of the contact list where the contact will be created.

serviceAniListName - Name of the service ANI list to use when dialing to the contact.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

disableContact

void disableContact(int contactId)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Disables an existing contact. The status of the contact will be Disabled.

Parameters:

contactId - Identifier of the contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInCampaignInfoById

AgentInCampaignInfo getAgentInCampaignInfoById(int agentId)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the specified campaign.

Parameters:

agentId - Identifier of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInCampaignInfoByName

AgentInCampaignInfo getAgentInCampaignInfoByName(String agentName)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the agent working in the specified campaign.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInCampaignMediaInfoById

AgentInCampaignMediaInfo getAgentInCampaignMediaInfoById(int mediaId,
 int agentId)
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about the agent working in the specified campaign.

Parameters:

mediaId - Identifier of the media.

agentId - Identifier of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInCampaignMediaInfoByName

AgentInCampaignMediaInfo getAgentInCampaignMediaInfoByName(int mediaId,
 String agentName)
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about the agent working in the specified campaign.

Parameters:

mediaId - Identifier of the media.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

CampaignCanDo getAllowedOperations()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Allowed operations for the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedAgentNames

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

Gets the names of the agents assigned to this campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttributes

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

Campaign attributes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttributesFormatted

Attribute[] getAttributesFormatted()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the formatted campaign attributes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactByContactProfileId

Contact getContactByContactProfileId(int directoryId,
 int contactProfileId,
 boolean fetchContactProfileAttributes)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

fetchContactProfileAttributes - If true, fetch the contact profile attributes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactByContactProfileId

Contact getContactByContactProfileId(int directoryId,
 int contactProfileId,
 boolean fetchContactProfileAttributes,
 PurposeFilter purposeFilter)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

fetchContactProfileAttributes - If true, fetch the contact profile attributes.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactById

Contact getContactById(int contactId,
 boolean fetchContactProfileAttributes)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact.

Parameters:

contactId - Identifier of the contact.

fetchContactProfileAttributes - If true, fetch the contact profile attributes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactById

Contact getContactById(int contactId,
 boolean fetchContactProfileAttributes,
 PurposeFilter purposeFilter)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact.

Parameters:

contactId - Identifier of the contact.

fetchContactProfileAttributes - If true, fetch the contact profile attributes.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactCount

int getContactCount(int directoryId,
 String sql)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact.

Parameters:

directoryId - Identifier of the directory.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactCursor

IContactCursor getContactCursor(int cursorId)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact cursor open in the campaign.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactCursors

IContactCursor[] getContactCursors()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact cursors open in the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactListNames

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

Gets the names of the contact lists.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowCount

int getContactProfileInProgressWorkflowCount(int directoryId,
 int contactProfileId,
 String sql)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile in progress workflow process task.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowTableSchema

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

Gets the table schema of the contact profile in progress workflow.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryCount

int getContactProfileInteractionHistoryCount(int directoryId,
 int contactProfileId,
 String sql)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile interaction history, without the outcomes of each interaction.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryCount

int getContactProfileInteractionHistoryCount(int directoryId,
 int contactProfileId,
 String sql,
 boolean countOutcomes)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile interaction history.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

countOutcomes - If true, counts the outcomes of each interaction. If false, the count does not include the outcomes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryTableSchema

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

Gets the table schema of the contact profile interaction history.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactTableSchema

TableSchema getContactTableSchema(int directoryId)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact.

Parameters:

directoryId - Identifier of the directory. If > 0 then also returns the contact profile extension attributes columns.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDefaultPurpose

PurposeData getDefaultPurpose()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign default purpose.

Returns:

The PurposeData if configured, or null if no default purpose is configured.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectories

Directory[] getDirectories()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the directories assigned to the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailOutboundFromAddresses

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

Gets the email addresses used to send email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getId

int getId()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInfo

CampaignInfo getInfo()
              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

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

Instance associated to the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadCount

int getInteractionThreadCount(int contactId,
 String sql)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the interaction thread.

Parameters:

contactId - Identifier of the contact.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMediaConfiguration

CampaignMediaConfiguration getMediaConfiguration()
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign media configuration.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMessageOfTheDay

String getMessageOfTheDay()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Message of the day of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getName

String getName()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkCount

int getPendingWorkCount(String agentName,
 String sql,
 boolean onlyActivitiesWithAgent)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the pending work.

Parameters:

agentName - Name of the agent.

sql - SQL.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkTableSchema

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

Gets the table schema of the pending work.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskCount

int getQueuedAgentPickUpTaskCount(String sql,
 boolean onlyPickable)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued agent pick up task.

Parameters:

sql - SQL.

onlyPickable - If true, the cursor only has tasks that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskTableSchema

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

Gets the queuedchema of the agent pick up task.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailCount

int getQueuedEmailCount(String sql,
 boolean onlyPickable)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued email.

Parameters:

sql - SQL.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailTableSchema

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

Gets the table schema of the queued email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialCount

int getQueuedSocialCount(String sql,
 boolean onlyPickable)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued social.

Parameters:

sql - SQL.

onlyPickable - If true, the cursor only has socials that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialTableSchema

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

Gets the table schema of the queued social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordAllCalls

boolean getRecordAllCalls()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

If true, all calls of the agents will be recorded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordAllScreens

boolean getRecordAllScreens()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

If true, all screens of the agents will be recorded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailCount

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

Gets the count of the sent email.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailTableSchema

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

Gets the table schema of the sent email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialCount

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

Gets the count of the sent social.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialTableSchema

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

Gets the table schema of the sent social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getService

IService getService()
             throws Exception,
altitude.integrationServer.exceptions.ISException

Service of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkillProfileInfo

SkillProfileMediaInfo getSkillProfileInfo(String skillProfileName)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about agents working with a skill profile.

Parameters:

skillProfileName - Name of the skill profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkillProfileInfoByMediaId

SkillProfileMediaInfo getSkillProfileInfoByMediaId(String skillProfileName,
 int mediaId)
                                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about agents working with a skill profile.

Parameters:

skillProfileName - Name of the skill profile.

mediaId - Identifier of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkillProfileInfoByMediaName

SkillProfileMediaInfo getSkillProfileInfoByMediaName(String skillProfileName,
 String mediaName)
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about agents working with a skill profile.

Parameters:

skillProfileName - Name of the skill profile.

mediaName - Name of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

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

State of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getType

CampaignType getType()
              throws Exception,
altitude.integrationServer.exceptions.ISException

Type of campaign

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkingAgents

AgentInCampaignInfo[] getWorkingAgents()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the agents working in this campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkingAgentsMedia

AgentInCampaignMediaInfo[] getWorkingAgentsMedia(int mediaId)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets media information about the agents working in this campaign.

Parameters:

mediaId - Identifier of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isInDoNotCallList

boolean isInDoNotCallList(String number,
 String uniqueId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Checks if a number is in the campaign service do not call list, or in the global do not call lists.

Parameters:

number - The phone number. This parameter is optional.

uniqueId - Unique identifier of the contact profile. This parameter is optional.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newContactCursor

IContactCursor newContactCursor(int directoryId,
 String[] columns,
 String sql)
                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact cursor.

Parameters:

directoryId - Identifier of the directory. If > 0 then the contact profile extension attributes are fetched.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactCursor

IContactCursor newContactCursor(int directoryId,
 String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact cursor.

Parameters:

directoryId - Identifier of the directory. If > 0 then the contact profile extension attributes are fetched.

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The IContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileInProgressWorkflowCursor

IContactProfileInProgressWorkflowCursor newContactProfileInProgressWorkflowCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile in progress workflow process task cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileInProgressWorkflowCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileInteractionHistoryCursor

IContactProfileInteractionHistoryCursor newContactProfileInteractionHistoryCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql,
 boolean fetchOutcomes)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile interaction history cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

fetchOutcomes - If true, the outcomes of each interaction are also fetched from the database. If false, the fetched InteractionThreadScriptSession.Outcome is null.

Returns:

The IContactProfileInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newInteractionThreadCursor

IInteractionThreadCursor newInteractionThreadCursor(int contactId,
 String[] columns,
 String sql)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an interaction thread cursor.

Parameters:

contactId - Identifier of the contact.

columns - Columns to fetch.

sql - SQL.

Returns:

The IInteractionThreadCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPendingWorkCursor

IPendingWorkCursor newPendingWorkCursor(String agentName,
 String[] columns,
 String sql,
 boolean onlyActivitiesWithAgent)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a pending work cursor.

Parameters:

agentName - Name of the agent.

columns - Columns to fetch.

sql - SQL.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPendingWorkCursor

IPendingWorkCursor newPendingWorkCursor(String agentName,
 String[] columns,
 String sql,
 boolean onlyActivitiesWithAgent,
 PurposeFilter purposeFilter)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a pending work cursor.

Parameters:

agentName - Name of the agent.

columns - Columns to fetch.

sql - SQL.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

purposeFilter - Purpose filter.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns,
 String sql,
 boolean onlyPickable)
                                                     throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued agent pick up task cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyPickable - If true, the cursor only has tasks that the agent can pick up.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns,
 String sql,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                                     throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued agent pick up task cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyPickable - If true, the cursor only has tasks that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedEmailCursor

IQueuedEmailCursor newQueuedEmailCursor(String[] columns,
 String sql,
 boolean onlyPickable)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedEmailCursor

IQueuedEmailCursor newQueuedEmailCursor(String[] columns,
 String sql,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedSocialCursor

IQueuedSocialCursor newQueuedSocialCursor(String[] columns,
 String sql,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued social cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyPickable - If true, the cursor only has socials that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentEmailCursor

ISentEmailCursor newSentEmailCursor(String[] columns,
 String sql)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentEmailCursor

ISentEmailCursor newSentEmailCursor(String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentSocialCursor

ISentSocialCursor newSentSocialCursor(String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent social cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The ISentSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

restartContact

void restartContact(int contactId)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Restarts an existing contact. The status of the contact will be Started.

Parameters:

contactId - Identifier of the contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

scheduleContact

int scheduleContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 Duration rescheduleTimeLimit,
 int directoryId,
 int contactProfileId,
 GregorianCalendar scheduleMoment,
 String agentName,
 int priority,
 String outboundRule,
 boolean usesDoNotCallList,
 String skillProfileName,
 SkillInProfile[] skills)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Schedules a contact for a contact profile. The state of the contact will be Started.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

rescheduleTimeLimit - Limit moment for the reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

scheduleMoment - Schedule moment.

agentName - Name of the agent.

priority - Relative priority.

outboundRule - Outbound rule.

usesDoNotCallList - If true, the do not call list is used.

skillProfileName - Name of the agent skill profile required to handle the contact.

skills - Optional agent skills required to handle the new contact. This parameter will be ignored if the skillProfileName is specified.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

scheduleContact

int scheduleContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 Duration rescheduleTimeLimit,
 int directoryId,
 int contactProfileId,
 GregorianCalendar scheduleMoment,
 String agentName,
 int priority,
 String outboundRule,
 boolean usesDoNotCallList,
 String skillProfileName,
 SkillInProfile[] skills,
 String contactListName)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Schedules a contact for a contact profile. The state of the contact will be Started.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

rescheduleTimeLimit - Limit moment for the reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

scheduleMoment - Schedule moment.

agentName - Name of the agent.

priority - Relative priority.

outboundRule - Outbound rule.

usesDoNotCallList - If true, the do not call list is used.

skillProfileName - Name of the agent skill profile required to handle the contact.

skills - Optional agent skills required to handle the new contact. This parameter will be ignored if the skillProfileName is specified.

contactListName - Name of the contact list where the contact will be created.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

scheduleContact

int scheduleContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 String reschedulePhoneScheduleRule,
 Duration rescheduleTimeLimit,
 int directoryId,
 int contactProfileId,
 GregorianCalendar scheduleMoment,
 String agentName,
 int priority,
 String outboundRule,
 boolean usesDoNotCallList,
 String skillProfileName,
 SkillInProfile[] skills,
 String contactListName)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Schedules a contact for a contact profile. The state of the contact will be Started.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

reschedulePhoneScheduleRule - Reschedule phone schedule rule.

rescheduleTimeLimit - Limit moment for the reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

scheduleMoment - Schedule moment.

agentName - Name of the agent.

priority - Relative priority.

outboundRule - Outbound rule.

usesDoNotCallList - If true, the do not call list is used.

skillProfileName - Name of the agent skill profile required to handle the contact.

skills - Optional agent skills required to handle the new contact. This parameter will be ignored if the skillProfileName is specified.

contactListName - Name of the contact list where the contact will be created.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

scheduleContact

int scheduleContact(Attribute[] attributes,
 String timeZone,
 String reschedulePhone,
 String reschedulePhoneScheduleRule,
 Duration rescheduleTimeLimit,
 int directoryId,
 int contactProfileId,
 GregorianCalendar scheduleMoment,
 String agentName,
 int priority,
 String outboundRule,
 boolean usesDoNotCallList,
 String skillProfileName,
 SkillInProfile[] skills,
 String contactListName,
 String serviceAniListName)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Schedules a contact for a contact profile. The state of the contact will be Started.

Parameters:

attributes - Attributes of the new contact.

timeZone - Time zone of the contact.

reschedulePhone - Phone to reschedule.

reschedulePhoneScheduleRule - Reschedule phone schedule rule.

rescheduleTimeLimit - Limit moment for the reschedule.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

scheduleMoment - Schedule moment.

agentName - Name of the agent.

priority - Relative priority.

outboundRule - Outbound rule.

usesDoNotCallList - If true, the do not call list is used.

skillProfileName - Name of the agent skill profile required to handle the contact.

skills - Optional agent skills required to handle the new contact. This parameter will be ignored if the skillProfileName is specified.

contactListName - Name of the contact list where the contact will be created.

serviceAniListName - Name of the service ANI list to use when dialing to the contact.

Returns:

Identifier of the new contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendData

String sendData(String agentName,
 Attribute[] attrs)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Sends data to the agent.

Parameters:

agentName - Name of the agent.

attrs - Attributes to send.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactCursor

IContactCursor tryGetContactCursor(int cursorId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

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

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException