Readme

About the Project

For a company to sell its enterprise service, the sales need to communicate with the potential customers effectively. As each sales are overloaded with customers, they are prone to delayed response and low-quality response. However, evaluating the conversation between sales and customers requires huge labor works from manager and HRs. Therefore, a sales-assistant chatbot to record, analyze, and visualize the metrics of the conversation comes in handy.

System Structure

我們將系統解構成前端、puppet、後端代碼、以及數據庫。 We structure the system into user, frontend, puppet, backend code, and database. 首先，用戶和銷售每日會有許多新群與新消息，這些消息透過Wechaty捕獲，在sales-bot.js中統一存入msg_db，同時進行邏輯判斷，若有新建立的群，則會記錄在room_db內。

Firstly, there are lots of new rooms and messages in Wechat, which are listened and captured through Wechaty and saved in msg_db through sales-bot.js. Secondly, update-vika.js analyze room data and msg data and show it on Vika in real time. Managers can see all rooms' status and find man-made or bot-made problems. When pre-sales finish their jobs, they switch the rooms' phase into after-sales on Vika, which should be approved by the managers then. These changes are checked by vika-update-roomdb.js. Only when the changes are valid will the room_db be modified as well.

Finally, vika-to-feishu.js takes vika's room data, turn different level of delayed reply into message cards, and send them to Feishu through Lark Puppet.
If the manager want to change the sales-list, just modify config/default.json and execute update-name.js. To configure the alert policy or other parameters, modify config/default.json and restart the system.

Overall Configuration

【管理者】執行【產品準備1】和【產品準備2】，得到【售前售後名單, 企業名稱，警報配置，2個Vika表單的ID】
【技術人員】根據【售前售後名單, 企業名稱，警報配置，2個Vika表單的ID】執行【部署系統】，使系統上線，通知【管理者】，正式運行
【管理者、售前、售後】平時按照【產品使用流程】使用產品
【技術人員】平時按照【技術使用流程】使用項目

System Deployment

Input:

Need to get sales-list, corporation name, alert-settings and 2 Vika sheets' ID from Managers.
make sure that you had created a Feishu Bot
Deploy a server with docker installed

Process:

clone the project and install npm package

git clone https://github.com/KevinTung/sales-assistant.git
npm install

Fill the sales list in config.names.sales, config.names.after_sales

"names":{
  "sales":[
    "Andy",
    "Ben", 
    "Carl"
  ],
  "after_sales":[
    "Daniel",
    "Emily"
  ],
  "delete_names":false  #if you want to delete names not in the list from name_db 
},

Get the chatId based on sales list

node utils/get_chat_ids.js 

Output:
[
[name1,chatId1],
[name2,chatId2],
...
]

Configure lark. All names in the sales list need to fill in sales2chat.

"lark":{
 "channels":{
    "alert_group":"oc_xxx"   #group chat 
    "test_roomid":"oc_xxx",  #in dev phase, let msg flow here instead of formal Feishu groups
  },
  "sales2chat":{ #individual chat
    "name1": "chatId1", 
    "name2": "chatId2",
    ...
  },
}

Configure lark.salesAlert, lark.afterSalesAlert

"salesAlert":{
    "color_level":{  
      "5":"turquoise", //send turquoise card at 5 mins
      "10":"yellow", //send yellow card at 10 mins
      "20":"orange",
      "30":"red",
      "40":"purple",
      "50":"blue",
      "above":"grey"//send grey card after 50 mins
    },
    "cycle_time":10, //starting from 50, send a grey card every 10 mins, until 70
    "until":70,
    "group_alert_threshold":20 //also send to group chat after 20 mins
},
"afterSalesAlert":{ //對於售後也是一樣的配置邏輯
}

Configure corp.name based on corporation name on WeCom. Every employee has to have the same name, otherwise they will be treated as customer.
Create Vika account and fill vika.token as your personal ID and (vika.todayRoom, vika.allRooms) as the 2 datasheets' ID （今日群聊、所有群聊）
install OpenSearch

cd opensearch && docker-compose up

Configure dbConfig:

"dbConfig": {
  "host": "localhost",
  "protocol":"https",
  "port": 9200,
  "auth": "admin:admin"
},

download Opensearch JS SDK and make sure that OpenSearch functions correctly

npm i @opensearch-project/opensearch
cd utils
NODE_CONFIG_DIR=./config node utils/opensearch-test.js

Configure the following indexes:

"index":{
  "msg": "opensearch-index-for-messages",
  "room": "opensearch-index-for-rooms",
  "name": {
    "index":"opensearch-index-for-names",
    "docId": 1,
    "backup":10
    }
},

Create indexes in Opensearch

NODE_CONFIG_DIR=./config node utils/create_indexes.js

update sales-list:

NODE_CONFIG_DIR=./config node src/update-name.js

Get a WECHATY_PUPPET_SERVICE_TOKEN and Configure sales-assistant/scripts/.env

DOCKER_NAME=salesbot
TZ=Asia/Shanghai
WECHATY_PUPPET_SERVICE_NO_TLS_INSECURE_CLIENT=true
WECHATY_LOG=error
WECHATY_PUPPET=wechaty-puppet-service
WECHATY_PUPPET_SERVICE_TOKEN=<YOUR_WECHATY_TOKEN>

Configure timeZone，which decides how to count as 'a day' for Vika's 'today's group'
Configure UpdateCycleTime, which decides vika-to-feishu.js, update-vika.js, and vika_update_roomdb.js's update frequencies (default:60000ms)
If in dev mode，set is_developing to true, and all the alert will flow towards test_roomid

Usage

Docker Operation

./scripts/build_image.sh #build image after modifying code
./scritps/run_all.sh     #start all containers
./scritps/stop_all.sh    #stop all containers
docker logs -f <container_name> #check a container's log
docker ps #check all running containers

To run a nodejs file directly in server, you need to specify the path of config file

NODE_CONFIG_DIR=./config node src/update-vika.js

To update sales list, modify config/default.json's names and sales2chat sections and update the name_db:

NODE_CONFIG_DIR=./config node src/update-name.js

Check that the names have been correctly modified:

asd135441@ip-172-31-19-51:~/sales-assistant$ NODE_CONFIG_DIR=./config node utils/get_all_names.js 
Sales: [
  'Andy',"Ben','Carl'
]
After Sales: [ 'Daniel', 'Emily' ]

Database Schema

msg_db

Store the data listened from Wechaty:

[
  { //the first message....
 _events: {},
  _eventsCount: 0,
  id: '1155227',
  payload: {
    filename: '',
    fromId: '182xxxxxxxx',
    id: '1155227',
    mentionIdList: [],
    roomId: 'R:100xxxxxxxxx',
    text: 'hello',
    timestamp: 1642729893000,
    toId: '',
    type: 7,
    fromInfo: {
      _events: {},
      _eventsCount: 0,
      id: '182xxxxxxxx',
      payload: [Object]
    },
    toInfo: {},
    roomInfo: {
      _events: {},
      _eventsCount: 0,
      id: 'R:100xxxxxxxxx',
      payload: [Object],
      topic: '句子秒回&兔展'
    }
  },
  {
    //another message....
  },
 ...
]

$ NODE_CONFIG_DIR=./config node utils/get_room_msg.js '句子秒回&兔展'
Output:
12/16/2021 2:14:17 PM 句子秒回&兔展 customerA:好，我明白了，那我这边先向上汇报一下，如果有需要我具体找你沟通哈！ 
12/16/2021 2:14:32 PM 句子秒回&兔展 salesA:好 
12/20/2021 4:05:09 PM 句子秒回&兔展 customerA:@salesB  发不出去，一直转圈 
...
...

name_db

Store all sales and their responsive rooms

$ NODE_CONFIG_DIR=./config node utils/get_names_rooms.js 
Output:
[
'Andy': {
    role: 'sales',
    all_rooms: [
      'group1',
      'group2',
      'group3',
      'group4'
    ]
  },
'Ben':{
  ...
}
]

room_db

Store all rooms and their status

$ NODE_CONFIG_DIR=./config node utils/get_all_rooms.js 
Output:
[
  {
    sales: [ 'Andy' ],
    employee: [
      EmployeeA,
      EmployeeB,
      EmployeeC,
    ],
    phase: 'pre-sales',
    in_charge: 'Daniel',
    after_sales: [ 'Daniel', 'Emily' ],
    room_name: 'Customer Service Group'
  },
  {
    sales:['Ben'],
    ...
  },
  ...
]

Appendix

Use tmux to run multiple processes in a single terminal

tmux a   #to open a new window
Ctrl+B D #detach from tmux window
Ctrl+B W #switch between windows
Ctrl+D   #close a window

Contact

KevinTung - @asd135441 - [email protected]

kevintung / salesbot Goto Github PK

salesbot's Introduction

Readme

About the Project

System Structure

Overall Configuration

System Deployment

Input:

Process:

Usage

Database Schema

Appendix

Contact

salesbot's People

Contributors

Watchers

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent