Stella Platform Documentation

Stella Platform Documentation

  • 文档
  • 标准设置程序
  • 参考
  • 常见问题
  • Bot API
  • 接口
  • Languages icon中文
    • English

›参考

开始使用

  • Introduction

参考

  • Message Event
  • Node
  • Member
  • Channel
  • Integrations
  • Agenda Meta
  • Group
  • Methods
  • Radiate.js
  • Access Control List
  • Stella Open API

Channel

频道对象在this中保存为this.channel并包含有关聊天机器人[频道]的信息(https://doc.stella.sanuker.com/docs/en/channels-overview/)。 频道的平台(例如“Facebook”、“WhatsApp”等)可以在this.channel.type中找到。 在为多个平台构建响应时,它会很有用。

例子:

this.channel.type
// => "facebook"
PropertyTypeDescription
_idBSONPrimary key of the field
_versionnumberVersion of the channel
appstringThe App's / Organisation's ID
broadcastGroupsarray<object>Optional Information about broadcast groups
createdAtnumberThe timestamp of creation of this data
descriptionstringChannel's description
etagstringThe timestamp that is used to match the data version
infoobjectChannel's info
metadatastringChannel-wide variables that you could access during runtime
namestringChannel's name
onbooleanStatus of the channel is live or not
priorityGroupsarray<object>Information about priority groups
typestringChannel's type
updatedAtnumberThe timestamp of the last update of this data

脸书 info object

请参阅Facebook文档以获得进一步的参考。

PropertyTypeDescription
accessTokenstringFacebook Fans Page access token
categorystringThe category that you defined for the Facebook Fans Page
category_listarray<object>List of categories
customAppbooleanStatus of whether it is using Stella Facebook application
fbCommentReplybooleanAllow the Facebook comment reply or not
namestringName of the Facebook Fans Page
pageIdstringFacebook Fans Page ID
subscribedbooleanStatus of the member is subscribed to Stella
tasksarray<string>Tasks assigned to the Facebook Fans Page

Slack info object

PropertyTypeDescription
accessTokenstringSlack access token
appAccessTokenstringSlack app access token
botAccessTokenstringSlack bot access token
botIdstringSlack bot ID
customAppbooleanOptional Status of whether it is using Stella Facebook application
signingSecretstringSlack signing secret
subscribedbooleanStatus of whether the user has subscribe the bot
teamIdstringSlack workspace ID
tokenstringSlack token
webhookTokenstringSlack webhook token

Teamwork info object

PropertyTypeDescription
apiKeystringTeamwork api key
apiTokenstringTeamwork api token
customAppbooleanOptional Status of whether it is using Stella Facebook application
envstringApplication environment
moduleKeystringTeamwork module key (api token like token)
subscribedbooleanStatus of the member is subscribed to push notification
tbIdstringTeamwork bot's ID

WhatsApp info object

PropertyTypeDescription
adminAuthTokenstringWhatsApp admin authentication token
adminAuthTokenExpirynumberOptional Timestamp of WhatsApp admin authentication token expiration time
adminPasswordstringWhatsApp admin password
adminUsernamestringWhatsApp admin name
apiPathstringWhatsApp admin URL
brandIdstringOptional WhatsApp brand ID
customAppbooleanOptional Status of whether it is using Stella Facebook application
integrationIdstringOptional WhatsApp integration ID
shopCodestringOptional WhatsApp shop code
subscribedbooleanOptional Status of the member is subscribed to push notification
waIdstringWhatsApp business ID

微信 info object

PropertyTypeDescription
accessTokenstringWeChat access token
accessTokenExpirynumberTimestamp of access token expiration time
appIdstringWeChat app ID
appsecretstringWeChat app secret
botOpenIdstringWeChat bot open ID
customAppbooleanOptional Status of whether it is using Stella Facebook application
JSAPITicketstringWeChat JSAPITicket
JSAPITicketExpirynumberTimestamp of JSAPITicket expiration time
subscribedbooleanStatus of the member is subscribed to push notification

priority groups object

PropertyTypeDescription
coreVersionstringPriority group core version
groupstringName of the priority group
globalNodesarray<string>Global nodes that are included in the priority group
groupGlobalNodesarray<string>Optional Available on WhatsApp only. Global nodes that are included in the group trees for WhatsApp group
groupTreesarray<string>Optional Available on WhatsApp only. Trees that send messages to users in WhatsApp group
offGlobalNodesarray<string>Global nodes that are included in the off trees
offTreesarray<string>Trees that send non-office hour messages to users
treesarray<string>Trees that are included in the priority group

broadcast groups object

PropertyTypeDescription
groupsarray<object>Users that are included in the groups
labelstringName of the broadcast group

broadcast groups' group object

PropertyTypeDescription
idstringUser ID
typestringUser role
← MemberIntegrations →
Stella Platform Documentation
Docs
Get StartedBot API ReferenceAPI ReferenceStandard Procedures
Community
FAQUser ShowcaseChat with Us
Copyright © 2023 Sanuker Inc. Limited