Channel

Channel is an object that exists in our database, which contains the information about the chat bot channel, which can be accessed by this.channel.

Example

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
meta	string	Allow the storage of data
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

Facebook info object

Please see the [Facebook]https://developers.facebook.com/docs/graph-api/reference/user/accounts/ documentation for further reference.

Property	Type	Description
customApp	boolean	Optional Status of whether it is using Stella Facebook application
fbCommentReply	boolean	Allow the Facebook comment reply or not
subscribed	boolean	Optional Status of the member is subscribed to Stella

Slack info object

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

Teamwork info object

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

Whatsapp info object

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

Wechat 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
localGroups	array<object>	Wechat local groups' information
profilePicUrl	string	URL of Wechat account's profile picture
subscribed	boolean	Status of the member is subscribed to push notification
themeColor	string	Wechat theme color
token	string	Wechat token
webchatIconUrl	string	URL of Wechat account's Wechat icon

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