The expected payload on WhatsApp Cloud API is the following.
```json
{
"template": {
"name": "TEMPLATE_NAME",
"language": {
"code": "LANGUAGE_AND_LOCALE_CODE"
},
"components": [
"<NAMED_PARAMETER_INPUT>",
"<POSITIONAL_PARAMETER_INPUT>"
]
}
}
```
Named templates expect a `parameter_name`
```json
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "customer_name",
"text": "John"
},
{
"type": "text",
"parameter_name": "order_id",
"text": "9128312831"
}
]
}
```
In this PR, we would check if the template is a name template, then we
would send the `parameter_name` as well.
Reference: https://github.com/chatwoot/chatwoot/issues/10886
155 lines
6.9 KiB
Ruby
155 lines
6.9 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Whatsapp::SendOnWhatsappService do
|
|
template_params = {
|
|
name: 'sample_shipping_confirmation',
|
|
namespace: '23423423_2342423_324234234_2343224',
|
|
language: 'en_US',
|
|
category: 'Marketing',
|
|
processed_params: { '1' => '3' }
|
|
}
|
|
|
|
describe '#perform' do
|
|
before do
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/configs/webhook')
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/messages')
|
|
end
|
|
|
|
context 'when a valid message' do
|
|
let(:whatsapp_request) { instance_double(HTTParty::Response) }
|
|
let!(:whatsapp_channel) { create(:channel_whatsapp, sync_templates: false) }
|
|
|
|
let!(:contact_inbox) { create(:contact_inbox, inbox: whatsapp_channel.inbox, source_id: '123456789') }
|
|
let!(:conversation) { create(:conversation, contact_inbox: contact_inbox, inbox: whatsapp_channel.inbox) }
|
|
let(:api_key) { 'test_key' }
|
|
let(:headers) { { 'D360-API-KEY' => api_key, 'Content-Type' => 'application/json' } }
|
|
let(:template_body) do
|
|
{
|
|
to: '123456789',
|
|
template: {
|
|
name: 'sample_shipping_confirmation',
|
|
namespace: '23423423_2342423_324234234_2343224',
|
|
language: { 'policy': 'deterministic', 'code': 'en_US' },
|
|
components: [{ 'type': 'body', 'parameters': [{ 'type': 'text', 'text': '3' }] }]
|
|
},
|
|
type: 'template'
|
|
}
|
|
end
|
|
|
|
let(:named_template_body) do
|
|
{
|
|
messaging_product: 'whatsapp',
|
|
to: '123456789',
|
|
template: {
|
|
name: 'ticket_status_updated',
|
|
language: { 'policy': 'deterministic', 'code': 'en_US' },
|
|
components: [{ 'type': 'body',
|
|
'parameters': [{ 'type': 'text', parameter_name: 'last_name', 'text': 'Dale' },
|
|
{ 'type': 'text', parameter_name: 'ticket_id', 'text': '2332' }] }]
|
|
},
|
|
type: 'template'
|
|
}
|
|
end
|
|
|
|
let(:success_response) { { 'messages' => [{ 'id' => '123456789' }] }.to_json }
|
|
|
|
it 'calls channel.send_message when with in 24 hour limit' do
|
|
# to handle the case of 24 hour window limit.
|
|
create(:message, message_type: :incoming, content: 'test',
|
|
conversation: conversation)
|
|
message = create(:message, message_type: :outgoing, content: 'test',
|
|
conversation: conversation)
|
|
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/messages')
|
|
.with(
|
|
headers: headers,
|
|
body: { 'to' => '123456789', 'text' => { 'body' => 'test' }, 'type' => 'text' }.to_json
|
|
)
|
|
.to_return(status: 200, body: success_response, headers: { 'content-type' => 'application/json' })
|
|
|
|
described_class.new(message: message).perform
|
|
expect(message.reload.source_id).to eq('123456789')
|
|
end
|
|
|
|
it 'calls channel.send_template when after 24 hour limit' do
|
|
message = create(:message, message_type: :outgoing, content: 'Your package has been shipped. It will be delivered in 3 business days.',
|
|
conversation: conversation)
|
|
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/messages')
|
|
.with(
|
|
headers: headers,
|
|
body: template_body.to_json
|
|
).to_return(status: 200, body: success_response, headers: { 'content-type' => 'application/json' })
|
|
|
|
described_class.new(message: message).perform
|
|
expect(message.reload.source_id).to eq('123456789')
|
|
end
|
|
|
|
it 'calls channel.send_template if template_params are present' do
|
|
message = create(:message, additional_attributes: { template_params: template_params },
|
|
content: 'Your package will be delivered in 3 business days.', conversation: conversation, message_type: :outgoing)
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/messages')
|
|
.with(
|
|
headers: headers,
|
|
body: template_body.to_json
|
|
).to_return(status: 200, body: success_response, headers: { 'content-type' => 'application/json' })
|
|
|
|
described_class.new(message: message).perform
|
|
expect(message.reload.source_id).to eq('123456789')
|
|
end
|
|
|
|
it 'calls channel.send_template with named params if template parameter type is NAMED' do
|
|
whatsapp_cloud_channel = create(:channel_whatsapp, provider: 'whatsapp_cloud', sync_templates: false, validate_provider_config: false)
|
|
cloud_contact_inbox = create(:contact_inbox, inbox: whatsapp_cloud_channel.inbox, source_id: '123456789')
|
|
cloud_conversation = create(:conversation, contact_inbox: cloud_contact_inbox, inbox: whatsapp_cloud_channel.inbox)
|
|
|
|
named_template_params = {
|
|
name: 'ticket_status_updated',
|
|
language: 'en_US',
|
|
category: 'UTILITY',
|
|
processed_params: { 'last_name' => 'Dale', 'ticket_id' => '2332' }
|
|
}
|
|
|
|
stub_request(:post, "https://graph.facebook.com/v13.0/#{whatsapp_cloud_channel.provider_config['phone_number_id']}/messages")
|
|
.with(
|
|
:headers => { 'Content-Type' => 'application/json', 'Authorization' => "Bearer #{whatsapp_cloud_channel.provider_config['api_key']}" },
|
|
:body => named_template_body.to_json
|
|
).to_return(status: 200, body: success_response, headers: { 'content-type' => 'application/json' })
|
|
message = create(:message,
|
|
additional_attributes: { template_params: named_template_params },
|
|
content: 'Your package will be delivered in 3 business days.', conversation: cloud_conversation, message_type: :outgoing)
|
|
|
|
described_class.new(message: message).perform
|
|
expect(message.reload.source_id).to eq('123456789')
|
|
end
|
|
|
|
it 'calls channel.send_template when template has regexp characters' do
|
|
message = create(
|
|
:message,
|
|
message_type: :outgoing,
|
|
content: 'عميلنا العزيز الرجاء الرد على هذه الرسالة بكلمة *نعم* للرد على إستفساركم من قبل خدمة العملاء.',
|
|
conversation: conversation
|
|
)
|
|
|
|
stub_request(:post, 'https://waba.360dialog.io/v1/messages')
|
|
.with(
|
|
headers: headers,
|
|
body: {
|
|
to: '123456789',
|
|
template: {
|
|
name: 'customer_yes_no',
|
|
namespace: '2342384942_32423423_23423fdsdaf23',
|
|
language: { 'policy': 'deterministic', 'code': 'ar' },
|
|
components: [{ 'type': 'body', 'parameters': [] }]
|
|
},
|
|
type: 'template'
|
|
}.to_json
|
|
).to_return(status: 200, body: success_response, headers: { 'content-type' => 'application/json' })
|
|
|
|
described_class.new(message: message).perform
|
|
expect(message.reload.source_id).to eq('123456789')
|
|
end
|
|
end
|
|
end
|
|
end
|