# Welcome 

Emovur's WhatsApp Business API platform helps businesses use WhatsApp as a primary communication channel to send notifications, marketing messages and updates over WhatsApp.

Our mission is to provide a user-friendly product for businesses to increase their sales and engagement via WhatsApp. 

We collaborate with businesses & brainstorm, identify the opportunities to leverage WhatsApp effectively in all your marketing activities and business flows.

## Product Demo

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="rating" data-max="5"></th><th data-type="files"></th></tr></thead><tbody><tr><td><strong>Onboarding</strong></td><td>Help yourself signup up, connect your number and verify your Meta account.                   </td><td>5</td><td></td></tr><tr><td><strong>Get Started</strong> </td><td>Get template approval for broadcasts and access reports.</td><td>5</td><td></td></tr><tr><td><strong>Modules</strong></td><td>A comprehensive guide to explore our products essential features.</td><td>5</td><td></td></tr><tr><td><strong>Billing</strong></td><td>Review your wallet balance and current subscriptions.</td><td>5</td><td></td></tr><tr><td><strong>Developers</strong></td><td>Leverage APIs and webhooks for seamless integration with your tech stack.</td><td>5</td><td></td></tr></tbody></table>


# Sign up

## Sign up for a Emovur Account

1. Go to the Emovur [sign up](https://admin.emovur.com/auth/register) page.
2. Fill the sign up form
   1. Enter business name.
   2. Enter admin name.
   3. Enter admin email id.
   4. Enter admin contact mobile number (This need not be WhatsApp Business API number)
   5. Create password.
   6. Click on sign up.

Upon successful signup, you will be automatically logged in and taken to your account.

## What Next?

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Connect Number</strong> </td><td>Connect your desired business number as your WhatsApp Business API number and start sending messages.</td></tr><tr><td><strong>Book demo</strong> </td><td>Book a 1-on-1 consultancy call with our expert and get answers to all your questions regarding WhatsApp Business API.           </td></tr></tbody></table>


# Connect number

{% tabs %}
{% tab title="Register a new number" %}

## Pre - requisites

* The number should not be registered on WhatsApp Messenger or WhatsApp Business App. If the number is registered on any of the above apps, you can delete the the account and onboard here.
* You need to have a Meta Business Profile or you can [create](https://www.facebook.com/business/help/1710077379203657) one.

{% hint style="info" %}
If you are deleting your WhatsApp account to register as new number, the data and messages in your WhatsApp account will be deleted and you won't be able to retrieve again.
{% endhint %}

The registration process must be completed by the admin of the Meta Business profile. Ensure you're logged into business.facebook.com with your admin credentials in the same browser before proceeding.

## Steps to register a new number

1. Navigate to WhatsApp -> Account -> [Setup](https://admin.emovur.com/dashboard/whatsapp/account/setup).
2. Select **Register a Number**.
3. Click the **Connect Facebook** button to open the **Facebook OAuth screen** and complete the sign-up process
   1. Click on **Continue as&#x20;*****your facebook name. (***&#x49;f you haven't logged in to facebook account, you will be prompted to login before this step.)
   2. Share consent with Meta to work with Emovur, Click on **Get Started.**
   3. Select your **Business Profile** under which your WhatsApp Business API account will be created. Click on **Next.**
   4. Create or select your WhatsApp Business account
      1. Choose a WhatsApp Business account : Select **Create a WhatsApp Business account.**
      2. Create or select a WhatsApp Business profile : **Create a new WhatsApp Business Profile.**
      3. Click on **Next.**
   5. Create a WhatsApp business profile
      1. WhatsApp business account name : **Your Business Name - Emovur** (Your audience will not see this information on your WhatsApp Profile).
      2. WhatsApp business display name : "**This is the name your audience will see**" \
         (Your display name should match your business name and adhere to WhatsApp Business display name guidelines. [Learn more about display name guidelines](https://www.facebook.com/business/help/757569725593362)).
      3. Select relevant **category.**
      4. You need not click on **Show more options.** Click on **Next.**
   6. Add a phone number for WhatsApp
      1. Enter your number which you would like to register as WhatsApp Business API number.
      2. Verify your number with Text message" or Phone call OTP.
      3. Once you enter OTP, click on **Finish.** Now, you will be redirected back to Emovur.
4. Wait for a **minute** for Meta to generate **Phone Number ID and** click on Sync. If you see phone number ID, registration is successful.&#x20;

Now you can take template approval and start sending messages. Until, you get your Meta Business Profile verified, you can send only 250 business initiated conversations in any rolling 24hrs. \
\
Now, let's get your Meta Business Profile account verified.
{% endtab %}

{% tab title="Migrate from different provider" %}

## Pre-requisites

* You should have access to the number to receive OTP over text message or phone call.
* Turn off 2 factor for migrating from a different provider.

## Steps to migrate from another platform

1. Sign in to [admin.emovur.com](https://admin.emovur.com/dashboard/whatsapp/whatsapp-templates/create-template).
2. Navigate to WhatsApp -> Account -> [Setup](https://admin.emovur.com/dashboard/whatsapp/account/setup)
3. Select "**Migrate from a different provider**"
   1. Steps to turn off the two factor is mentioned on our portal.
   2. After disabling 2 factor, check the box for confirming **"I have disabled 2 factor authentication".**
4. Click on **"Connect Facebook Account"** and you will get redirected to  **Facebook OAuth screen**
   1. Click on **Continue as&#x20;*****your facebook name.** (*&#x49;f you haven't logged in to facebook account, you will be prompted to login before this step)
   2. Share consent with Meta to work with Emovur, Click on "**Get Started"**
   3. Select your business profile and verify business name and portfolio. Click on **"Next"**
   4. Choose a WhatsApp Business Account&#x20;
      1. Select **Create a WhatsApp Business account**
      2. Name your WhatsApp Business account. Click on "**Next"**
   5. Review permission -> Click on **"Continue"**
   6. Once your information is verified -> Click on **"Finish"**
5. You will get redirected to [admin.emovur.com](https://admin.emovur.com).
6. Enter the WhatsApp Business API number you wish to migrate, then click on **"Submit".**
7. You will receive an OTP on your registered phone number.
8. Enter the OTP received on your  phone number.
9. Click on **"Sync".**
10. Wait for 2-3 minutes and refresh the page to check of your phone number has appeared on the portal.
    {% endtab %}
    {% endtabs %}


# Meta account verification

## Pre-requisites for getting your Meta Account verified

You must provide a certificate or document as proof of your business registration. Acceptable documents include **GST registration, UDYAM certificate, sole proprietorship registration, or MSME** certificate. Additionally, please provide your **business website link.**

{% hint style="info" %}

* Your company's name must be clearly displayed in a prominent location on your website and must match the name listed on your legal documents.
* Additionally, the email address provided for verification should belong to the same domain as your website.

{% endhint %}

## Steps to verify your Meta Account

1. Log into[ business.facebook.com](https://business.facebook.com)
2. On the left side under business portfolios click on settings (gear icon).
3. Settings -> Accounts -> Security Center.
4. Click on “**Start verification**”.
5. Click on “**Get Started**”.
6. Select the country.
7. Select your business type from the given option.
8. Select if your business is officially registered or not.

{% tabs %}
{% tab title="If business is registered" %}

1. Add business details.
2. Select business type.
3. Review the details.
4. Select a contact method.
5. Confirm your email address.
6. Enter the code received in your email.
7. Click on "**Finish**".
   {% endtab %}

{% tab title="If business is not registered" %}

1. Add business details.

2. Select your business type, if your business is not listed, choose “**My business is not listed here**”.

3. Upload document -  Select the document type (GST/MSME).

4. &#x20;Upload that relevant document.

5. &#x20;Upload a document to verify your phone number as well.

6. &#x20;Enter your email or phone number to receive a confirmation code.

7. &#x20;Enter the code received in your email or phone number.

8. Click on “**Finish**”.
   {% endtab %}
   {% endtabs %}

9. It will take 24 hours to verify your business, you will receive a mail upon the completion of verification.


# Take template approval

Here's how to get your first template approval

1. Navigate to the Dashboard -> WhatsApp -> Templates.
2. Click on “**Create Template**”.
3. Choose category as **Marketing** -> **Custom.**
4. Click on **Continue.**
5. Name the template and choose the language.
6. Select header as "**None**".
7. Compose  a message inside body.
8. Click on "**Add a button**" -> **Custom** (name the button accordingly)
9. Click on "**Submit**".
10. A notification will be shown saying the Template message sent successfully.
11. Click on sync template after 5-10 minutes to check the status of the template.


# Send broadcast

Let's send your first broadcast message

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Create broadcast.
2. Click on “**Create Broadcast**”.
3. Enter a Broadcast name.
4. Upload a [**CSV** ](#user-content-fn-1)[^1]file with details of your customers.
5. Select the mobile number in the recipient column.
6. Click on "**Choose template**".
7. Set up dynamic fields, map the variables, select field 1, and then choose the relevant options accordingly.
8. Set allow duplicates to **yes.**
9. Select broadcast schedule to "**Send now**".
10. Click on “**Send Broadcast Message**”.
11. A notification will be shown saying Broadcast sent successfully.

[^1]: CSV file should contain details of your customers like mobile number


# View broadcast report

Here's how you view the broadcast report

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Broadcast Report.
2. Click "**View Details**" to access an overview of the broadcasted messages.
3. For a more detailed report, click the "**Download Report**" button located in the top right corner.
4. The downloaded report includes the status of each customer number and their respective responses.


# WhatsApp Templates

Templates and it's features

Templates are a structured form of messages that you send out to your customers after receiving approved by Meta. The official turnaround time is 48 hours for the template message to get approved by Meta, at times the template will get approved within 15-20 minutes.

The basic outline of a template message consists of a header, body, footer and buttons

* **Header:** A header is an optional section at the top of a message used for key information or context, such as a title or branding. It can be set to none, or include text, an image, video, document, or location.
* **Body:** The body section is where the main message content is composed, intended to be read by the customers.
* **Footer:** A footer is an optional section in a message template that appears below the body text, typically used for supplementary information or disclaimers.
* **Buttons:** Buttons are interactive elements in a message template that allow users to take specific actions, such as quick replies or triggering a call to action, enhancing user engagement and interaction.

Types of interactive buttons

<table data-view="cards"><thead><tr><th></th></tr></thead><tbody><tr><td><p><strong>Marketing opt-out button</strong></p><p>It is recommended to include this as a button, allowing customers to opt-out of receiving marketing messages.</p></td></tr><tr><td><p><strong>Custom button</strong></p><p>This button defines specific actions, tailored to your messaging needs. </p></td></tr><tr><td><p><strong>Visit Website button</strong> </p><p>This button enables you to add a link to your website, directing users to your online platform. </p></td></tr><tr><td><p><strong>Call phone number button</strong></p><p>This button provides the option to add your company’s phone number, enabling customers to initiate a direct call.</p></td></tr><tr><td><p><strong>Product catalogue button</strong></p><p>The product catalogue button lets users browse and view a business’s product offerings directly within a chat.</p></td></tr><tr><td><p><strong>WhatsApp flow button</strong></p><p>This button guides users through interactive steps to complete tasks like bookings or orders.</p></td></tr></tbody></table>


# Create a template

Templates are a structured form of messages that you send to your customers after receiving approval from Meta. So, how do we create them?

<details>

<summary>Marketing Custom Template</summary>

1. Navigate to the Dashboard -> WhatsApp -> Templates.
2. Click on “**Create Template**”.
3. Choose the category as **Marketing** -> **Custom.**
4. Click on **Continue.**
5. Name the template and choose the language.
6. Select your desired header type (optional):
   1. The header can be set to 'None'.
   2. If 'Text' is selected as the header, enter the desired text message.
   3. If 'Image', 'Video', 'Document', or 'Location' is selected as the header, you will have the option to upload the corresponding file.
7. Compose a message in the body.
8. Add a message in footer (optional).
9. Add buttons (optional):
   1. You can add up to 10 buttons, with a maximum of 2 website buttons and 1 call phone number button.
10. Click on “**Submit**”.
11. A notification will be shown saying the Template message sent successfully.
12. Click on sync template after 5-10 minutes to check the status of the template.

</details>

<details>

<summary>Marketing Catalogue Template</summary>

1. Navigate to the Dashboard -> WhatsApp -> Templates.
2. Click on “**Create Template**”.
3. Choose the category as **Marketing** -> **Catalogue.**
4. Click on **Continue.**
5. Name the template and choose the language.
6. Choose a Catalogue format:
   1. **Catalogue message** – Displays the entire product catalogue.
   2. **Multi-Product Message** - Showcases up to 30 selected products from the catalogue.
7. Compose a message in the body.
8. Add a message in footer (optional).
9. **“View Catalogue”** is the only button supported for this template.
10. Click on **"Submit".**
11. A notification will be shown saying the Template message sent successfully.
12. Click on sync template after 5-10 minutes to check the status of the template.

</details>

<details>

<summary>Utility Custom Template</summary>

1. Navigate to the Dashboard  -> WhatsApp -> Templates.
2. Click on **“Create Template”.**
3. Choose the category as **Utility** -> **Custom.**
4. Click on **Continue.**
5. Name the template and choose the language.
6. Select your desired header type (optional):
   1. The header can be set to 'None'.
   2. If 'Text' is selected as the header, enter the desired text message.
   3. If 'Image', 'Video', 'Document', or 'Location' is selected as the header, you will have the option to upload the corresponding file.
7. Compose a message in the body.
8. Add a message in footer (optional).
9. Add buttons (optional):
   1. &#x20;You can add up to 10 buttons, with a maximum of 2 website buttons and 1 call phone number button.
10. Click on **"Submit".**
11. A notification will be shown saying the Template message sent successfully.
12. Click on sync template after 5-10 minutes to check the status of the template.

</details>

<details>

<summary>Authentication Template</summary>

1. Navigate to the Dashboard -> WhatsApp -> Templates.
2. Click on **“Create Template.**
3. Choose the category as **Authentication.**
4. Click on **Continue.**
5. Name the template and choose the language.
6. Select **“Copy Code”** under Code delivery setup.
7. Content for authentication message can’t be templates:
   1. Additional content can be selected from the given option
8. Only one button is available for this particular template:
   1. Button text is customisable.
9. Click on **"Submit.**
10. A notification will be shown saying the Template message sent successfully.
11. Click on sync template after 5-10 minutes to check the status of the template.

</details>


# Broadcast

Broadcast and it's features

**Broadcast messages** are typically used to share promotional content, updates, or important notifications with a wide audience. These messages are managed through templates that must be pre-approved by WhatsApp to ensure compliance with policies and avoid spamming.

The **broadcast report** provides an overview of the status of messages sent to customers.

The **broadcast journey** is used to define a structured sequence of messages sent to your customers at predefined intervals.


# Create Broadcast

How to create broadcast?

1. Navigate to the Dashboard ->WhatsApp -> Broadcast -> Create broadcast.
2. Click on “**Create Broadcast**”.
3. Enter a Broadcast name.
4. Upload a **CSV file** with details of your customers:
   1. Customer phone number (**mandatory**).
   2. Additional column to be used for personalizing the message. &#x20;
5. Select the mobile number in the recipient column.
6. Click on "**Choose template**".
7. Set up the dynamic fields, they are used to personalize messages by allowing businesses to insert specific or variable information:
   1. To map the variables, select fields 1 and 2, then choose the relevant options accordingly.
8. Set allow duplicates:
   1. If allow duplicates is set to yes, then the duplicate numbers will also receive the messages.
   2. If allow duplicate is set to no, then the duplicate numbers will not be receiving the messages.
9. Choose when you want to schedule the broadcast.
10. Click on "**Send Broadcast Message**".
11. A notification will be shown saying the broadcast is sent successfully.


# Broadcast Report

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Broadcast Report.
2. Click "**View Details**" to access an overview of the broadcasted messages.
3. For a more detailed report, click the "**Download Report**" button located in the top right corner.
4. The downloaded report includes the status of each customer number and their respective responses.


# Broadcast Journey

The broadcast journey is used to define a structured sequence of messages sent to your customers at predefined intervals.

<details>

<summary>To create a Broadcast Journey</summary>

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Broadcast Journey.
2. Click on **“Create Journey”.**
3. Enter the Journey name.
4. Upload a **CSV file** in the same format each time.
5. Set allow duplicates:
   1. If allow duplicates is set to **yes**, then the duplicate numbers will also receive the messages.
   2. If allow duplicate is set to **no**, then the duplicate numbers will not be receiving the messages.
6. Select mobile number in the recipient column.
7. Click on **“Create Journey”.**
8. A pop up message “Journey created” will be shown indicating the journey has been created.

</details>

<details>

<summary>To initiate a Broadcast Journey</summary>

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Broadcast Journey.
2. Click on **edit** -> **Add.**
3. Enter the Broadcast name.
4. Click on **“Choose message template”.**
5. Set up the dynamic fields, they are used to personalize messages by allowing businesses to insert specific or variable information:
   1. To map the variables, select fields 1 and 2, then choose the relevant options accordingly.
6. Schedule the broadcast by setting the duration.
7. Click on **“Create Broadcast”.**
8. A notification will appear, stating that the broadcast created successfully.
9. To another message in the sequence, click on **Add** and repeat the above steps.

</details>


# Team Inbox

The Multi-Agent Team Inbox is designed for chatting and engaging with your customers. The Team Inbox is part of Emovur’s suite of products, and with your WhatsApp Business API account subscription, you gain access to our chat application.

In the Team Inbox, you can capture inquiries from Messenger, website chat widgets, in addition to WhatsApp. The Multi-Agent Team Inbox is designed for chatting and engaging with your customers.  The Team Inbox is part of Emovur’s suite of products, and with your WhatsApp Business API account subscription, you gain access to our chat application. In the Team Inbox, you can capture inquiries from Messenger, website chat widgets, in addition to WhatsApp.

The key features of our multi-agent team inbox are:

<table data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Conversation</strong></td><td>All customer conversations are displayed here, allowing you to respond directly. You can also view assigned, unassigned, and all interactions in one place.</td></tr><tr><td><strong>Inboxes</strong> </td><td>In the Team Inbox, manage inquiries from Messenger, website chat widgets, and WhatsApp efficiently.</td></tr><tr><td><strong>Private Note</strong>  </td><td>You can add private notes to customer conversations, invisible to the customer, enabling team discussions before respond</td></tr><tr><td><strong>Teams</strong> </td><td>Create internal teams in your account to assign them conversations when working collaboratively.</td></tr><tr><td><strong>Canned Responses</strong> </td><td>Canned responses to FAQs help reduce repetitive conversations by offering quick, pre-saved replies to simple queries.</td></tr><tr><td><strong>Close Conversation</strong></td><td>After addressing the client’s queries, you can mark the conversation as '<strong>Resolved</strong>.' If follow-up is requested later, you can mark it as '<strong>Snoozed</strong>.'</td></tr><tr><td><strong>Assigned Agent</strong></td><td>Conversations are automatically assigned to agents on a round-robin basis, but they can be assigned manually if needed.</td></tr><tr><td><strong>Macros</strong></td><td>Creating a macro allows you to send multiple pictures or documents with a single click.</td></tr><tr><td><strong>Labels</strong></td><td>Use labels to filter and organize conversations, making it easier to categorize them for future reference.</td></tr><tr><td><strong>Labels Report</strong> </td><td>Track which labels receive the most conversations and monitor the time taken to resolve them.</td></tr><tr><td><strong>Agent Report</strong></td><td>Monitor agent performance with automatically updating reports and view key performance indicators (KPIs) for detailed insights.</td></tr><tr><td><strong>CSAT Report</strong></td><td>Automate and track customer satisfaction surveys to gather feedback, helping you improve your service and achieve exceptional satisfaction.  </td></tr><tr><td><strong>Help Center</strong></td><td>Create a customized help center with our intuitive knowledge base software to streamline queries, boost efficiency, and enhance customer support.</td></tr><tr><td><strong>Campaigns</strong></td><td>Create campaigns by setting up a website inbox, with options for launching ongoing or one-time campaigns.</td></tr><tr><td><strong>AI Integration</strong></td><td>Use AI to provide instant responses, assist agents with reply suggestions, and streamline workflows with automation.</td></tr></tbody></table>


# Bot

Bot and it's features

Bot configuration enables automated responses and efficient handling of customer queries, improving support and engagement.

Triggers are actions or messages based on predefined events or conditions, ensuring timely communication.&#x20;

* Text – A text message will be sent when a specific trigger phrase is sent.
* &#x20;Flow – A thank you message will be sent after the customer has filled any form.

Response message type has options like text, image, video, document, interactive and template.

## Steps to Create a Trigger

1. Navigate to the Dashboard -> WhatsApp -> Bot.
2. Click on **“Create Trigger”.**
3. Enter trigger name.
4. Select a trigger type as **“Text”.**
5. Enter trigger phrase.
6. Click on **"Add response".**
7. Select a response type from the given dropdown:
   1. The dropdown has option such as text, image, video, document, interactive and template.
8. After choosing a relevant option from response type add the necessary information.
9. Click on **"Save".**
10. A notification will be shown saying message saved successfully.


# Flows

Flows are equivalent to google forms, it is used to guide users through interactive, step-by-step processes, enabling them to complete tasks instead of sending links.

## Steps to Create a Flow

1. Navigate to the Dashboard -> WhatsApp -> Flows.
2. Click on **“Create Flows”.**
3. &#x20;Enter a flow name.
4. Click on **Continue.**
5. On the left rename your screen.
6. Click on **“Add Screen”** for more screens.
7. On the right under short answer:
   1. Choose the category of the question.
   2. Enter label.
   3. &#x20;Select how you want your customers to respond, whether through single or multiple choice, a short answer, or a paragraph.
   4. Enter a helper text, if needed.
   5. Click on **“Add Questions”** for more questions.
8. Enter a **“Button text”.**
9. Click on **“Save”.**
10. A notification will be shown saying flow saved successfully.

<details>

<summary>How to publish a flow?</summary>

1. Navigate to the Dashboard -> WhatsApp -> Flows
2. Search for the flow name created by you
3. On the right side click on the three dots and select **‘Publish’**
4. Once the flow is published, it can be incorporated in the messages

</details>


# E-commerce

Connecting catalogue enable businesses to display their products directly within conversations, allowing customers to easily browse, view product details, and make purchases.

## Steps to Connect a Catalogue

1. Navigate to the Dashboard -> WhatsApp -> E-commerce -> Catalogue.
2. Click on “**Connect Facebook Account**” on the top right corner.
3. Connect your catalogue.
4. Click on “**Choose a Catalogue**”.
5. Select the product from the list.
6. Click on “**Connect Catalogue**”.
7. A notification will be shown saying Catalogue connected successfully.


# Insights

Insights refer to data and metrics that provide businesses with an overview of their messaging performance.

1. Navigate to the Dashboard -> WhatsApp -> Insights.
2. In the Insights section, you can view messaging limits and conversation insights.
3. Messaging limits increase based on usage patterns.
4. &#x20;The current quality score is also displayed here.
5. &#x20;Conversation insights provide a breakdown of usage across different message categories for the selected date range.


# Integrations

Our platform integrates seamlessly with your existing tools through the creation of a Webhook URL, enabling the capture of necessary data from third-party software and automating message delivery.

## Steps to Integrate

1. Navigate to the Dashboard -> WhatsApp -> Integration.
2. Click on **“Create Webhook”.**
3. Write your JavaScript code.
4. Enter a Script name.
5. Write a simple description.
6. Click on **“Save”.**
7. A callback URL will be generated automatically, which can be used in your third party software.


# Profile Setup

1. Navigate to the Dashboard  -> WhatsApp -> Accounts -> Settings

   -> Profile
2. Click on “**Upload photo**” to set a profile picture.
3. Choose a category.
4. Write a description.
5. Fill the other relevant details about your company.


# Wallet

Navigate to the Dashboard ->WhatsApp -> Account -> Billing -> Wallet.

The Wallet Balance section displays your current balance for the month along with a detailed information regarding conversation category charges.


# Subscription

Navigate to the Dashboard -> WhatsApp -> Account -> Billing -> Subscription.

This section displays the details of your subscribed subscription plan.


# API Logs

API logs are records of all interactions between your application and WhatsApp's servers, tracking message statuses, errors, and performance for troubleshooting and monitoring.

Navigate to the Dashboard and choose WhatsApp -> Account -> Developers -> API Logs.

This section shows details like the time the message was initiated, template name, recipient's mobile number, final delivery status, response type, and the actual response text received.


# API Documentation

Emovur provides all the necessary APIs to facilitate programmatic requests to our server. This enables seamless integration of your tech stack with us.

Below is a list of available APIs:

<details>

<summary>Send message</summary>

[Create a template](/modules/whatsapp-templates/create-a-template)

After taking template approval&#x20;

1. Navigate to the Dashboard -> WhatsApp -> Templates.
2. Click on **"View/Edit Webhook details".**
3. Click on **"Set Webhook details".**
4. Click on **"Edit Webhook details".**
5. Select media type as:
   1. Dynamic - If you want to pass the header media dynamically, use a public URL.
   2. Fixed- If you want to use fixed header media, select the source as either a URL or upload an image, document, or video.
6. Click on **"Submit".**
7. Now you should be able to see the API endpoint and sample payload.

</details>

<details>

<summary>Initiate Broadcast</summary>

[Broadcast Journey](/modules/broadcast/broadcast-journey)

After creating a broadcast journey

1. Navigate to the Dashboard -> WhatsApp -> Broadcast -> Broadcast Journey.
2. Click on "**Webhook details**".
3. Now you should be able to see the API endpoint and sample payload.

</details>

We offer 1-on-1 consultations with our developers to assist you in achieving the required integration. Additionally, we provide integration as a service to handle all necessary integrations on your behalf.

&#x20;                                                           [Reach out to us!](https://api.whatsapp.com/send/?phone=917373735479\&text=Hi,%20I%20want%20to%20connect%20with%20the%20developer)


# Send Template Message API

This document details the Send Template Message API with which you can send template messages from your CRM or any custom software or tool.

The Send Message API endpoint and payload are tailored to each approved template message in your account. To send messages via the API, you’ll need to generate an API endpoint for the specific template you want to use.

<details>

<summary>Create API Endpoint</summary>

1. Sign in to [admin.emovur.com](https://admin.emovur.com/).
2. Navigate to the WhatsApp -> Templates.
3. Scroll to find and select the approved template.
4. Click on **"View/Edit Webhook details"** icon against the  approved template.
5. Click on **"Set Webhook details".**
6. If the header has media then you can choose to use static media or dynamic media, If not you will be taken to the final step:
   1. Dynamic - Use a public URL to pass the header media dynamically.
   2. Fixed- Select the source as a URL or upload an image, document, or video to use fixed header media.
7. Click on **"Submit".**
8. Now you will be able to see view the generated API endpoint and sample payload.

</details>

The following illustrations demonstrate three types of API payloads, helping you understand how to structure payloads for any template message.

<details>

<summary>Static Media Message with Dynamic Variables</summary>

```
Template Name :  Static Media Message with Dynamic Variables

Payload :  
{
  "receiver": "customer_mobile_number",
  "values": {
    "1": "custom_value",
    "2": "custom_value",
    "3": "custom_value"
  }
}

Webhook-Url :  "https://adminapis.backendprod.com/lms_campaign/api/whatsapp/template/20jpylrv97/process"
```

Webhook URL is the endpoint to which you have to submit the request.

In payload pass recipient number against key **“receiver”.**

Receiver Number format : \<countrycode>\<mobile number>\
Example : +917411223344\
\
Pass String values against dynamic variable “1”, “2”, “3”

</details>

<details>

<summary>Dynamic Media</summary>

```
Template Name :Dynamic Media

Payload :
{
  "receiver": "customer_mobile_number",
  "media_url": "media_url"
}
Webhook-Url :
"https://adminapis.backendprod.com/lms_campaign/api/whatsapp/template/uiw91c2k97/process
```

The medial URL should be public and secure.\
\
Supported Media Types : [https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/#supported-media-types\ <br>](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/#supported-media-types)Example<br>

<https://static.remove.bg/sample-gallery/graphics/bird-thumbnail.jpg>

</details>

<details>

<summary>One of the CTA button has Dynamic URL</summary>

```
Template Name :  Dynamic URL

Payload :  
{
  "receiver": "customer_mobile_number",
  "values": {
    "1": "custom_value"
  },
  "media_url": "media_url"
}

Webhook-Url :  "https://adminapis.backendprod.com/lms_campaign/api/whatsapp/template/ayd4zf7t83/process"
```

When a template's CTA includes a dynamic URL, you must provide the string to append to the static portion of the URL. Pass this value in the same way as dynamic variables within the template message.

</details>

<details>

<summary>API responses and Error codes</summary>

When you submit a Send Template Message API request to the Emovur server, we validate, process, and forward the request to Meta. We then provide an acknowledgment based on Meta's response. Upon successful submission, you will receive a response message. See the sample below:

Response

```

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<WHATSAPP_USER_PHONE_NUMBER>",
      "wa_id": "<WHATSAPP_USER_ID>"
    }
  ],
  "messages": [
    {
      "id": "<WHATSAPP_MESSAGE_ID>",
      "message_status": "<PACING_STATUS>"
    }
  ]
}

```

Sample Response

```

{
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "9693971669",
            "wa_id": "919693971669"
        }
    ],
    "messages": [
        {
            "id": "wamid.HBgMOTE5NjkzOTcxNjY5FQIAERgSM0ExQzBFMjY5NjVEM0Q3MzJGAA==",
            "message_status": "accepted"
        }
    ]
}

```

If the message submission fails, an error message and code will be returned. You can refer to the [Error Codes Documentation ](< https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes>)for detailed information on specific errors.

</details>

If the submission to the Emovur server is invalid or contains missing parameters, an error message will be returned as shown below.

<table><thead><tr><th width="345"> Error Message</th><th> Description</th></tr></thead><tbody><tr><td>The receiver field is required</td><td><p>Number format : &#x3C;countrycode>&#x3C;mobile number><br><br>Example:</p><p>Country code : +91<br>Mobile Number : 7411223344<br>Should be structured as +917411223344</p></td></tr><tr><td>The media url field is required</td><td>The medial URL should be public and secure<br><br>Supported Media Types : <a href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/#supported-media-types">https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/#supported-media-types<br><br></a>Example<br><a href="https://static.remove.bg/sample-gallery/graphics/bird-thumbnail.jpg">https://static.remove.bg/sample-gallery/graphics/bird-thumbnail.jpg</a></td></tr><tr><td>The values.n field is required</td><td>The value for dynamic variables in the message body or for the dynamic URL is missing.</td></tr></tbody></table>


# Webhooks

Webhooks allow you to receive data from the Emovur server to your server in real time when specific events occur.

1. Whenever there is a response on whatsapp flows
2. Whenever order is placed

<details>

<summary>Flows</summary>

[Flows](/modules/flows)

After publishing the flow

1. Navigate to the Dashboard -> WhatsApp -> Flows.
2. Click on the three dots on the right you will see an option called **“Webhook URL”** next to the specific flow.
3. Paste your **callback URL.**
4. **Custom fields** can be set up if you require additional information (optional).
5. Click on **"Submit".**

</details>

<details>

<summary>Order Updates</summary>

After creating an order&#x20;

1. Navigate to the Dashboard -> WhatsApp -> E-commerce -> Orders.
2. Click on **"Webhook details".**
3. Paste your **callback URL.**
4. **Custom fields** can be set up if you require additional information (optional).
5. Click on **"Submit".**

</details>

We offer 1-on-1 consultations with our developers to assist you in achieving the required integration. Additionally, we provide integration as a service to handle all necessary integrations on your behalf.                                                                                                  &#x20;

&#x20;                                                          [Reach out to us ! ](https://api.whatsapp.com/send/?phone=917373735479\&text=Hi,%20I%20want%20to%20connect%20with%20the%20developer)  &#x20;