Skip to content

Commit

Permalink
Merge pull request #334 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 committed May 17, 2024
2 parents 99464aa + 59b5515 commit 6522df0
Show file tree
Hide file tree
Showing 8 changed files with 368 additions and 14 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

## [v4.66.0](https://github.com/plivo/plivo-node/tree/v4.66.0) (2024-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

## [v4.65.0](https://github.com/plivo/plivo-node/tree/v4.65.0) (2024-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
313 changes: 313 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,319 @@ console.log('Phlo run result', result);
});
```


## 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:
```javascript
var plivo = require('plivo');

var client = new plivo.Client("<auth_id>", "<auth_token>");

const 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"
}
]
}
]
}
client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
template:template,
url: "https://foo.com/wa_status/"
}).then(function (response) {
console.log(response);
});
```

### 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:
```javascript
var plivo = require('plivo');

var client = new plivo.Client("<auth_id>", "<auth_token>");
client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
text: "Hello, this is sample text",
url: "https://foo.com/wa_status/"
}).then(function (response) {
console.log(response);
});
```

#### Free Form Media Message
Example:
```javascript
var plivo = require('plivo');

var client = new plivo.Client("<auth_id>", "<auth_token>");
client.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://foo.com/wa_status/"
}).then(function (response) {
console.log(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:
```javascript
let plivo = require('plivo');

var client = new plivo.Client("<auth_id>","<auth_token>");

const 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"
}
]
}
}

client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
}).then(function (response) {
console.log(response);
});
```

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

Example:
```javascript
let plivo = require('plivo');

var client = new plivo.Client("<auth_id>","<auth_token>");

const 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"
}
]
}
]
}
}

client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
}).then(function (response) {
console.log(response);
});
```

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

Example:
```javascript
let plivo = require('plivo');

var client = new plivo.Client("<auth_id>","<auth_token>");

const 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"
}
]
}
}

client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
interactive:interactive
}).then(function (response) {
console.log(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:
```javascript
let plivo = require('plivo');

var client = new plivo.Client("<auth_id>","<auth_token>");

const 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"
}
}
]
}
]
}

client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
template:template
}).then(function (response) {
console.log(response);
});
```

#### Non-Templated Location Messages
Example:
```javascript
let plivo = require('plivo');

var client = new plivo.Client("<auth_id>","<auth_token>");

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

client.messages.create({
src:"+14156667778",
dst:"+14156667777",
type:"whatsapp",
location:location
}).then(function (response) {
console.log(response);
});
```

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

Expand Down
Loading

0 comments on commit 6522df0

Please sign in to comment.