Get started with swiftchat

Registration on Swiftchat Merchant Account

Registration on SwiftChat is a simple process that allows users to create an account and access the platform’s features. For registration follow these steps:

1. Open swiftchat dashboard.

2. Upon accessing the website, you will encounter a page prompting you to input essential details, including your name, phone number, and password. Enter you details and continue with “Register now” option.

   

3. Upon entering your details, you will receive an email for email verification. At this point, verify your email to proceed with the login steps.

   

4. Following the login process, you may be prompted to complete the business KYC procedure.

5. Upon successful KYC and login, you will gain access to the SwiftChat merchant dashboard. From here, you can create bots and obtain API keys as needed.

Following these steps will complete the registration process.

Obtain API key

API keys are essential for authentication and accessing various features of the SwiftChat platform. They serve as a means of verifying your identity and ensuring secure communication between your application and the SwiftChat servers. Each API request you make to the SwiftChat platform must include your API key as part of the authentication process.

To obtain your API key and unlock access to the SwiftChat platform’s features, you need to have a merchant account. Once you have registered and logged in to your merchant account, you can generate your API key.

Tip

• Create your merchant account using this Post API

• Complete business KYC and email verification

Follow these steps to get API key:

• Open the SwiftChat Merchant Dashboard

• Login to dashboard with your merchant credentials

• Click on profile settings tab and open Manage Account

  

• In Manage Account page you will get the API key at the bottom of page. You can copy the API key from there or create a new one.

  

Tip

You can also get the API key using the GET API

Setting Up a New Bot

To begin utilizing the starter kit, you’ll need to obtain a bot ID. You can create a chatbot either manually or via API.

Creating a Bot Using the SwiftChat API

The SwiftChat APIs act as the conduit between your chatbot and yourself, processing your data accordingly.

You can employ any tool or platform to interact with the SwiftChat APIs. In this instance, we’ll demonstrate using curl.

Steps

1. Open your terminal or command prompt. If you don’t have curl installed, you can install it using npm by running the npm install -g curl command in your terminal

2. Create a new POST request using curl

3. Use the following API endpoint:https://v1-api.swiftchat.ai/api/bots

4. Include your API key in the header that you obtained during Obtaining API Key

5. In the body, include details such as bot-name, mobile-number, and bot-category

6. Add the header and the body to your curl request:

   curl --location 'https://v1-api.swiftchat.ai/api/bots' \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer YOUR_API_KEY_HERE" \
    --data '{
        "mobile": "+91XXXXXXXXXX",
        "configuration": {
        "name": "Test"
        "category":"Education"
       }
   }'
   

7. On successfully creating bot you will receive a message indicating created.

8. After creating bot, use the **varify API** to generate the bot ID.

Creating a Bot Using the SwiftChat Dashboard

You can also create bot using your SwiftChat Merchant Dashboard

Steps:

1. Login to your SwiftChat Merchant Dashboard.

Tip

• Create your merchant account using this Post API

• Complete business KYC and email varification

2. Click on Add New Bot button.

3. Clicking Add New Bot button will redirect you to a page where you can input the bot details, including the phone number, bot name, and bot type.Enter these details and proceed for verification. Once verification is completed, the bot will be created and activated.

4. Copy the bot link and save it for future reference. The link should resemble this format:

   https://cgweb.page.link/?link=https%3A%2F%2Fweb.convegenius.ai%3FbotId%3D0216260609726241&apn=ai.convegenius.app.
   

   • In the link, the bot ID is structured as botId%3D0216260609726241, where the actual ID follows the “3D” prefix. So here the ID is 0216260609726241.