Bottender Documentation

This example demonstrates how to perform message management actions for a Slack bot, specifically:

• Updating a message previously sent by the bot.
• Deleting a message previously sent by the bot.

For detailed API implementation details, refer to the official Slack guides.

This example demonstrates how to implement a game bot on Telegram. The implementation covers the following core functionalities:

• Sending a game to a user.
• Setting a user's game score.
• Sharing the game to a different chat.

Note: You must create a new Telegram game via the Telegram Bot API#Games documentation to use this functionality.

In a Bottender Slack application, you can identify if an incoming event is a text message by checking the context.event.isText boolean property. To access the actual string content of the message, use context.event.text.

async function App(context) {
  if (context.event.isText) {
    // handling the text message event
    await context.sendText(`received the text message: ${context.event.text}`);
  }
}

You can obtain a LineClient instance in two ways:

1. Using getClient: Import getClient from bottender and pass 'line' as the argument.
2. From the context object: If you are inside an action, the context.client property is automatically a LineClient instance if the platform is line.

Use this instance to interact with the LINE Messaging API (e.g., sending text messages).

const { getClient } = require('bottender');

// Method 1: Using getClient
const client = getClient('line');
await client.pushText(USER_ID, 'Hello!');

// Method 2: Using context in an action
async function MyAction(context) {
  if (context.platform === 'line') {
    await context.client.pushText(USER_ID, 'Hello!');
  }
}

To run the Telegram Hello World example, download the example directory, install dependencies, and configure your environment variables. You must provide a TELEGRAM_ACCESS_TOKEN in a .env file.

1. Download and enter the directory:

curl https://codeload.github.com/Yoctol/bottender/tar.gz/master | tar -xz --strip=2 bottender-master/examples/telegram-hello-world
cd telegram-hello-world

2. Install dependencies:

npm install

3. Configure .env with your TELEGRAM_ACCESS_TOKEN.
4. Start the development server:

npm run dev

Running npm run dev starts a server at http://localhost:5000 and outputs a webhook URL (e.g., https://xxxxxxxx.ngrok.io/webhooks/telegram) to the terminal.

You can enable Slack in Bottender using a new project or an existing one.

New Projects

Use the create-bottender-app CLI and select the slack option during setup:

npx create-bottender-app my-app

Existing Projects

Update your bottender.config.js to include the slack channel configuration. Ensure enabled is set to true.

module.exports = {
  channels: {
    slack: {
      enabled: true,
      path: '/webhooks/slack',
      accessToken: process.env.SLACK_ACCESS_TOKEN,
      signingSecret: process.env.SLACK_SIGNING_SECRET,
      // verificationToken: process.env.SLACK_VERIFICATION_TOKEN, // deprecated, use signingSecret
    },
  },
};

Payload events are triggered by postback buttons on template, imagemap, flex messages, rich menus, or quick replies. Identify them using context.event.isPayload and access the data via context.event.payload.

async function App(context) {
  if (context.event.isPayload) {
    // handling the payload event
    await context.sendText(`received the payload: ${context.event.payload}`);
  }
}

To enable LINE in an existing project, update your bottender.config.js file. You must set channels.line.enabled to true.

By default, the server listens for LINE webhooks on /webhooks/line, but you can customize this using the path property. It is recommended to use environment variables for accessToken and channelSecret to keep credentials secure.

module.exports = {
  channels: {
    line: {
      enabled: true,
      path: '/webhooks/line',
      accessToken: process.env.LINE_ACCESS_TOKEN,
      channelSecret: process.env.LINE_CHANNEL_SECRET,
    },
  },
};