whatsapp-ruby-sdk

Getting Started with WhatsApp Cloud API

Introduction

Welcome to the WhatsApp API from Meta.

Individual developers and existing Business Service Providers (BSPs) can now send and receive messages via the WhatsApp API using a cloud-hosted version of the WhatsApp Business API. Compared to the previous solutions, the cloud-based WhatsApp API is simpler to use and is a more cost-effective way for businesses to use WhatsApp. Please keep in mind the following configurations:

Name	Description
Version	Latest Graph API version. For example: v13.0
User-Access-Token	Your user access token after signing up at developers.facebook.com.
WABA-ID	Your WhatsApp Business Account (WABA) ID.
Phone-Number-ID	ID for the phone number connected to the WhatsApp Business API. You can get this with a Get Phone Number ID request.
Business-ID	Your Business' ID. Once you have your Phone-Number-ID, make a Get Business Profile request to get your Business' ID.
Recipient-Phone-Number	Phone number that you want to send a WhatsApp message to.
Media-ID	ID for the media to send a media message or media template message to your customers.
Media-URL	URL for the media to download media content.

Install the Package

Install the gem from the command line:

gem install whatsapp-ruby-sdk -v 1.0.0

Or add the gem to your Gemfile and run bundle:

gem 'whatsapp-ruby-sdk', '1.0.0'

For additional gem details, see the RubyGems page for the whatsapp-ruby-sdk gem.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
access_token	String	The OAuth 2.0 Access Token to use for API requests.
version	String	Default: 'v13.0'
environment	Environment	The API environment. Default: Environment.PRODUCTION
connection	Faraday::Connection	The Faraday connection object passed by the SDK user for making requests
adapter	Faraday::Adapter	The Faraday adapter object passed by the SDK user for performing http requests
timeout	Float	The value to use for connection timeout. Default: 60
max_retries	Integer	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	Float	Pause in seconds between retries. Default: 1
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	Array	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array	A list of HTTP methods to retry. Default: %i[get put]

The API client can be initialized as follows:

client = WhatsAppCloudApi::Client.new(
  access_token: 'AccessToken',
  environment: Environment::PRODUCTION,
  version: 'v13.0',
)

Authorization

This API uses OAuth 2 Bearer token.

List of APIs

• Business Profiles
• Phone Numbers
• Two-Step Verification
• Messages
• Registration
• Media

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest