Class Contact


  • public final class Contact
    extends java.lang.Object
    • Method Detail

      • getType

        public java.util.Optional<java.lang.String> getType()
        Returns:
        The type of object.
      • getId

        public java.lang.String getId()
        Returns:
        The unique identifier for the contact which is given by Intercom.
      • getExternalId

        public java.util.Optional<java.lang.String> getExternalId()
        Returns:
        The unique identifier for the contact which is provided by the Client.
      • getWorkspaceId

        public java.lang.String getWorkspaceId()
        Returns:
        The id of the workspace which the contact belongs to.
      • getRole

        public java.lang.String getRole()
        Returns:
        The role of the contact.
      • getEmail

        public java.util.Optional<java.lang.String> getEmail()
        Returns:
        The contact's email.
      • getEmailDomain

        public java.util.Optional<java.lang.String> getEmailDomain()
        Returns:
        The contact's email domain.
      • getPhone

        public java.util.Optional<java.lang.String> getPhone()
        Returns:
        The contacts phone.
      • getFormattedPhone

        public java.util.Optional<java.lang.String> getFormattedPhone()
        Returns:
        The contacts phone number normalized to the E164 format
      • getName

        public java.util.Optional<java.lang.String> getName()
        Returns:
        The contacts name.
      • getOwnerId

        public java.util.Optional<java.lang.Integer> getOwnerId()
        Returns:
        The id of an admin that has been assigned account ownership of the contact.
      • getHasHardBounced

        public boolean getHasHardBounced()
        Returns:
        Whether the contact has had an email sent to them hard bounce.
      • getMarkedEmailAsSpam

        public boolean getMarkedEmailAsSpam()
        Returns:
        Whether the contact has marked an email sent to them as spam.
      • getUnsubscribedFromEmails

        public boolean getUnsubscribedFromEmails()
        Returns:
        Whether the contact is unsubscribed from emails.
      • getCreatedAt

        public int getCreatedAt()
        Returns:
        (UNIX timestamp) The time when the contact was created.
      • getUpdatedAt

        public int getUpdatedAt()
        Returns:
        (UNIX timestamp) The time when the contact was last updated.
      • getSignedUpAt

        public java.util.Optional<java.lang.Integer> getSignedUpAt()
        Returns:
        (UNIX timestamp) The time specified for when a contact signed up.
      • getLastSeenAt

        public java.util.Optional<java.lang.Integer> getLastSeenAt()
        Returns:
        (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
      • getLastRepliedAt

        public java.util.Optional<java.lang.Integer> getLastRepliedAt()
        Returns:
        (UNIX timestamp) The time when the contact last messaged in.
      • getLastContactedAt

        public java.util.Optional<java.lang.Integer> getLastContactedAt()
        Returns:
        (UNIX timestamp) The time when the contact was last messaged.
      • getLastEmailOpenedAt

        public java.util.Optional<java.lang.Integer> getLastEmailOpenedAt()
        Returns:
        (UNIX timestamp) The time when the contact last opened an email.
      • getLastEmailClickedAt

        public java.util.Optional<java.lang.Integer> getLastEmailClickedAt()
        Returns:
        (UNIX timestamp) The time when the contact last clicked a link in an email.
      • getLanguageOverride

        public java.util.Optional<java.lang.String> getLanguageOverride()
        Returns:
        A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.
      • getBrowser

        public java.util.Optional<java.lang.String> getBrowser()
        Returns:
        The name of the browser which the contact is using.
      • getBrowserVersion

        public java.util.Optional<java.lang.String> getBrowserVersion()
        Returns:
        The version of the browser which the contact is using.
      • getBrowserLanguage

        public java.util.Optional<java.lang.String> getBrowserLanguage()
        Returns:
        The language set by the browser which the contact is using.
      • getOs

        public java.util.Optional<java.lang.String> getOs()
        Returns:
        The operating system which the contact is using.
      • getAndroidAppName

        public java.util.Optional<java.lang.String> getAndroidAppName()
        Returns:
        The name of the Android app which the contact is using.
      • getAndroidAppVersion

        public java.util.Optional<java.lang.String> getAndroidAppVersion()
        Returns:
        The version of the Android app which the contact is using.
      • getAndroidDevice

        public java.util.Optional<java.lang.String> getAndroidDevice()
        Returns:
        The Android device which the contact is using.
      • getAndroidOsVersion

        public java.util.Optional<java.lang.String> getAndroidOsVersion()
        Returns:
        The version of the Android OS which the contact is using.
      • getAndroidSdkVersion

        public java.util.Optional<java.lang.String> getAndroidSdkVersion()
        Returns:
        The version of the Android SDK which the contact is using.
      • getAndroidLastSeenAt

        public java.util.Optional<java.lang.Integer> getAndroidLastSeenAt()
        Returns:
        (UNIX timestamp) The time when the contact was last seen on an Android device.
      • getIosAppName

        public java.util.Optional<java.lang.String> getIosAppName()
        Returns:
        The name of the iOS app which the contact is using.
      • getIosAppVersion

        public java.util.Optional<java.lang.String> getIosAppVersion()
        Returns:
        The version of the iOS app which the contact is using.
      • getIosDevice

        public java.util.Optional<java.lang.String> getIosDevice()
        Returns:
        The iOS device which the contact is using.
      • getIosOsVersion

        public java.util.Optional<java.lang.String> getIosOsVersion()
        Returns:
        The version of iOS which the contact is using.
      • getIosSdkVersion

        public java.util.Optional<java.lang.String> getIosSdkVersion()
        Returns:
        The version of the iOS SDK which the contact is using.
      • getIosLastSeenAt

        public java.util.Optional<java.lang.Integer> getIosLastSeenAt()
        Returns:
        (UNIX timestamp) The last time the contact used the iOS app.
      • getCustomAttributes

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getCustomAttributes()
        Returns:
        The custom attributes which are set for the contact.
      • getAvatar

        public java.util.Optional<java.lang.String> getAvatar()
        Returns:
        An image URL containing the avatar of a contact.
      • getTags

        public java.util.Optional<ContactTags> getTags()
      • getNotes

        public java.util.Optional<ContactNotes> getNotes()
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object