Interface IService

All Superinterfaces:
IDisposable, IEntity

public interface IService extends IEntity
Represents a service.
  • Method Details

    • addToDoNotCallList

      void addToDoNotCallList(String number) throws Exception, altitude.integrationServer.exceptions.ISException
      Adds the phone number to the do not call list.
      Parameters:
      number - Phone number.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • addToDoNotCallList

      void addToDoNotCallList(String number, String uniqueId, GregorianCalendar expiryDate) throws Exception, altitude.integrationServer.exceptions.ISException
      Adds an entry in the do not call list.
      Parameters:
      number - The phone number to add. This parameter is optional.
      uniqueId - Unique identifier of the contact profile. This parameter is optional.
      expiryDate - Date of the expiration of the do not call list entry. This parameter is optional.

      The number and uniqueId parameters can not be both unspecified.

      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getActivityAttributesTableSchema

      TableSchema getActivityAttributesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the definition of the activity attributes table.
      Returns:
      An array with the definition of each column of the activity attributes table.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getAllowedOperations

      ServiceCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISException
      Allowed operations.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getAniListNames

      String[] getAniListNames() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the names of the ANI lists of the service.
      Returns:
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getCampaignAttributesTableSchema

      TableSchema getCampaignAttributesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the definition of the campaign attributes table.
      Returns:
      An array with the definition of each column of the campaign attributes table.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getCampaignNames

      String[] getCampaignNames(boolean onlyAssignedAndRunning) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the names of the campaigns of the service.
      Parameters:
      onlyAssignedAndRunning - If true, only returns the agent assigned and running campaign names. If false, returns all campaign names.
      Returns:
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getCampaigns

      ICampaign[] getCampaigns(boolean onlyAssignedAndRunning) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the campaigns of the service.
      Parameters:
      onlyAssignedAndRunning - If true, only returns the agent assigned and running campaigns. If false, returns all campaigns.
      Returns:
      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
    • getDefaultDirectory

      Directory getDefaultDirectory() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the default directory.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getDescription

      String getDescription() throws Exception, altitude.integrationServer.exceptions.ISException
      Description of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getId

      int getId() throws Exception, altitude.integrationServer.exceptions.ISException
      Identifier of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getInfo

      ServiceInfo getInfo() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets information about the service.
      Returns:
      The ServiceInfo object.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getInstance

      IInstance getInstance() throws Exception, altitude.integrationServer.exceptions.ISException
      The instance associated to the agent.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getName

      String getName() throws Exception, altitude.integrationServer.exceptions.ISException
      The name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getOutcomes

      OutcomeData[] getOutcomes(int scriptSessionId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the outcomes of the specified script session.
      Parameters:
      scriptSessionId - Identifier of the script session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getOutcomesTableSchema

      TableSchema getOutcomesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the outcomes.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getPendingWorkCount

      int getPendingWorkCount(String agentName, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the pending work.
      Parameters:
      agentName - Name of the agent.
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.
      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 onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the queued agent pick up task.
      Parameters:
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.
      onlyPickable - If true, the cursor only has workflow tasks that the agent can pick up.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getQueuedAgentPickUpTaskTableSchema

      TableSchema getQueuedAgentPickUpTaskTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the queued agent pick up task.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getQueuedEmailCount

      int getQueuedEmailCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the queued email.
      Parameters:
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      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 onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the queued social.
      Parameters:
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.
      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
    • getSentEmailCount

      int getSentEmailCount(String sql, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the sent email.
      Parameters:
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      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, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the sent social.
      Parameters:
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.
      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
    • getState

      ServiceState getState() throws Exception, altitude.integrationServer.exceptions.ISException
      State of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • 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
    • newPendingWorkCursor

      IPendingWorkCursor newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.
      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 onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.
      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 onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.
      onlyPickable - If true, the cursor only has workflow 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 onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.
      onlyPickable - If true, the cursor only has workflow 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 onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a queued email cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      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 onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      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 onlyOpenedCampaigns, 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.
      onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.
      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, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a sent email cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      Returns:
      The ISentEmailCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • newSentEmailCursor

      ISentEmailCursor newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a sent email cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.
      purposeFilter - Purpose filter.
      Returns:
      The ISentEmailCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • newSentSocialCursor

      ISentSocialCursor newSentSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a sent social cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.
      purposeFilter - Purpose filter.
      Returns:
      The ISentSocialCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException