diff --git a/README.md b/README.md
index 5d990cb..8b93e10 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# Ruby Whatsapp SDK
+
[](https://badge.fury.io/rb/whatsapp_sdk)
[](https://circleci.com/gh/ignacio-chiazzo/ruby_whatsapp_sdk)
@@ -6,7 +7,6 @@
The SDK provides a set of operations and classes to use the Whatsapp API.
Send stickers, messages, audio, videos, locations, react and reply to messages or just ask for the phone numbers through this library in a few steps!
-
## Demo
https://user-images.githubusercontent.com/11672878/173238826-6fc0a6f8-d0ee-4eae-8947-7dfd3b8b3446.mov
@@ -35,14 +35,15 @@ There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. `Mess
To use `Messages`, `Media` or `PhoneNumbers`, you need to initialize the `Client` that contains auth information. There are two ways to do it.
-1) Use an initializer
-
+1. Use an initializer
+
```ruby
# config/initializers/whatsapp_sdk.rb
WhatsappSdk.configure do |config|
config.access_token = ACCESS_TOKEN
end
```
+
OR 2) Create a `Client` instance and pass it to the `Messages`, `Medias` or `PhoneNumbers` instance like this:
```ruby
@@ -68,7 +69,7 @@ Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` a
Try sending a message to your phone in the UI.
-4) Copy the ACCESS_TOKEN, the SENDER_ID, the BUSINESS_ID and the RECEIPIENT_NUMBER
+4) Copy the ACCESS_TOKEN, the SENDER_ID, the BUSINESS_ID and the RECIPIENT_NUMBER
5) Use the GEM to interact with Whatsapp
-Example:
-1) Install the gem by running `gem install whatsapp_sdk` in the gem.
-2) Open the irb terminal by running `irb`
-3) `require "whatsapp_sdk"`
-4) Set up the `ACCESS_TOKEN`, the `SENDER_ID`, the `BUSINESS_ID` and the `RECEIPIENT_NUMBER` in variables.
+Example:
+
+1. Install the gem by running `gem install whatsapp_sdk` in the gem.
+2. Open the irb terminal by running `irb`
+3. `require "whatsapp_sdk"`
+4. Set up the `ACCESS_TOKEN`, the `SENDER_ID`, the `BUSINESS_ID` and the `RECIPIENT_NUMBER` in variables.
```ruby
ACCESS_TOKEN = "EAAZAvvr0DZBs0BABRLF8zohP5Epc6pyNu"
@@ -89,7 +91,7 @@ SENDER_ID = 1234567891011
RECIPIENT_NUMBER = 12398765432
```
-5) Configure the Client by running
+5. Configure the Client by running
```ruby
WhatsappSdk.configure do |config|
@@ -97,15 +99,17 @@ WhatsappSdk.configure do |config|
end
```
-6) Try the Phone Numbers API or Messages API
+6. Try the Phone Numbers API or Messages API
Phone Numbers API
+
```ruby
phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
registered_number = phone_numbers_api.registered_number(SENDER_ID)
```
Messages API
+
```ruby
messages_api = WhatsappSdk::Api::Messages.new
message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
@@ -117,6 +121,7 @@ Check the [example.rb file](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk
```ruby
@@ -142,25 +148,30 @@ templates_api.templates(business_id: BUSINESS_ID)
new_template = templates_api.create(
business_id: BUSINESS_ID, name: "seasonal_promotion", language: "en_US", category: "MARKETING",
components_json: components_json, allow_category_change: true
-)
+)
# Delete a template
templates_api.delete(business_id: BUSINESS_ID, name: "my_name") # delete by name
```
+
### Business Profile API
+
Get the details of your business
+
```ruby
business_profile = business_profile_api.details(123456)
```
Update the details of your business
+
```ruby
business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
```
+
### Phone numbers API
@@ -168,45 +179,55 @@ business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very
Get the list of phone numbers registered
+
```ruby
phone_numbers_api.registered_numbers(123456) # accepts a business_id
```
Get the a phone number by id
+
```ruby
phone_numbers_api.registered_numbers(123456) # accepts a phone_number_id
```
Register a phone number
+
```ruby
phone_numbers_api.register_number(phone_number_id, pin)
```
Deregister a phone number
+
```ruby
phone_numbers_api.deregister_number(phone_number_id)
```
+
### Media API
+
Upload a media
+
```ruby
medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
```
Get a media
+
```ruby
media = medias_api.media(media_id: MEDIA_ID)
```
Download media
+
```ruby
medias_api.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png', media_type: "image/png")
```
Delete a media
+
```ruby
medias_api.delete(media_id: MEDIA_ID)
```
@@ -214,6 +235,7 @@ medias_api.delete(media_id: MEDIA_ID)
### Messages API
+
**Send a text message**
@@ -223,6 +245,7 @@ messages_api.send_text(sender_id: 1234, recipient_number: 112345678, message: "h
```
**Read a message**
+
```ruby
messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M12345678910=")
```
@@ -230,7 +253,7 @@ messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M123456789
Note: To get the `message_id` you can set up [Webhooks](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components) that will listen and fire an event when a message is received.
**Send a reaction to message**
-To send a reaction to a message, you need to obtain the mssage id and look for the emoji's unicode you want to use.
+To send a reaction to a message, you need to obtain the message id and look for the emoji's unicode you want to use.
```ruby
messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "\u{1f550}")
@@ -256,6 +279,7 @@ messages_api.send_location(
**Send an image message**
It could use a link or an image_id.
+
```ruby
# with a link
messages_api.send_image(
@@ -270,6 +294,7 @@ messages_api.send_image(
**Send an audio message**
It could use a link or an audio_id.
+
```ruby
# with a link
messages_api.send_audio(sender_id: 123123, recipient_number: 56789, link: "audio_link")
@@ -280,6 +305,7 @@ messages_api.send_audio(sender_id: 123123, recipient_number: 56789, audio_id: "1
**Send a document message**
It could use a link or a document_id.
+
```ruby
# with a link
messages_api.send_document(
@@ -294,6 +320,7 @@ messages_api.send_document(
**Send a sticker message**
It could use a link or a sticker_id.
+
```ruby
# with a link
messages_api.send_sticker(sender_id: 123123, recipient_number: 56789, link: "link")
@@ -310,7 +337,8 @@ contacts = [create_contact(params)]
messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts: contacts)
```
-Alernative, you could pass a plain json like this:
+Alternatively, you could pass a plain json like this:
+
```ruby
messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts_json: {...})
```
@@ -328,7 +356,7 @@ date_time = WhatsappSdk::Resource::DateTime.new(fallback_value: "2020-01-01T00:0
image = WhatsappSdk::Resource::Media.new(type: "image", link: "http(s)://URL")
parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Image, image: image)
-# You can also use a plain string as type e.g.
+# You can also use a plain string as type e.g.
# parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: image)
parameter_text = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Text, text: "TEXT_STRING")
parameter_currency = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Currency, currency: currency)
@@ -366,7 +394,8 @@ button_component2 = WhatsappSdk::Resource::Component.new(
-Alernative, you could pass a plain json like this:
+Alternatively, you could pass a plain json like this:
+
```ruby
@messages_api.send_template(sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components_json: [{...}])
```
@@ -421,9 +450,11 @@ messages_api.send_interactive_list_messages(
interactive: interactive_list_messages
)
```
+