Customer Engagement

Customer Engagement by Truora enables companies to create automated WhatsApp conversations to engage with their users through their favorite channel. With our platform, companies can create their own WhatsApp API chatbots with almost no code.

This guide will provide useful information to start using our platform and get the most out of it

Creating a Truora account

• Create an account at Truora at https://account.truora.com/#/create-account/?product=engagement
• Or log into your account at https://account.truora.com/#/auth/login

Generating an API Key

Once created your account:

1. Open the account dashboard: https://account.truora.com/
2. Select API Keys in the sidebar on the left
3. Click the Create button
4. Write the name of your api key and then copy

Postman collection

In order to ease the process, you can import this Postman collection:

Creating a WhatsApp line

It is important to have your own WhatsApp API line, configured with your company name, logo, description and phone number. Since Truora is an official Meta partner, you can create your official WhatsApp API line with us!

The WhatsApp API enables you to automate communications with automated replies, WhatsApp chatbots & interactive messages, creating personalized communication flows that work best for you and your customers.

Prerequisites

• Phone number you need a phone number capable of receiving a SMS or call to authenticate it. It cannot be already connected to a previous WhatsApp account
• Facebook business account you need access to your Facebook business account (https://business.facebook.com/).

Need help with the prerequisites? Reach out to us at: developers@truora.com.

Please follow the steps below to create your WhatsApp line:

1. Go to Settings
   Go to the Customer Engagement product panel (https://connect.truora.com/) and click on “Settings” in the sidebar.
2. Click on Add account Once inside Settings, click on + Add account, as shown below:

   

3. Follow the Facebook widget steps Follow the step-by-step instructions to create the WhatsApp line.

   

Done! Your new WhatsApp line will be automatically connected to Truora’s platform.

Creating an outbound message

To initiate a conversation with a user an outbound template must be created and approved by Meta.

To create a new outbound message in our platform follow the steps below:

1. Open the connect dashboard: https://connect.truora.com/
2. Go to Outbound messages
3. Click create new message

   

4. Define a name for your outbound message: This is an internal name for you to keep track of your approved messages
5. Define a message category:
   • Marketing: conversations related to your business, products, or services. These include offers and promos, related product suggestions, abandoned cart messages, or any conversation that doesn’t qualify as authentication or utility.
   • Utility: conversations directly related to a transaction, including post-purchase notifications and recurring billing statements.
   • Authentication: conversations that provide users one-time passcodes for authentication purposes. These can occur at any stage of the user journey — such as account registration, account recovery, or integrity challenges.
6. Select the WhatsApp Business Account where you want to approve the message. Note: If you want to use this message using another line later, you will have to create it again.
7. Select Message language
8. Select Text type
   • Only text
   • Text + image
   • Text + video
   • Text + document
9. Select conversation type
   • Notification: One-way interaction where no response is expected from the user.
   • Conversation: two-way interaction where a response is expected from the user to keep the conversation. This type of interaction will be connected to a flow later
10. Define the message you want to send to your users. You can include customizable fields that you can send as parameters later (ex. Name, promo codes, payment date).

    

    

11. Define the CTAs for the users. To prevent spam, there will always be an option for the user to finish the conversation.
12. Click send to revision

Once submitted we will have to wait for Meta’s approval. It usually takes between 5 minutes and 5 business days for the outbound to be approved.

Creating a conversation flow

If you already have a flow created, you can skip this step.

A conversation in Flows is a customized WhatsApp chat that allows you to control the flow of the conversation. With Flows, you can create interactive conversations that guide users through a specific path, providing them with the information they need and helping them make decisions. By designing the conversation flow, you can ensure that users receive a personalized experience that meets their needs and engages them in a meaningful way.

Your users can start interacting with you through WhatsApp in 2 ways:

• You can send them a message to start the conversation. This is called an Outbound Message
• They send you a message to start the conversation. This is called an Inbound Message

To create a conversation flow you need to:

1. Open the connect dashboard: https://connect.truora.com/
2. Select Create new process

3. Click continue
4. Click in the + symbol to create a new block and select Answer options

5. Write a tittle, your question and fill your options
6. Finally add the block Finish chat to complete your flow.
7. Select Save and then Save and publish.
8. Select Test conversation to send an example message.

You can refer to this guide for more information about flows

Starting a conversation via API

To start a conversation via API you need 2 things:

• The ID of your conversation Flow
• The ID of your Outbound message

Flow ID Go to https://connect.truora.com and find your flow then copy the ID.

Outbound ID
Outbound Message is the first message that you send to your users, it has to be created because it must be approved by Meta (so it isn’t classified as spam) and has a WABA line associated with it.

If you already have a Flow created, you can go to Outbound Messages by clicking on the sidebar on your left and copy the Outbound ID of any approved outbounds on the list.

To send the message, make a POST call to v1/whatsapp/outbounds/send

const axios = require("axios");

const api_url = "https://api.connect.truora.com";
// Replace this variable with your API key
const api_key =
  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

async function sendOutbound() {
  const params = {
    // This is the phone number to send the message
    phone_number: "30300000x",
    // Country code of the phone number
    country_code: "+57",
    // Replace this with your ID
    outbound_id: "OTB29f605050b4c33b711a23534a82aa884",
    // Replace this with your ID
    flow_id: "IPF89175f49f2ee7ead0503ee40e9995b58",
    user_authorized: "true",
  };

  try {
    const response = await axios.post(
      `${api_url}/v1/whatsapp/outbounds/send`,
      params,
      {
        headers: {
          "Truora-API-Key": api_key,
        },
      }
    );

    console.log(response.data);
  } catch (error) {
    console.error(error);
  }
}

sendOutbound();

import requests

api_url = "https://api.connect.truora.com"
# replace this variable with your api key
api_key = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

def send_outbound():
   params = {
      # this is the phone number to send the message
      "phone_number": "30300000x", 
      # country code of the phone number
      "country_code": "+57",
      # replace this with your id
      "outbound_id": "OTB29f605050b4c33b711a23534a82aa884",
      # replace this with your id
      "flow_id": "IPF89175f49f2ee7ead0503ee40e9995b58",
      "user_authorized": "true",
   }
   return requests.post(
      f"{api_url}/v1/whatsapp/outbounds/send",
      data=params,
      headers={"Truora-API-Key": api_key}
   )

output = send_outbound()
print(output.text)

You will receive the following response

{
  "message": "conversation started with +57300000000",
  "session_id": "WDIS64a7baf4d205fe121fe4b571aebb2a06",
  "outbound_message": {
    "client_id": "TCIb05edd9b0814b801268b3c34006103c6",
    "outbound_id": "OTB29f605050b4c33b711a23534a82aa884",
    "default_flow_id": "IPF89175f49f2ee7ead0503ee40e9995b58",
    "outbound_name": "Demo template EN",
    "outbound_status": "APPROVED",
    "failure_reason": "",
    "is_notification": false,
    "outbound_message": "Hi! this is a TruConnect test. Select “Continue” and try your first flow. | [Continue] | [Cancel]",
    "outbound_answers": [
      {
        "message": "Continue",
        "action": "continue_process"
      },
      {
        "message": "Cancel",
        "action": "cancel_process"
      }
    ],
    "waba_phone_number": "+19403295686",
    "media_url": "undefined",
    "outbound_type": "text",
    "media_id": ""
  },
  "user_phone_number": "+57300000000",
  "flow_id": "IPF89175f49f2ee7ead0503ee40e9995b58"
}

Getting details from your conversations

Each time your users starts interacting with your flow, a process_id is generated to identify each unique conversation. You can use this id to extract the details of each conversation so you can take more action. To get the details of the conversation make a GET call to the /v1/processes/{process_id}/result endpoint.

import requests

api_url = "https://api.connect.truora.com"
api_key = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" # replace this variable with you API Key

def get_results(process_id):
   output = requests.get(
      f"{api_url}/v1/processes/{process_id}/result",
      headers={"Truora-API-Key": api_key}
   )
   return output.text

print(get_results("IDP822983eb1f704dca1f041339d888e55d"))

You will receive the following response

{
  "process_id": "IDP822983eb1f704dca1f041339d888e55d",
  "account_id": "57300000000-inbound-f1b88b3868936fcfabbd650fe417e3cd",
  "client_id": "TCIb05edd9b0814b801268b3c34006103c6",
  "flow_id": "IPF89175f49f2ee7ead0503ee40e9995b58",
  "created_via": "whatsapp",
  "flow_version": 5,
  "country": "ALL",
  "status": "success",
  "user_responses": [
    {
      "name": "hello",
      "type": "select",
      "value": "This is the response of your user"
    }
  ],
  "creation_date": "2023-06-07T02:25:57.227161396Z",
  "update_date": "2023-06-07T02:26:08Z"
}

Connecting an external API

Using custom integrations, it’s possible to configure requests to external APIs and use them in a WhatsApp flow to obtain data and perform actions in your system. You can refer to this guide for more information

API Reference

For more detailed information, we encourage you to refer to our API reference.