Smooch (Sunshine Conversations)

Requirements

  • An HTTPS Endpoint to your bot

    • Set the externalUrl field in botpress.config.json
    • Create an HTTPS tunnel to your machine using Ngrok. Tutorial
    • Using Nginx and Let's Encrypt. Tutorial

  • Create a smooch.io account (you will need a business email)

Setup

Smooch App

Firstly, you need to create an app on smooch. To do so, please follow the steps below:

  1. On the app.smooch.io home page, click on Create new app

  2. Enter a name for your app and click Create App

  3. Connect a channel to your app (Telegram, Whatsapp, or any other listed channel)

  4. You should will see a channel in the Overview section of your app

Botpress Connection

  1. Go in the Settings section of your app

  2. At the bottom you will find an API Keys menu. Create a new API key

  3. You will need the id (the one that starts with app_) and secret key to setup your bot

Configuration

  1. Edit data/bots/YOUR_BOT_ID/config/channel-smooch.json (or create it) and set
  • enabled: Set to true
  • keyId: Paste the id of your key from Settings section
  • secret: Paste the secret of your key from Settings section

The resulting json will appear as follows:

{
  "$schema": "../../assets/modules/channel-smooch/config.schema.json",
  "enabled": true,
  "keyId": "app_5f079386f6480a000c121f71",
  "secret": "g9XWmyPlfKfv4Q9B7mclI9R2CIIosxHncRO1PQeMkCmLNczWSw0I9B_lCmOiMR2Uof37fxLcJXwaxcHOw63ryQ",
  "chatUserAuthDuration": "24h"
}
  1. Restart Botpress and test if your chatbot has been succesfully connected to your desired channel.
← SlackFAQ →