telegram-bot-dialogs

The framework for building dialogs where user answers on given questions. You can easy collect multiple data from user.

Features

• Easy to run Qustion-Answer session with user
• Multiple types of questions
• Interactive values of next questions, based on answers before
• Intarnalization support with customizing on each level of tthe dialog

Usage

The telegram-bot-dialogs uses along with node-telegram-bot-api. See an example of usage:

1import TelegramBot from 'node-telegram-bot-api';
2import {Dialogs} from 'telegram-bot-dialogs';
3
4// Create bot instance
5const bot = new TelegramBot(process.env.TELEGRAM_BOT_TOKEN,{polling:true});
6// Create dialogs instance, based on the bot
7const dialogs = new Dialogs(bot);
8
9// Create dialog instance with list of questions of various types
10const testDialog = dialogs.create([
11  {
12    type:"text",
13    message:"What is your name?",
14    name: 'name'
15  },
16  {
17    type:"datepicker",
18    message:"When you born?",
19    name: 'birthday'
20  },
21  {
22    type:"confirm",
23    message:"Are you shure?",
24    name: 'shure'
25  },
26  {
27    type:"pinpad",
28    message:"What is your phone number?",
29    name: 'phone',
30    mask: "+7 (***) ***-**-**"
31  },
32  {
33    type:"select",
34    name: "sport",
35    message: "What are your favourite sports?",
36    buttons:[
37      ["Soccer"],
38      ["Hockey"],
39      ["Tennis","Squash"],
40    ],
41    multiple: true
42  },
43  {
44    type: "picker",
45    name: "color",
46    message: "Choose yours most loved color.",
47    list:["Pink","Orange","Red","Blue","Green"]
48  }
49]);
50
51bot.onText(/^\/start$/,async(msg) => {
52  // On commad '/start', run dialog session for given chat ID
53  const result = await testDialog.start(msg.chat.id);
54
55  // Get the result, when user will complete all questions.
56  console.log(result);
57  /*
58    You will see something like this:
59    {
60      name: 'John',
61      birthday: 1985-12-03T00:00:00.000Z,
62      shure: true,
63      phone: 9001234567,
64      sport: [ 'Hockey', 'Squash' ],
65      color: 'Orange'
66    }
67  */
68});

Documentation

Coming soon...