WhatsApp 360Dialog (Cloud API)

• This app is currently in beta. Expect ongoing updates and improvements. Your feedback is appreciated to enhance the app’s functionality.

• To move to the 360Dialog Cloud API from the on-premise API, refer to the 360Dialog documentation.

The WhatsApp 360Dialog app (Cloud API) is an integration for Rocket.Chat in partnership with 360Dialog, an official WhatsApp Business API provider offering message templates, automation, support, and data protection services.

Rocket.Chat’s 360Dialog (cloud API) app allows you to integrate your WhatsApp conversations with your Rocket.Chat workspace. You can send and receive text and media messages, send template messages, and register webhooks to receive messages. This document guides you through the app configuration details.

Prerequisites

• A Rocket.Chat workspace with Omnichannel enabled. Livechat agents and managers must also be assigned.

• A 360Dialog account; create a 360Dialog account if you don’t have one.

  • Add numbers to the account.

  • Generate an API key.

Before you proceed, keep the following points in mind about the data storage region:

• Our 360Dialog Cloud API architecture uses Meta for default data storage, hosted in the US. Depending on your location, this could involve an international data transfer. Even if you opt to change the storage location, our omnigateway remains situated in the US, necessitating an international data transfer. Refer to our Privacy Policy for information on data transfers.

• If you are a current 360Dialog customer and considering to transition from the on-premise API to the Cloud API, you can proceed independently. However, we recommend ensuring compliance with privacy regulations relevant to your jurisdiction.

• If you have any questions or require support, contact our privacy team.

Install WhatsApp app

1. Go to Administration > Apps > Marketplace.

2. Search for the WhatsApp 360Dialog (Cloud API) app.

3. Click Install and accept the needed permissions. The app bot will then send you a message with the setup instructions in the #omnichannel-whatsapp-cloud-api-setup private channel.

Configure WhatsApp app

After installing the app, you can update the app settings according to your requirements. To do this, follow these steps:

1. On the App Info page of the app, go to the Settings tab.

2. Enter the values for the following fields:

Connect WhatsApp numbers

After installing and configuring the app, connect verified WhatsApp numbers in the #omnichannel-whatsapp-cloud-api-setup private channel to enable communication. The bot sends the message Do you currently have a 360Dialog account? - If you don't we'll create one. Click No if you don’t have a 360Dialog account. Create an account first, then proceed with the following steps. If you have an account, click Yes and follow these steps:

1. Click Connect WhatsApp Number and enter the following details according to your requirements:

2. Once you have entered the details, click Connect.

You receive a success message that your WhatsApp number is now connected! Now, anyone in your organization can receive messages from this number and reply via Rocket.Chat. If your business has not yet been verified by Facebook, you need to start the business verification process within the Facebook Business Manager.

If you get an error message, check the app’s Logs tab to find the cause. If the issue is related to an invalid token, contact the Rocket.Chat support team for assistance.

Manage connected WhatsApp numbers

• After the number has successfully been connected to Rocket.Chat, you can click Edit to modify the details.

• Click Disconnect to remove the connected number.

App slash commands

Enter the slash command /whatsapp-360d-cloud to use the following shortcuts:

• /whatsapp-360d-cloud connect: Connect a new WhatsApp number.

• /whatsapp-360d-cloud numbers: View and edit all connected WhatsApp numbers.

• /whatsapp-360d-cloud view-templates: See all template messages. The information displayed includes the name, the WhatsApp number connected, and the languages used. Click Refresh Templates to sync the 360Dialog template messages with Rocket.Chat.

• /whatsapp-360d-cloud send-template: Send a template message.

• /whatsapp-360d-cloud support: Get support information.

• /whatsapp-360d-cloud help: See the list of shortcuts.

API endpoints

The available endpoints are displayed on the Details tab of the App Info page.

Get success message

The GET authSuccess endpoint is called when 360Dialog’s authentication process is successful. After registering an account on 360Dialog, 360Dialog automatically calls this endpoint and redirects back to the workspace upon successful authentication. You don’t need to take any action from your end.

For example, the request looks like this:

curl -X GET https://{workspace-url}/api/apps/private/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/6683e1680f160e8654ffd46b/authSuccess

Incoming message

The POST incoming endpoint is used by the app to receive messages from WhatsApp. You generally don’t need to take action with this endpoint.

For example, the request looks like this:

curl -X POST https://{workspace-url}/api/apps/private/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/6683e1680f160e8654ffd46b/incoming

Send a template message

You must use the POST templateMessage endpoint to send template messages. For more details, refer to the developer guide on sending template messages in Rocket.Chat and the 360dialog template messages guide.

For example, the request looks like this:

curl -X POST https://{workspace-url}/api/apps/private/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/6683e1680f160e8654ffd46b/templateMessage

The request body should look something like this:

"phoneNumbers": [
        "xxxxxxxxxxxxx"
    ],
    "connectedWhatsAppNo": "555195251xxx",
    "template": {
        "name": "boarding_pass",
        "language": {
            "code": "en",
            "policy": "deterministic"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "text",
                        "text": "halo"
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "abc"
                    },
                    {
                        "type": "text",
                        "text": "xyz"
                    }
                ]
            }
        ]
    }
}

Get the sidebar icon

You can use the GET get-sidebar-icon endpoint to get the WhatsApp conversation room icons displayed in the Chats in Progress section on the left-hand menu.

For example, the request looks like this:

curl -X GET https://{workspace-url}/api/apps/public/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/get-sidebar-icon