From 0138070f8da648f8366c1c3880bbf3a4d5b30725 Mon Sep 17 00:00:00 2001 From: Saurabh Newatiya Date: Sun, 12 May 2024 12:35:44 +0530 Subject: [PATCH 1/4] Adding support for location whatsapp messages --- CHANGELOG.md | 5 +++ README.md | 65 ++++++++++++++++++++++++++++++++- lib/plivo/location.rb | 22 +++++++++++ lib/plivo/resources/messages.rb | 39 ++++++++++++++++++++ lib/plivo/template.rb | 9 +++-- lib/plivo/version.rb | 2 +- 6 files changed, 137 insertions(+), 5 deletions(-) create mode 100644 lib/plivo/location.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index e67f5b2..89a14c7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Change Log +## [4.58.0](https://github.com/plivo/plivo-ruby/tree/v4.58.0) (2023-05-07) +**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 diff --git a/README.md b/README.md index c744e2f..b6962a8 100644 --- a/README.md +++ b/README.md @@ -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: @@ -168,6 +168,69 @@ 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: +```ruby +``` + +### 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 +``` + +#### Free Form Media Message +Example: +```ruby +``` + +### 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 +``` + +#### Interactive Lists +Interactive lists allow you to present customers with a list of options. + +Example: +```ruby +``` + +#### Interactive CTA URLs +CTA URL messages allow you to send links and call-to-action buttons. + +Example: +```ruby +``` + +### 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 +``` + +#### Non-Templated Location Messages +Example: +```ruby +``` + ### 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. diff --git a/lib/plivo/location.rb b/lib/plivo/location.rb new file mode 100644 index 0000000..c2f1587 --- /dev/null +++ b/lib/plivo/location.rb @@ -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 + \ No newline at end of file diff --git a/lib/plivo/resources/messages.rb b/lib/plivo/resources/messages.rb index 7d3a472..a10263d 100644 --- a/lib/plivo/resources/messages.rb +++ b/lib/plivo/resources/messages.rb @@ -93,6 +93,7 @@ def get(message_uuid) # @option options [String] :dlt_template_category This is the DLT template category passed in the message request. # @option options [Hash] :template This is the template used in the whatsapp message request. It can handle both JSON and String. # @option options [Hash] :interactive This is the interactive parameter used in the whatsapp message request. It can handle both JSON and String. + # @option options [Hash] :location This is the location parameter used in the whatsapp message request. It can handle both JSON and String. def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil) #All params in One HASH @@ -251,6 +252,25 @@ def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil end end + if value.is_a?(Hash) && !value[:location].nil? + if value.key?(:location) + if value[:location].is_a?(String) + begin + json_location = JSON.parse(value[:location]) + params[:location] = json_location + rescue JSON::ParserError => e + raise InvalidRequestError, 'failed to parse location as JSON' + end + elsif value[:location].is_a?(Hash) + params[:location] = value[:location] + elsif value[:location].is_a?(Plivo::Location) + params[:location] = value[:location].to_hash + else + raise InvalidRequestError, 'invalid location format' + end + end + end + #legacy code compatibility else valid_param?(:src, src, [Integer, String, Symbol], false) @@ -415,6 +435,25 @@ def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil end end + if options.is_a?(Hash) && !options[:location].nil? + if options.key?(:location) + if options[:location].is_a?(String) + begin + json_location = JSON.parse(options[:location]) + params[:location] = json_location + rescue JSON::ParserError => e + raise InvalidRequestError, 'failed to parse location as JSON' + end + elsif options[:location].is_a?(Hash) + params[:location] = options[:location] + elsif options[:location].is_a?(Plivo::Location) + params[:location] = options[:location].to_hash + else + raise InvalidRequestError, 'invalid location format' + end + end + end + end perform_create(params) end diff --git a/lib/plivo/template.rb b/lib/plivo/template.rb index c7dcdf9..40fc2ad 100644 --- a/lib/plivo/template.rb +++ b/lib/plivo/template.rb @@ -1,6 +1,7 @@ require_relative "resources" require_relative "base_client" require_relative "base" +require_relative "location" module Plivo class Template attr_accessor :name, :language, :components @@ -41,15 +42,16 @@ def to_hash end class Parameter - attr_accessor :type, :text, :media, :payload, :currency, :date_time + attr_accessor :type, :text, :media, :payload, :currency, :date_time, :location - def initialize(type: nil, text: nil, media: nil, payload: nil, currency: nil, date_time: nil) + def initialize(type: nil, text: nil, media: nil, payload: nil, currency: nil, date_time: nil, location: nil) @type = type @text = text @media = media @payload = payload @currency = currency @date_time = date_time + @location = location end def to_hash @@ -59,7 +61,8 @@ def to_hash media: @media, payload: @payload, currency: @currency&.to_hash, - date_time: @date_time&.to_hash + date_time: @date_time&.to_hash, + location: @location&.to_hash }.reject { |_, v| v.nil? } end end diff --git a/lib/plivo/version.rb b/lib/plivo/version.rb index 5d604ea..e12c03b 100644 --- a/lib/plivo/version.rb +++ b/lib/plivo/version.rb @@ -1,3 +1,3 @@ module Plivo - VERSION = "4.57.0".freeze + VERSION = "4.58.0".freeze end From 0c893e1485bf2d9399060b36128a3180fc0e8d2e Mon Sep 17 00:00:00 2001 From: Saurabh Newatiya Date: Fri, 17 May 2024 12:27:10 +0530 Subject: [PATCH 2/4] udpating README with whatsapp messaging examples --- README.md | 288 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 287 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6962a8..3238e84 100644 --- a/README.md +++ b/README.md @@ -177,9 +177,75 @@ Templated messages are a crucial to your WhatsApp messaging experience, as busin 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: +Example 1: +```ruby +require "plivo" +include Plivo + +api = RestClient.new("","") + +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://.com/whatsapp_status/", +) +puts response +``` + +Example 2: ```ruby +require "plivo" +require "plivo/template" +include Plivo + +api = RestClient.new("","") + +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://.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. @@ -187,11 +253,36 @@ Non-templated or Free Form WhatsApp messages can be sent as a reply to a user-in #### Free Form Text Message Example: ```ruby +require "plivo" +include Plivo + +api = RestClient.new("","") +response = api.messages.create( + src: "+14156667778", + dst:"+14156667777", + type:"whatsapp", + text:"Hello, this is sample text", + url: "https://.com/whatsapp_status/", +) +puts response ``` #### Free Form Media Message Example: ```ruby +require "plivo" +include Plivo + +api = RestClient.new("","") +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://.com/wa_status/", +) +puts response ``` ### Interactive Messages @@ -202,6 +293,46 @@ Quick reply buttons allow customers to quickly respond to your message with pred Example: ```ruby +require "rubygems" +require "/usr/src/app/lib/plivo.rb" +include Plivo + +api = RestClient.new("","") + +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 @@ -209,6 +340,70 @@ 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("","") + +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 @@ -216,6 +411,41 @@ 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("","") + +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 @@ -224,11 +454,67 @@ This guide shows how to send templated and non-templated location messages to re #### 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("","") + +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("","") + +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 From 29e961fcaca056464baa92d1e6ae4896321db4e5 Mon Sep 17 00:00:00 2001 From: Saurabh Newatiya Date: Fri, 17 May 2024 12:29:33 +0530 Subject: [PATCH 3/4] minor update in README --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3238e84..9930fdf 100644 --- a/README.md +++ b/README.md @@ -244,8 +244,7 @@ response = api.messages.create( ) 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. +> 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. From 3d6d564ad3926bdf8360fa77c41db04789d828f0 Mon Sep 17 00:00:00 2001 From: Saurabh Newatiya Date: Fri, 17 May 2024 15:16:51 +0530 Subject: [PATCH 4/4] updating release date --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89a14c7..5076554 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Change Log -## [4.58.0](https://github.com/plivo/plivo-ruby/tree/v4.58.0) (2023-05-07) +## [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