Skip to content

Commit

Permalink
Merge pull request #240 from plivo/SMS-6815
Browse files Browse the repository at this point in the history 
Adding support for location whatsapp messages
  • Loading branch information
@narayana-plivo
narayana-plivo authored May 17, 2024
2 parents 9d1500e + 3d6d564 commit f66fb42
Show file tree
Hide file tree
Showing 6 changed files with 422 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## [4.58.0](https://github.com/plivo/plivo-ruby/tree/v4.58.0) (2023-05-17)
**Feature - Adding support for location whatsapp messages**
- Added new param `location` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support location `whatsapp` messages
- Added new param `location` in templates to support location based templated messages

## [4.57.0](https://github.com/plivo/plivo-ruby/tree/v4.57.0) (2023-05-07)
**Feature - Adding support for interactive whatsapp messages**
- Added new param `interactive` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support interactive `whatsapp` messages
Expand Down
350 changes: 349 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
Add this line to your application's Gemfile:

```ruby
gem 'plivo', '>= 4.57.0'
gem 'plivo', '>= 4.58.0'
```

And then execute:
Expand Down Expand Up @@ -168,6 +168,354 @@ begin
end
```


## WhatsApp Messaging
Plivo's WhatsApp API allows you to send different types of messages over WhatsApp, including templated messages, free form messages and interactive messages. Below are some examples on how to use the Plivo Go SDK to send these types of messages.

### Templated Messages
Templated messages are a crucial to your WhatsApp messaging experience, as businesses can only initiate WhatsApp conversation with their customers using templated messages.

WhatsApp templates support 4 components: `header` , `body`, `footer` and `button`. At the point of sending messages, the template object you see in the code acts as a way to pass the dynamic values within these components. `header` can accomodate `text` or `media` (images, video, documents) content. `body` can accomodate text content. `button` can support dynamic values in a `url` button or to specify a developer-defined payload which will be returned when the WhatsApp user clicks on the `quick_reply` button. `footer` cannot have any dynamic variables.

Example 1:
```ruby
require "plivo"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

template={
"name": "template_name",
"language": "en_US",
"components": [
{
"type": "header",
"parameters": [
{
"type": "media",
"media": "https://xyz.com/s3/img.jpg"
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "WA-Text"
}
]
}
]
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
template:template,
url: "https://<yourdomain>.com/whatsapp_status/",
)
puts response
```

Example 2:
```ruby
require "plivo"
require "plivo/template"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

header_media_param = Parameter.new(type: "media", media: "https://xyz.com/s3/img.jpg")
body_text_params = [ Parameter.new(type: "text", text: "WA-Text") ]
​
header_component = Component.new(type: "header", parameters: [header_media_param])
body_component = Component.new(type: "body", parameters: body_text_params)
​
template = Template.new(name: "template_name", language: "en_US", components: [header_component, body_component])
​
response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
template:template,
url: "https://<yourdomain>.com/whatsapp_status/",
)
puts response
```
> Note: It is also possible to create and manage objects directly within the SDK for whatsapp, providing a structured approach to message creation.
### Free Form Messages
Non-templated or Free Form WhatsApp messages can be sent as a reply to a user-initiated conversation (Service conversation) or if there is an existing ongoing conversation created previously by sending a templated WhatsApp message.

#### Free Form Text Message
Example:
```ruby
require "plivo"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")
response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
text:"Hello, this is sample text",
url: "https://<yourdomain>.com/whatsapp_status/",
)
puts response
```

#### Free Form Media Message
Example:
```ruby
require "plivo"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")
response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
text:"Hello, this is sample text",
media_urls:["https://sample-videos.com/img/Sample-png-image-1mb.png"],
url: "https://<yourdomain>.com/wa_status/",
)
puts response
```

### Interactive Messages
This guide shows how to send non-templated interactive messages to recipients using Plivo’s APIs.

#### Quick Reply Buttons
Quick reply buttons allow customers to quickly respond to your message with predefined options.

Example:
```ruby
require "rubygems"
require "/usr/src/app/lib/plivo.rb"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

interactive= {
"type": "button",
"header": {
"type": "media",
"media": "https://xyz.com/s3/img.jpg"
},
"body": {
"text": "Make your selection"
},
"action": {
"buttons": [
{
"title": "Click here",
"id": "bt1"
},
{
"title": "Know More",
"id": "bt2"
},
{
"title": "Request Callback",
"id": "bt3"
}
]
}
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
)
puts response
```

#### Interactive Lists
Interactive lists allow you to present customers with a list of options.

Example:
```ruby
require "rubygems"
require "/usr/src/app/lib/plivo.rb"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

interactive= {
"type": "list",
"header": {
"type": "text",
"text": "Welcome to Plivo"
},
"body": {
"text": "You can review the list of rewards we offer"
},
"footer": {
"text": "Yours Truly"
},
"action": {
"buttons": [{
"title": "Click here"
}],
"sections": [
{
"title": "SECTION_1_TITLE",
"rows": [
{
"id": "SECTION_1_ROW_1_ID",
"title": "SECTION_1_ROW_1_TITLE",
"description": "SECTION_1_ROW_1_DESCRIPTION"
},
{
"id": "SECTION_1_ROW_2_ID",
"title": "SECTION_1_ROW_2_TITLE",
"description": "SECTION_1_ROW_2_DESCRIPTION"
}
]
},
{
"title": "SECTION_2_TITLE",
"rows": [
{
"id": "SECTION_2_ROW_1_ID",
"title": "SECTION_2_ROW_1_TITLE",
"description": "SECTION_2_ROW_1_DESCRIPTION"
},
{
"id": "SECTION_2_ROW_2_ID",
"title": "SECTION_2_ROW_2_TITLE",
"description": "SECTION_2_ROW_2_DESCRIPTION"
}
]
}
]
}
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
)
puts response
```

#### Interactive CTA URLs
CTA URL messages allow you to send links and call-to-action buttons.

Example:
```ruby
require "rubygems"
require "/usr/src/app/lib/plivo.rb"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

interactive= {
"type": "cta_url",
"header": {
"type": "media",
"media": "https://xyz.com/s3/img.jpg"
},
"body": {
"text": "Know More"
},
"footer": {
"text": "Plivo"
},
"action": {
"buttons": [
{
"title": "Click here",
"cta_url": "https:plivo.com"
}
]
}
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
)
puts response
```

### Location Messages
This guide shows how to send templated and non-templated location messages to recipients using Plivo’s APIs.

#### Templated Location Messages
Example:
```ruby
require "rubygems"
require "/usr/src/app/lib/plivo.rb"
require "/usr/src/app/lib/plivo/template.rb"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

template= {
"name": "plivo_order_pickup",
"language": "en_US",
"components": [
{
"type": "header",
"parameters": [
{
"type": "location",
"location": {
"longitude": "122.148981",
"latitude": "37.483307",
"name": "Pablo Morales",
"address": "1 Hacker Way, Menlo Park, CA 94025"
}
}
]
}
]
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
template:template
)
puts response
```

#### Non-Templated Location Messages
Example:
```ruby
require "rubygems"
require "/usr/src/app/lib/plivo.rb"
require "/usr/src/app/lib/plivo/location.rb"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")

location= {
"longitude": "122.148981",
"latitude": "37.483307",
"name": "Pablo Morales",
"address": "1 Hacker Way, Menlo Park, CA 94025"
}

response = api.messages.create(
src: "+14156667778",
dst:"+14156667777",
type:"whatsapp",
location:location
)
puts response
```

### More examples
More examples are available [here](https://github.com/plivo/plivo-examples-ruby). Also refer to the [guides for configuring the Rails server to run various scenarios](https://www.plivo.com/docs/sms/quickstart/ruby-rails/) & use it to test out your integration in under 5 minutes.

Expand Down
22 changes: 22 additions & 0 deletions lib/plivo/location.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
module Plivo
class Location
attr_accessor :latitude, :longitude, :name, :address

def initialize(latitude: nil, longitude: nil, name: nil, address: nil)
@latitude = latitude
@longitude = longitude
@name = name
@address = address
end

def to_hash
{
latitude: @latitude,
longitude: @longitude,
name: @name,
address: @address
}.reject { |_, v| v.nil? }
end
end
end

Loading

0 comments on commit f66fb42

Please sign in to comment.