Channel
频道对象在this
中保存为this.channel
并包含有关聊天机器人[频道]的信息(https://doc.stella.sanuker.com/docs/en/channels-overview/)。 频道的平台(例如“Facebook”、“WhatsApp”等)可以在this.channel.type
中找到。 在为多个平台构建响应时,它会很有用。
例子:
this.channel.type
// => "facebook"
Property | Type | Description |
---|---|---|
_id | BSON | Primary key of the field |
_version | number | Version of the channel |
app | string | The App's / Organisation's ID |
broadcastGroups | array<object> | Optional Information about broadcast groups |
createdAt | number | The timestamp of creation of this data |
description | string | Channel's description |
etag | string | The timestamp that is used to match the data version |
info | object | Channel's info |
metadata | string | Channel-wide variables that you could access during runtime |
name | string | Channel's name |
on | boolean | Status of the channel is live or not |
priorityGroups | array<object> | Information about priority groups |
type | string | Channel's type |
updatedAt | number | The timestamp of the last update of this data |
info
object
脸书 请参阅Facebook文档以获得进一步的参考。
Property | Type | Description |
---|---|---|
accessToken | string | Facebook Fans Page access token |
category | string | The category that you defined for the Facebook Fans Page |
category_list | array<object> | List of categories |
customApp | boolean | Status of whether it is using Stella Facebook application |
fbCommentReply | boolean | Allow the Facebook comment reply or not |
name | string | Name of the Facebook Fans Page |
pageId | string | Facebook Fans Page ID |
subscribed | boolean | Status of the member is subscribed to Stella |
tasks | array<string> | Tasks assigned to the Facebook Fans Page |
info
object
Slack Property | Type | Description |
---|---|---|
accessToken | string | Slack access token |
appAccessToken | string | Slack app access token |
botAccessToken | string | Slack bot access token |
botId | string | Slack bot ID |
customApp | boolean | Optional Status of whether it is using Stella Facebook application |
signingSecret | string | Slack signing secret |
subscribed | boolean | Status of whether the user has subscribe the bot |
teamId | string | Slack workspace ID |
token | string | Slack token |
webhookToken | string | Slack webhook token |
info
object
Teamwork Property | Type | Description |
---|---|---|
apiKey | string | Teamwork api key |
apiToken | string | Teamwork api token |
customApp | boolean | Optional Status of whether it is using Stella Facebook application |
env | string | Application environment |
moduleKey | string | Teamwork module key (api token like token) |
subscribed | boolean | Status of the member is subscribed to push notification |
tbId | string | Teamwork bot's ID |
info
object
WhatsApp Property | Type | Description |
---|---|---|
adminAuthToken | string | WhatsApp admin authentication token |
adminAuthTokenExpiry | number | Optional Timestamp of WhatsApp admin authentication token expiration time |
adminPassword | string | WhatsApp admin password |
adminUsername | string | WhatsApp admin name |
apiPath | string | WhatsApp admin URL |
brandId | string | Optional WhatsApp brand ID |
customApp | boolean | Optional Status of whether it is using Stella Facebook application |
integrationId | string | Optional WhatsApp integration ID |
shopCode | string | Optional WhatsApp shop code |
subscribed | boolean | Optional Status of the member is subscribed to push notification |
waId | string | WhatsApp business ID |
info
object
微信 Property | Type | Description |
---|---|---|
accessToken | string | WeChat access token |
accessTokenExpiry | number | Timestamp of access token expiration time |
appId | string | WeChat app ID |
appsecret | string | WeChat app secret |
botOpenId | string | WeChat bot open ID |
customApp | boolean | Optional Status of whether it is using Stella Facebook application |
JSAPITicket | string | WeChat JSAPITicket |
JSAPITicketExpiry | number | Timestamp of JSAPITicket expiration time |
subscribed | boolean | Status of the member is subscribed to push notification |
priority groups
object
Property | Type | Description |
---|---|---|
coreVersion | string | Priority group core version |
group | string | Name of the priority group |
globalNodes | array<string> | Global nodes that are included in the priority group |
groupGlobalNodes | array<string> | Optional Available on WhatsApp only. Global nodes that are included in the group trees for WhatsApp group |
groupTrees | array<string> | Optional Available on WhatsApp only. Trees that send messages to users in WhatsApp group |
offGlobalNodes | array<string> | Global nodes that are included in the off trees |
offTrees | array<string> | Trees that send non-office hour messages to users |
trees | array<string> | Trees that are included in the priority group |
broadcast groups
object
Property | Type | Description |
---|---|---|
groups | array<object> | Users that are included in the groups |
label | string | Name of the broadcast group |
broadcast groups' group
object
Property | Type | Description |
---|---|---|
id | string | User ID |
type | string | User role |