Member
成员是存在于我们数据库中的一个对象，它包含了聊天机器人成员的信息，可以被this访问为this.member。当所有重定向的节点被执行时，botMeta、meta、customLocale和group字段将被修补到数据库中的成员对象。当Stella收到成员的下一个消息事件时，更新的成员对象将在this范围内。
例子:
this.member.firstName
// => "TEXT"
| Property | Type | Description | |
|---|---|---|---|
| _id | BSON | Primary key of the field | |
| app | string | The App's / Organizations ID | |
| admin | string | Optional Admin ID. Only available in live chat (outlet channel) | |
| botId | string | (Facebook) Page ID (WhatsApp) Business Account Phone Number | |
| 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. | |
| channel | string | Channel's ID | |
| createdAt | number | The timestamp of creation of this data | |
| customLocale | string | The language of the member uses. This value needs to be updated through actions inside nodes. | |
| string | Optional Member's email | ||
| etag | string | The timestamp that is used to match the data version | |
| externalId | string | Member's ID in 3rd party database | |
| firstName | string | Optional Member's first name | |
| fbId | string | Optional (Facebook only) Members' Facebook ID | |
| gender | string | Optional (Facebook only) Member's gender | |
| group | string | Optional (WhatsApp only) Member's group ID. It is an ID for the group object of the current group the member is in. | |
| lastName | string | Optional Member's last name | |
| 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 Stella. The customLocale will overwrite the locale when Stella is selecting the language specific responses to send to the member. |
| meta | object | Allow the storage of data | |
| platform | string | Channel that the member is in | |
| profile | object | Member's personal information. This contains the member’s profile, usually captured from a 3rd party system, or provided by the custom channel. | |
| profilePic | string | Optional URL of a member's profile picture | |
| profilePicString | string | Optional A string of member's profile picture | |
| tags | array<string> | The labels that classify the members | |
| updatedAt | number | The timestamp of the last update of this data |
botMeta object
| Property | Type | Description |
|---|---|---|
| liveChat | boolean | Status of the live chat |
| nodeCompositeId | string | Optional Location of the member in the bot flow |
| subscribed | boolean | Status of the member is subscribed to push notification |
| tempData | object | Optional Allow the temporary storage of Data |
| tree | string | Optional Tree that the member is located at |
脸书 profile object
名、姓、个人照片、地域、性别和时区是我们从Facebook获取用户资料的字段。请参阅Facebook文档以获得进一步的参考。
Slackprofile object
请参阅Slack文件以获得进一步的参考。
Teamwork profile object
| Property | Type | Description |
|---|---|---|
| displayName | string | Member's full name |
| firstName | string | Optional Member's first name |
| lastName | string | Optional Member's last name |
| profilePic | string | Optional URL of member's profile picture |
| tbId | number | Teamwork bot's ID |
| username | string | Member's email |
微信 profile object
Please see the WeChat documentation for further reference.
WhatsApp profile object
Coming soon...