Interface ISession

All Superinterfaces:
IDisposable, IEntity
public interface ISession extends IEntity
Represents a session.

  • Method Details

    • addDataTransactionStartedListener

      void addDataTransactionStartedListener(DataTransactionStartedListener listener)
      Registers the DataTransactionStartedListener.
      Parameters:
      listener - Event listener to add.

    • removeDataTransactionStartedListener

      void removeDataTransactionStartedListener(DataTransactionStartedListener listener)
      Unregisters the DataTransactionStartedListener.
      Parameters:
      listener - Event listener to remove.

    • addInstantMessagingInteractionStartedListener

      void addInstantMessagingInteractionStartedListener(InstantMessagingInteractionStartedListener listener)
      Registers the InstantMessagingInteractionStartedListener.
      Parameters:
      listener - Event listener to add.

    • removeInstantMessagingInteractionStartedListener

      void removeInstantMessagingInteractionStartedListener(InstantMessagingInteractionStartedListener listener)
      Unregisters the InstantMessagingInteractionStartedListener.
      Parameters:
      listener - Event listener to remove.

    • addPhoneInteractionStartedListener

      void addPhoneInteractionStartedListener(PhoneInteractionStartedListener listener)
      Registers the PhoneInteractionStartedListener.
      Parameters:
      listener - Event listener to add.

    • removePhoneInteractionStartedListener

      void removePhoneInteractionStartedListener(PhoneInteractionStartedListener listener)
      Unregisters the PhoneInteractionStartedListener.
      Parameters:
      listener - Event listener to remove.

    • addSessionClearedListener

      void addSessionClearedListener(SessionClearedListener listener)
      Registers the SessionClearedListener.
      Parameters:
      listener - Event listener to add.

    • removeSessionClearedListener

      void removeSessionClearedListener(SessionClearedListener listener)
      Unregisters the SessionClearedListener.
      Parameters:
      listener - Event listener to remove.

    • callSupervisor

      CallSupervisorResult callSupervisor(String campaignName, int directoryId, int contactProfileId, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Calls the supervisor and returns the phone media object created or updated.
      Parameters:
      campaignName - Name of the campaign that needs help from the supervisor.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A CallSupervisorResult object with result.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • callSupervisorMedia

      CallSupervisorResult callSupervisorMedia(int mediaId, String campaignName, int directoryId, int contactProfileId, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Calls the supervisor and returns the phone media object created or updated.
      Parameters:
      mediaId - Identifier of the media.
      campaignName - Name of the campaign that needs help from the supervisor.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A CallSupervisorResult object with result.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailDocument

      int forwardEmailDocument(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Forwards an email with document.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailDocument

      int forwardEmailDocument(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Forwards an email with document.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailDocumentMedia

      int forwardEmailDocumentMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Forwards an email with document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailDocumentMedia

      int forwardEmailDocumentMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Forwards an email with document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailText

      int forwardEmailText(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Forwards an email with text.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forwardEmailTextMedia

      int forwardEmailTextMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int emailId, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with text.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getAgent

      IAgent getAgent() throws Exception, altitude.integrationServer.exceptions.ISException
      The agent associated with the session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getAllowedOperations

      SessionCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISException
      Operations that the agent can perform in the session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getCreationMode

      SessionCreationMode getCreationMode() throws Exception, altitude.integrationServer.exceptions.ISException
      The session creation mode.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getCurrentInfo

      SessionInfo getCurrentInfo() throws Exception, altitude.integrationServer.exceptions.ISException
      The current session info.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getDataTransaction

      IDataTransaction getDataTransaction() throws Exception, altitude.integrationServer.exceptions.ISException
      Data transaction associated with the session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getEmailMedia

      IEmailMedia getEmailMedia() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the email media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getGuiId

      int getGuiId() throws Exception, altitude.integrationServer.exceptions.ISException
      Identifier of the session GUI.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getGuiText

      GuiText getGuiText() throws Exception, altitude.integrationServer.exceptions.ISException
      The session GUI text.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getGuiText

      GuiText getGuiText(PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the session GUI text.
      Parameters:
      purposeFilter - Purpose filter.
      Returns:
      The session GUI text.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getId

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

    • getInitialDirection

      SessionDirection getInitialDirection() throws Exception, altitude.integrationServer.exceptions.ISException
      The initial session direction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getInitialInfo

      SessionInfo getInitialInfo() throws Exception, altitude.integrationServer.exceptions.ISException
      The initial session info.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getInstantMessagingMedia

      IInstantMessagingMedia getInstantMessagingMedia() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the instant messaging media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getPhoneMedia

      IPhoneMedia getPhoneMedia() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the phone media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSocialMedia

      ISocialMedia getSocialMedia() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the social media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getStartTime

      GregorianCalendar getStartTime() throws Exception, altitude.integrationServer.exceptions.ISException
      Start time of the session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getStatisticalData

      StatisticalData getStatisticalData() throws Exception, altitude.integrationServer.exceptions.ISException
      Data statistics when the session is created, or when a data transaction is restarted whithin the session.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getWorkflowMedia

      IWorkflowMedia getWorkflowMedia() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the workflow media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • instantMessagingConnect

      IInstantMessagingMedia instantMessagingConnect(String agentName, String campaignName, boolean differentInstance, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new instant messaging interaction.
      Parameters:
      agentName - Name of the agent.
      campaignName - Target campaign of the operation. The value can be NULL.
      differentInstance - If true, the operation has a different instance as destination.
      attributes - Attributes attached to the instant messaging interaction. The value can be NULL.
      blindData - Data stream transferred with the instant messaging interaction. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new instant messaging interaction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • instantMessagingConnectMedia

      IInstantMessagingMedia instantMessagingConnectMedia(int mediaId, String agentName, String campaignName, boolean differentInstance, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new instant messaging interaction.
      Parameters:
      mediaId - Identifier of the media.
      agentName - Name of the agent.
      campaignName - Target campaign of the operation. The value can be NULL.
      differentInstance - If true, the operation has a different instance as destination.
      attributes - Attributes attached to the instant messaging interaction. The value can be NULL.
      blindData - Data stream transferred with the instant messaging interaction. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new instant messaging interaction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • instantMessagingConnectMediaToAddress

      IInstantMessagingMedia instantMessagingConnectMediaToAddress(int mediaId, String fromAddress, String toAddress, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new instant messaging interaction. This Session must have DataTransaction.
      Parameters:
      mediaId - Identifier of the media.
      fromAddress - Address of the sender. The value must match a dnis configured in the InstantMessaging gateway assigned to the Campaign of the DataTransaction of this Session, and an entry point configured in the Media Channels Service.
      toAddress - Address of the contact.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new instant messaging interaction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • isInDoNotCallList

      boolean isInDoNotCallList(String number, String uniqueId) throws Exception, altitude.integrationServer.exceptions.ISException
      If the session has data, checks if a number is in the session service do not call list, or in the global do not call lists. If the session has no data, checks if a number is 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

    • newDataTransaction

      IDataTransaction newDataTransaction(String campaignName) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a data transaction associated with this session for the specified campaign.
      Parameters:
      campaignName - Name of the campaign.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • phoneDial

      IPhoneMedia phoneDial(String agentName, String number, String campaignName, boolean differentInstance, boolean usesDoNotCallList, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new phone call.
      Parameters:
      agentName - Name of the agent.
      number - Phone number.
      campaignName - Target campaign of the operation dial. The value can be NULL.
      differentInstance - If true, the operation dial has a different instance as destination.
      usesDoNotCallList - If true, the do not call list is used.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new phone call.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • phoneDial

      IPhoneMedia phoneDial(String agentName, String number, String campaignName, boolean differentInstance, boolean usesDoNotCallList, String uniqueIdInDoNotCallList, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new phone call.
      Parameters:
      agentName - Name of the agent.
      number - Phone number.
      campaignName - Target campaign of the operation dial. The value can be NULL.
      differentInstance - If true, the operation dial has a different instance as destination.
      usesDoNotCallList - If true, the do not call list is used.
      uniqueIdInDoNotCallList - Unique identifier of the contact profile to look in the do not call list. This parameter is optional, and will only be considered if usesDoNotCallList is true.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new phone call.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • phoneDialMedia

      IPhoneMedia phoneDialMedia(int mediaId, String agentName, String number, String campaignName, boolean differentInstance, boolean usesDoNotCallList, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new phone call.
      Parameters:
      mediaId - Identifier of the media.
      agentName - Name of the agent.
      number - Phone number.
      campaignName - Target campaign of the operation dial. The value can be NULL.
      differentInstance - If true, the operation dial has a different instance as destination.
      usesDoNotCallList - If true, the do not call list is used.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new phone call.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • phoneDialMedia

      IPhoneMedia phoneDialMedia(int mediaId, String agentName, String number, String campaignName, boolean differentInstance, boolean usesDoNotCallList, String uniqueIdInDoNotCallList, Attribute[] attributes, byte[] blindData, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts a new phone call.
      Parameters:
      mediaId - Identifier of the media.
      agentName - Name of the agent.
      number - Phone number.
      campaignName - Target campaign of the operation dial. The value can be NULL.
      differentInstance - If true, the operation dial has a different instance as destination.
      usesDoNotCallList - If true, the do not call list is used.
      uniqueIdInDoNotCallList - Unique identifier of the contact profile to look in the do not call list. This parameter is optional, and will only be considered if usesDoNotCallList is true.
      attributes - Attributes attached to the phone call. The value can be NULL.
      blindData - Data stream transferred with the phone call. The value can be NULL.
      synchronous - If true, the method is synchronous.
      Returns:
      A IPhoneMedia object with the new phone call.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailDocument

      int replyEmailDocument(String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with document.
      Parameters:
      sendFrom - Email senders.
      replyAll - If true, the reply will be forwarded to all recipients.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailDocument

      int replyEmailDocument(String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with document.
      Parameters:
      sendFrom - Email senders.
      replyAll - If true, the reply will be forwarded to all recipients.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailDocumentMedia

      int replyEmailDocumentMedia(int mediaId, String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      replyAll - If true, the reply will be forwarded to all recipients.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailDocumentMedia

      int replyEmailDocumentMedia(int mediaId, String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      replyAll - If true, the reply will be forwarded to all recipients.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailText

      int replyEmailText(String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with text.
      Parameters:
      sendFrom - Email senders.
      replyAll - Reply all.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Optional subject.
      emailId - Identifier of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • replyEmailTextMedia

      int replyEmailTextMedia(int mediaId, String sendFrom, boolean replyAll, String sendTo, String sendCc, String sendBcc, String subject, int emailId, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Replies to an email with text.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      replyAll - If true, the reply will be forwarded to all recipients.
      sendTo - Optional sendTo.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      emailId - Identifier of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailDocument

      int sendEmailDocument(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with a document.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailDocument

      int sendEmailDocument(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with a document.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - optional subject
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailDocumentMedia

      int sendEmailDocumentMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with a media document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailDocumentMedia

      int sendEmailDocumentMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, int kBDocumentId, Attachment[] attachments, Attribute[] attributes, int directoryId, int contactProfileId, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with a media document.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      kBDocumentId - Identifier of the knowledge base document.
      attachments - Attachments.
      attributes - Attributes attached to the phone call. The value can be NULL.
      directoryId - Identifier of the directory.
      contactProfileId - Identifier of the contact profile.
      purposeFilter - Purpose filter.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailMime

      int sendEmailMime(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, byte[] mime) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email encoded in MIME format and returns the identifier of the email.
      Parameters:
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      mime - MIME message of the email.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailMimeMedia

      int sendEmailMimeMedia(int mediaId, String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, byte[] mime) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email encoded in MIME format and returns the identifier of the email.
      Parameters:
      mediaId - The identifier of the media.
      sendFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      mime - MIME message of the email.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailText

      int sendEmailText(String sentFrom, String sendTo, String sendCc, String sendBcc, String subject, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with text.
      Parameters:
      sentFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendEmailTextMedia

      int sendEmailTextMedia(int mediaId, String sentFrom, String sendTo, String sendCc, String sendBcc, String subject, BodyType bodyType, String body, Attachment[] attachments) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an email with attachments.
      Parameters:
      mediaId - The identifier of the media.
      sentFrom - Email senders.
      sendTo - Email receivers.
      sendCc - Courtesy copy receivers.
      sendBcc - Blind courtesy copy receivers.
      subject - Subject of the email.
      bodyType - Type of the body of the email.
      body - Text body of the email.
      attachments - Attachments.
      Returns:
      The identifier of the email.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendIMMessage

      String sendIMMessage(String mediaName, String campaignName, String fromAddress, String to, String message) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends a text IM Message(outbound direction).
      Parameters:
      mediaName - The media name.
      campaignName - The campaign name.
      fromAddress - The from address.
      to - The destination address.
      message - The text message.
      Returns:
      The interaction key.

      When the media is a whatsapp media, the text message only reaches the client if the from address has received a message from the destination in the last 24h, otherwise the SendIMTemplatedMessage method must be used.

      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • sendIMTemplatedMessage

      String sendIMTemplatedMessage(String mediaName, String campaignName, String fromAddress, String to, String templateNamespace, String templateName, String language, TemplateParameter[] headerTemplateData, TemplateParameter[] bodyTemplateData, TemplateParameter[] footerTemplateData) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends a templated IM Message(outbound direction, typically for WhatsApp media).
      Parameters:
      mediaName - The media name.
      campaignName - The campaign name.
      fromAddress - The from address.
      to - The destination address.
      templateNamespace - The template namespace(for some providers it is optional).
      templateName - The template name.
      language - The template language.
      headerTemplateData - The parameters to be applied in the header template section.
      bodyTemplateData - The parameters to be applied in the body template section>.
      footerTemplateData - The parameters to be applied in the footer template section.
      Returns:
      The interaction key.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • startOutboundSocialInteraction

      String startOutboundSocialInteraction(int mediaId, String campaignName, String sendFrom, String sendTo, boolean agentIsBusy, String contentType, byte[] data) throws Exception, altitude.integrationServer.exceptions.ISException
      Sends an social document and returns the identifier of the social document.
      Parameters:
      mediaId - The identifier of the media.
      campaignName - Name of the campaign where the interaction will be created.
      sendFrom - Social senders.
      sendTo - Social receivers.
      agentIsBusy - If true, the agent is busy.
      contentType - Content type.
      data - Data of the social.
      Returns:
      The identifier of the social interaction key.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • unreserveAgent

      void unreserveAgent(boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Ends the reservation associated with the session.
      Parameters:
      synchronous - If true, the method is synchronous.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException