WaCloudApi
WaCloudApi is a ruby gem that provides a convinient way to interact with Whatsapp Cloud API allowing developer to integrate Whatsapp messaging capabilities into Ruby / Rails applications.
Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add wa_cloud_api
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install wa_cloud_api
Usage
Configuration
Before using the gem, you need to configure it with your WhatsApp Cloud API credentials. You can do this by using the following code:
require 'wa_cloud_api'
WaCloudApi.configure do |config|
config.phone_number_id = 'your_phone_number_id'
config.token = 'your_token'
end
Features
- Text Message
- Reaction
- Location
Text Message
To send a text message to a phone number.
Parameters
-
to
: (Required) The phone number of the recipient. It should be in international format -
body
: (Required) The actual text message you want to send -
preview_url
: (Optional) A boolean parameter whether a URL preview should be generated for the links in the message. By default it is set to false
WaCloudApi::Message::Text.new(
to: 'recipient_phone_number ',
body: 'This is a test message',
).deliver
Reaction
To send a reaction to a message
Parameters
-
to
: (Required) The phone number of the recipient. It should be in international format -
message_id
: (required) The message id you want to react -
emoji
: (required) The emoji you want to react
WaCloudApi::Message::Reaction.new(
to: 'recipient_phone_number',
message_id: 'whatsapp_message_id',
emoji: 'emoji'
).deliver
Location
To send a location to a phone number
Parameters
-
to
: (Required) The phone number of the recipient. It should be in international format -
longitude
: (Required) Longitude of the location -
latitude
: (Required) Latitude of the location -
name
: (Optional) Name of the location -
address
: (Optional) Address of the location
WaCloudApi::Message::Location.new(
to: 'recipient_phone_number',
longitude: 'longitude',
latitude: 'latitude',
name: 'location_name',
address: 'location_address'
).deliver
Development
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rvs-teja/wa_cloud_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.