Skip to main content

Channel

The channel object is saved in this as this.channel and contains the information about the chatbot channel. The platform of the channel (e.g. “Facebook”, “WhatsApp” and etc. ) can be found in this.channel.type. It can be useful when building responses for multiple platforms.

Example

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

Facebook info object

Please see the Facebook documentation for further reference.

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 WOZTELL 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 WOZTELL
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 WOZTELL 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 WOZTELL 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 WOZTELL Facebook application
integrationIdstringOptional WhatsApp integration ID
shopCodestringOptional WhatsApp shop code
subscribedbooleanOptional Status of the member is subscribed to push notification
waIdstringWhatsApp business ID

WeChat 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 WOZTELL 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