stealth-messagebird

Messagebird WhatsApp Driver for Stealth

The Stealth WhatsApp driver adds the ability to build your bot using Messagebird service.

Messagebird allow you to use your own mobile number for WhatsApp. So no geographic restrictions compare to virtual mobile numbers (VMNs).

First thing first, create a Messagebird account and install your WhatsApp Business channel. This gem is not supporting the Messagebird Sandbox, since their Sandbox has limitations.

WhatsApp Supported Reply Types

• Text

• Image

• Audio

• Video/GIF (receive only)

• File

• Delay

• Location

In your replies files

- reply_type: location
  latitude: 41.69352000000001
  longitude: 44.801473999999985

More info here: https://developers.messagebird.com/quickstarts/whatsapp-deepdive/

Configure Messagebird with your Stealth bot

Once your WhatsApp Business Channel is active, you will receive a channel_id. To visualize your channel_id, go to Channels in the sidebar of your Messagebird Dashboard. You will need your Live API Key as well, go to Developers in the sidebar of your Messagebird Dashboard.

In services.yml

messagebird:
    access_key: <%= ENV['MESSAGEBIRD_ACCESS_KEY'] %>
    channel_id: <%= ENV['MESSAGEBIRD_CHANNEL_ID'] %>

Setup your Webhook

Create your webhook so that Messagebird can communicate with your app when receiving a message from a user. Subscribe to message.created event only.

curl -X POST "https://conversations.messagebird.com/v1/webhooks/" \
  -H "Authorization: AccessKey YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["message.created"],
    "channelId": "YOUR_CHANNEL_ID",
    "url": "https://1cfd8wc098r0.ngrok.io/incoming/messagebird"
  }'

When you provide your local ngrok URL to a messaging service, you will have to add /incoming/messagebird. More infos on Stealth Repo.

For more infos on webhooks, follow the Messagebird instructions.

current_message

When calling the current_message method in your Stealth bot, you can retrieve the following informations:

#<Stealth::Services::Messagebird::MessagebirdServiceMessage:0x00009ceg7cef4cd3
@attachments=[],
@conversation_id="1cdeee16bd432a987c167f67b611056f",
@display_name="Emilie",
@first_name="",
@last_name="",
@location={},
@message="Yo",
@messagebird_id="9881a12f6hhe4g41b9935hh4d299c01f",
@platform="whatsapp",
@read={},
@sender_id="33320110909",
@service="messagebird",
@target_id="098882ge-b745-1f12-a02f-4c1239da7d01",
@timestamp="2021-04-13T12:23:16Z">