Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To start using This document provides step-by-step instructions for integrating the WhatsApp communication channel (MXTS) following configuration need to be.I assume that Message Bird (Bird.com) account is already setup, next step is to setup WhatsApp channel (Message Bird)using Message Bird.

Before proceeding, ensure that you have an active Message Bird account.

1.

...

Setting Up the WhatsApp Channel

...

in Message Bird

...

Step-by-Step

...

Guide:

  1. Login to Message Bird:

    com, on
    • On the left navigation panel

    click on “Developer” menu
  2. Select “WhatsApp” menu, inside click on “WhatsApp Setup” sub-menu

  3. Click on “Add new channel” button on top right corner

  4. If
    • , click Developer.

  5. Navigate to WhatsApp Setup:

    • Select WhatsApp under the Developer menu.

    • Click on the WhatsApp Setup submenu.

  6. Add a New Channel:

    • Click on Add new channel in the top-right corner.

    • Choose:

      • I have own number if you already have a phone number

    select “I have own number” option (The number should not be register with WhatsApp before) or else to buy a new number select “By number” and proceed to payment.
  7. Click on “Click here to start” button (Step 2 of install WhatsApp screen) to start WhatsApp installation flow, if you have already register with Meta then login with credentials or else create new account.

  8. Once the previous step is completed assign
      • (ensure the number is not registered with WhatsApp).

      • Buy number if you need to purchase a new number. Follow the payment process.

  9. Start the Installation Flow:

    • Click Click here to start on the WhatsApp installation screen.

    • Log in with your Meta credentials or create a new account if necessary.

  10. Name Your Channel:

    • Assign a name to the channel

  11. At last click on “Install WhatsApp” button which will create a new WhatsApp channel against the phone number.

  12. Copy and paste the Channel-Id generated on your local (Required in MXTS)
    • .

  13. Install WhatsApp:

    • Click Install WhatsApp to finalize channel creation.

  14. Save the Channel ID:

    • Copy and save the generated Channel ID locally for use in MXTS.

...

2.

...

Setting Up WhatsApp Channel

...

Templates in Message Bird

...

Once WhatsApp channel is setup successfully, its time to setup a Template. WhatsApp/Meta has restriction on sending message to the customer outside of WhatsApp window time (is of 24hrs). To send a message to the customer you need to send a template (only approved templates are fetched in MXTS). The templates will be approved by Meta once it is published.

Ref: To understand more about WhatsApp window time here is the Message Bird documentation link

https://docs.bird.com/applications/channels/channels/supported-channels/whatsapp/concepts/whatsapps-customer-care-windowWhatsApp imposes restrictions on sending messages to customers outside the 24-hour messaging window. Approved templates are required for communication outside this window.

Step-by-Step

...

  1. In the same section “WhatsApp” inside “Developer” menu, there is “Template Management” option, click on it.

  2. Click on “Create new project” button on top right corner

  3. Select the Channel Type as “WhatsApp” → Interaction “WhatsApp approved” → Message Type as “Text”

  4. Assign name to the Project and click on “Start now” button

  5. You can edit the text as per your choice and once completed click on “Publish” button on top right corner

  6. It takes some time for Template to be approved by Meta, in case template is not approved a failure reason is shared after which a new template need to be created

  7. Once template is marked as green / ✅ it is approved by Meta and can be used in MXTS.

...

Guide:

  1. Navigate to Template Management:

    • Go to DeveloperWhatsAppTemplate Management.

  2. Create a New Template:

    • Click Create new project.

    • Set the channel type to WhatsApp, interaction type to WhatsApp approved, and message type to Text.

  3. Define and Publish Template:

    • Assign a project name and click Start now.

    • Edit the template text and click Publish.

  4. Wait for Approval:

    • Meta reviews templates before approval. If a template is rejected, a failure reason will be provided.

  5. Use Approved Templates:

    • Once a template is marked green, it is ready for use in MXTS.

Reference: Understanding WhatsApp’s Customer Care Window

...

3.

...

Generating an Access Key

...

in Message Bird

...

The Access Key is required to use Message Bird API’s for Sending/Receiving of the messages. This is sent in the API request to authenticate userauthenticate MessageBird API requests.

Step-by-Step

...

Guide:

  1. Navigate to “Developer” → “Access Management” → “Access Keys”

  2. Click on “Add new access key” button

  3. Assign to Access Management:

    • Go to DeveloperAccess ManagementAccess Keys.

  4. Create a New Access Key:

    • Click Add new access key.

    • Provide a name and description.

    • Set the role to

    the key and select role as “Organization Owner” and then click on “Save” button
  5. Copy and paste the generated access key to your notepad (it will not be visible again)

...

    • Organization Owner.

    • Click Save.

  1. Save the Access Key:

    • Copy the generated key to a secure location. It will only be displayed once.

...

4. Collecting Required Information for

...

MXTS

...

...

Information Required:

...

  1. Access Key

...

  1. : Generated in the previous

...

2. Channel Id - already collected in previous steps (tick)

3. Phone number - already collected in previous steps (tick)

4. Organization Id

Step-by-step guide:

...

Click on your profile top left corner

...

Click on “User settings”

...

Select “Organization” tab

...

  1. step.

  2. Channel ID: Saved during channel setup.

  3. Phone Number: Used in the WhatsApp channel.

  4. Organization ID:

    • Navigate to User settingsOrganization.

    • Copy the Organization ID.

...

  1. Workspace Id

Step-by-step guide:

  • Within same “Organization” tab there is sub-menu “Workspaces”

  • Click on “Workspaces” menu and copy the “Workspace ID” value and paste it on your local.

...

That’s it, we now have collected all the information required to start setting up Communication Channel - MXTS.

  1. ID:

    • In the Organization tab, click Workspaces.

    • Copy the Workspace ID.

...

5. Setting Up the WhatsApp Communication Channel in MXTS

Step-by-

...

Step Guide:

  1. Access Configuration:

    • Go to Customer Care Manager Configuration Communication Channel.

  2. Click on “Create new communication channel” button

  3. Select “WhatsApp (via Message Bird)” option

  4. Fill out necessary details like Name, Code, Default Inbox, SLA etc.

  5. On the next step, fill out all the fields with values we have already collected in previous steps. (Make sure the phone number is same as number in Message Bird WhatsApp Channel)

  6. Click Authenticate

    Create a New Communication Channel:

    • Click Create new communication channel.

    • Select WhatsApp (via MessageBird).

  7. Provide Necessary Details:

    • Name

    • Code

    • Default Inbox

    • SLA (if applicable)

    • Fill in details collected earlier (Access Key, Channel ID, Phone Number, etc.).

  8. Authenticate:

    • Click Authenticate. If successful, the channel status changes to will show Authenticated.

    • If authentication fails, troubleshoot using the error message.

  9. Test the integration by sending a test message.

  10. Verify that incoming and outgoing WhatsApp messages appear in the Unified Inbox of MXTSTest Communication:

    • Send test messages to ensure integration is working.