Member
Member is an object that exists in our database, which contains the information about the chatbot member, which can be accessed by this as this.member. When all the redirected nodes are executed, the botMeta, meta, customLocale and group fields will be patched to the member object in the database. The updated member object will be in this scope when WOZTELL receives the next message event from the member.
Example
this.member.firstName
// => "TEXT"
| Property | Type | Description |
|---|---|---|
| _id | BSON | Primary key of the field |
| externalId | String | Member's ID in 3rd party database |
| app | String | The App's / Organizations ID |
| channel | String | Channel's ID |
| platform | String | Channel that the member is in |
| botId | String | Integration specific id |
| botMeta | Object | Allow the temporary storage of Data. This contains information about the chatbot status of the member. For example, this.member.botMeta.liveChat is a boolean indicating the live chat status of the member, this.member.botMeta.nodeCompositeId and this.member.botMeta.tree are strings indicating the current location of the member, this.member.botMeta.tempData is an object to store temporary data, usually for later uses when the member continues on the chatbot flow. |
| meta | Object | Allow the storage of data |
| tags | [String] | The labels that classify the members |
| firstName | String | Optional Member's first name |
| lastName | String | Optional Member's last name |
| gender | String | Optional Member's gender |
| locale | String | Optional This is a string representing the language used by the member in a 3rd party system. If the language needs to be changed within the chatbot flow, this.member.customLocale can be edited to reflect the new language. The string should match one of the Language Groups set in WOZTELL. The customLocale will overwrite the locale when WOZTELL is selecting the language specific responses to send to the member. |
| customLocale | String | The language of the member uses. This value needs to be updated through actions inside nodes. |
| profilePic | String | Optional URL of a member's profile picture |
| createdAt | Long | The timestamp of creation of this data |
| updatedAt | Long | The timestamp of the last update of this data |
| etag | String | The id that is used to match the data version |
botMeta object
| Property | Type | Description |
|---|---|---|
| tree | String | Optional Tree that the member is located at |
| nodeCompositeId | String | Optional Location of the member in the bot flow |
| subscribe | Boolean | Status of the member is subscribed to push notification |
| liveChat | Boolean | Status of the live chat |
| tempData | Object | Optional Allow the temporary storage of Data |