Jump to: navigation, search

Facebook Interaction Attributes

Basic Attributes

Genesys Driver for use with Facebook adds the following attributes to an interaction's user data.

Key Name Value Type Description
_facebookDriverVersion UTF string Driver version
_facebookItxType Int
  • 1—Facebook Post and single Comment (if the interaction is a Reply, the parent Comment is also included, as well as all elements in Comment Attributes below).
  • 2—Facebook Post and multiple Comments
_umsChannel UTF String Name of the channel that includes the monitor that submitted the interaction
_umsChannelMonitor UTF String Name of the monitor that submitted the interaction
_umsChannelInfo Key-value list Present if the driver was able to get Publisher information. See _umsChannelInfo Attributes below.
_facebookPostId UTF String Post ID
_facebookContentCreatedOnlyByAdmin Int 0 or 1
_facebookCanComment Int Whether the Comments are (0) or are not (1) allowed on the object.
_facebookNComments UTF string Number of Comments for this Post
_facebookShareCount UTF string Number of times the Post was shared
_facebookPostCanBeDeleted UTF string true or false
_facebookMediaAttachmentsCount Int Number of files attached to the Post
Subject UTF string Subject of the Post, usually taken from Post text itself. If the message in the Post is empty, Subject is taken from the name or description of the first attached file. If that information is missing, Subject is equal to _facebookPostId.
_facebookMessageText UTF string Message in the Post
_facebookNLikes UTF string Number of Likes for the Post
_facebookUpdatedTime UTF string The time, expressed as a UNIX timestamp, that the Post was last updated, which occurs when a User comments on the Post.
_facebookCreatedTime UTF string The time the Post was published, expressed as UNIX timestamp
_facebookSourceId UTF string Facebook ID of the object where this Post was published
_facebookSourceIdType Int Type of the Facebook object that published the Post:
  • 0—User
  • 1—Page
  • 2—Event
  • 3—Group
  • 4—Application
_facebookMonitorRefreshStartTime UTF string Time in milliseconds.
_facebookActorId UTF string Facebook ID of the object that published this Post
_facebookActorIdType Int Type of the Facebook object that published the Post:
  • 0—User
  • 1—Page
  • 2—Event
  • 3—Group
  • 4—Application
_facebookActorName UTF string Name of the Page or User that published the Post. If it is a User (_facebookActorIdType = 0), then in addition to the name, the attributes listed in User Attributes below are also included.
_facebookComments Key-value list The list of key-value pairs provided in facebookComments Attributes below. The key for each list equals the value of _facebookCommentId.

_facebookXML

UTF string An XML string which includes information about all objects that participated in or were mentioned in the Post/Comments/Replies

Private Message Attributes

Key Name Value Type Description
_umsMediaType String Value of configuration option "inbound-media" for monitor. In order to work with Workspace Desktop Edition, the value must be facebooksession.
_umsFromAddr String asdf

_facebookComments Attributes

The value of the _facebookComments attribute: a list of key-value pairs with type Key-value list and keys equal to _facebookCommentId.

Key Name Value Type Comments
_facebookActorId UTF String Facebook ID of the object that published this Comment
_facebookActorIdType int Type of the Facebook object that published the Comment:
  • 0—User
  • 1—Page
  • 2—Event
  • 3—Group
  • 4—Application
_facebookActorName UTF String Name of the Page or User that published the Post. If it is a User (_facebookActorIdType = 0), then in addition to the name, the attributes listed in User Attributes below are also included.
Plus the contents of Comment Attributes below

Here is an example of _facebookComments:

'_facebookComments' [lst] = KVList:
  '744384022244153_8236433' [lst] = KVList:
    '_facebookCommentId' [str] = "'744384022244153_8236433"
    '_facebookCommentParentId' [str] = "0"
    '_facebookText' [str] = "This is a Comment on the Post"
    '_facebookTime' [str] = "1384811057"
    '_facebookCommentNLikes' [str] = "0"
    '_facebookActorId' [str] = "507441822604742"
    '_facebookActorIdType' [int] = 1
    '_facebookActorName' [str] = "Some Page Name"
  '744384022244153_8250812' [lst] = KVList:
    '_facebookCommentId' [str] = "'744384022244153_8250812"
    '_facebookCommentParentId' [str] = "'744384022244153_8236433"
    '_facebookText' [str] = "This is a Reply to the Comment"
    '_facebookTime' [str] = "1385154821"
    '_facebookCommentNLikes' [str] = "10"
    '_facebookActorId' [str] = "100000523748952"
    '_facebookActorIdType' [int] = 0
    '_facebookActorName' [str] = "UserFirstName UserLastName"
    Also all key-value pairs from User Attributes
  '744384022244153_8250813' [lst] = KVList:
    '_facebookCommentId' [str] = "'744384022244153_8250813"
    ...

Comment Attributes

Key Name Value Type Description
_facebookCommentId UTF String Facebook Comment ID
_facebookCommentParentId UTF String Facebook parent Comment ID
_facebookText UTF String The text of the Comment
_facebookTime UTF String UNIX timestamp associated with the creation time of the Comment
_facebookCommentNLikes UTF String The number of likes for the Comment

User Attributes

Key Name Value Type Description
FirstName UTF String
MiddleName UTF String
LastName UTF String
EmailAddress UTF String
_facebookFriendCount int
_facebookWallCount int The number of Wall Posts for the User
_facebookSex UTF String
_facebookBirthdayDate UTF String MM/DD/YYYY
_facebookTimezone UTF String The User’s time zone offset from UTC, from -24 to 24
_facebookLocale UTF String The two-letter language code and the two-letter country code representing the User's locale. Country codes are taken from the ISO 3166 alpha 2 code.
_facebookHomeTownLocation Key-value list The values are all UTF Strings and the keys are as follows:
  • City
  • State
  • Country

These are available only if provided by Facebook.

_facebookCurrentLocation Key-value list The values are all UTF Strings and the keys are as follows:
  • City
  • State
  • Country

These are available only if provided by Facebook.

_facebookLanguages Key-value list This list may be empty. If it is not, the keys represent languages specified by the Facebook User; for example, English, Spanish, or Teochew dialect. Language names are provided as received from Facebook. See the sample below.

Sample of user attributes:

'FirstName' [str] = "UserFirstName"
    'MiddleName' [str] = ""
    'LastName' [str] = "UserLastName"
    'EmailAddress' [str] = "UserLastName @host.com"
    '_facebookFriendCount' [int] = 3
    '_facebookWallCount' [int] = 2
    '_facebookSex' [str] = "male"
    '_facebookBirthdayDate' [str] = "01/01/1971"
    '_facebookTimezone' [str] = "-8"
    '_facebookLocale' [str] = "en_US"
    '_facebookHomeTownLocation' [lst] = KVList:
      'City' [str] = "Home"
      'State' [str] = "Kansas"
      'Country' [str] = "United States"
    '_facebookCurrentLocation' [lst] = KVList:
      'City' [str] = "Cuttack"
      'State' [str] = "Orissa"
      'Country' [str] = "India"
    '_facebookLanguages' [lst] = KVList:
      'U.S. English' [str] = ""
      'Korean' [str] = ""
      ' Teochew dialect ' [str] = ""

_umsChannelInfo Attributes

The value of the _umsChannelInfo attribute: a list of key-value pairs that represent information about the Facebook object on whose behalf Posts/Comment/Replies are published by this particular Monitor.

Key Name Value Type Comments
_facebookSourceId UTF String ID of the Facebook object on whose behalf the Post/Comment/Reply is published
_facebookSourceObjectType UTF String Type of the object on whose behalf the Post/Comment/Reply is published:
  • com.genesyslab.mcr.facebook.fql.Application
  • com.genesyslab.mcr.facebook.fql.User
  • com.genesyslab.mcr.facebook.fql.Page
_facebookSourceNickName UTF String Name of the object
_facebookSourceXML UTF String Information about the object packed in an XML string

Sample:

'_umsChannelInfo' [lst] = KVList:
  'channel-facebook-2-monitor-G-Page-MBAero-Main' [lst] = KVList:
    '_facebookSourceId' [str] = "178227039004532"
    '_facebookSourceObjectType' [str] = "com.genesyslab.mcr.facebook.fql.Page"
    '_facebookSourceNickName' [str] = "Some Page Name"
    '_facebookSourceXML' [str] = "<com.genesyslab.mcr.facebook.fql.Page>"
      <page__id>178227039004532</page__id>
      <name>Some Page</name>
      <pic__small>https://fbcdn-profile-a.akamaihd.net/hprofile-ak-ash1/373048_178227039004532_890644691_t.jpg</pic__small>
      <pic__big>https://fbcdn-profile-a.akamaihd.net/hprofile-ak-ash1/373048_178227039004532_890644691_n.jpg</pic__big>
      <page__url>https://www.facebook.com/SomePage</page__url>
      <type>COMMUNITY</type>
    </com.genesyslab.mcr.facebook.fql.Page>"

category:Social Messaging Server category:eServices Social Media Solution Guide

This page was last edited on November 20, 2018, at 17:35.

Feedback

Comment on this article:

blog comments powered by Disqus