mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-10-31 19:17:48 +00:00 
			
		
		
		
	 99997a701a
			
		
	
	99997a701a
	
	
	
		
			
			Implements comprehensive Twilio WhatsApp content template support (Phase
1) enabling text, media, and quick reply templates with proper parameter
conversion, sync capabilities, and feature flag protection.
###  Features Implemented
  **Template Types Supported**
  - Basic Text Templates: Simple text with variables ({{1}}, {{2}})
  - Media Templates: Image/Video/Document templates with text variables
  - Quick Reply Templates: Interactive button templates
- Phase 2 (Future): List Picker, Call-to-Action, Catalog, Carousel,
Authentication templates
  **Template Synchronization**
- API Endpoint: POST
/api/v1/accounts/{account_id}/inboxes/{inbox_id}/sync_templates
  - Background Job: Channels::Twilio::TemplatesSyncJob
  - Storage: JSONB format in channel_twilio_sms.content_templates
  - Auto-categorization: UTILITY, MARKETING, AUTHENTICATION categories
 ###  Template Examples Tested
  #### Text template
```
  { "name": "greet", "language": "en" }
```
  #### Template with variables
```
  { "name": "order_status", "parameters": [{"type": "body", "parameters": [{"text": "John"}]}] }
```
  #### Media template with image
```
  { "name": "product_showcase", "parameters": [
    {"type": "header", "parameters": [{"image": {"link": "image.jpg"}}]},
    {"type": "body", "parameters": [{"text": "iPhone"}, {"text": "$999"}]}
  ]}
```
#### Preview
<img width="1362" height="1058" alt="CleanShot 2025-08-26 at 10 01
51@2x"
src="https://github.com/user-attachments/assets/cb280cea-08c3-44ca-8025-58a96cb3a451"
/>
<img width="1308" height="1246" alt="CleanShot 2025-08-26 at 10 02
02@2x"
src="https://github.com/user-attachments/assets/9ea8537a-61e9-40f5-844f-eaad337e1ddd"
/>
#### User guide
https://www.chatwoot.com/hc/user-guide/articles/1756195741-twilio-content-templates
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>
		
	
		
			
				
	
	
		
			429 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
			
		
		
	
	
			429 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Vue
		
	
	
	
	
	
| <script>
 | |
| import { ref } from 'vue';
 | |
| import { useUISettings } from 'dashboard/composables/useUISettings';
 | |
| import { useKeyboardEvents } from 'dashboard/composables/useKeyboardEvents';
 | |
| import FileUpload from 'vue-upload-component';
 | |
| import * as ActiveStorage from 'activestorage';
 | |
| import inboxMixin from 'shared/mixins/inboxMixin';
 | |
| import { FEATURE_FLAGS } from 'dashboard/featureFlags';
 | |
| import { getAllowedFileTypesByChannel } from '@chatwoot/utils';
 | |
| import { ALLOWED_FILE_TYPES } from 'shared/constants/messages';
 | |
| import VideoCallButton from '../VideoCallButton.vue';
 | |
| import AIAssistanceButton from '../AIAssistanceButton.vue';
 | |
| import { REPLY_EDITOR_MODES } from './constants';
 | |
| import { INBOX_TYPES } from 'dashboard/helper/inbox';
 | |
| import { mapGetters } from 'vuex';
 | |
| import NextButton from 'dashboard/components-next/button/Button.vue';
 | |
| 
 | |
| export default {
 | |
|   name: 'ReplyBottomPanel',
 | |
|   components: { NextButton, FileUpload, VideoCallButton, AIAssistanceButton },
 | |
|   mixins: [inboxMixin],
 | |
|   props: {
 | |
|     mode: {
 | |
|       type: String,
 | |
|       default: REPLY_EDITOR_MODES.REPLY,
 | |
|     },
 | |
|     onSend: {
 | |
|       type: Function,
 | |
|       default: () => {},
 | |
|     },
 | |
|     sendButtonText: {
 | |
|       type: String,
 | |
|       default: '',
 | |
|     },
 | |
|     recordingAudioDurationText: {
 | |
|       type: String,
 | |
|       default: '00:00',
 | |
|     },
 | |
|     // inbox prop is used in /mixins/inboxMixin,
 | |
|     // remove this props when refactoring to composable if not needed
 | |
|     // eslint-disable-next-line vue/no-unused-properties
 | |
|     inbox: {
 | |
|       type: Object,
 | |
|       default: () => ({}),
 | |
|     },
 | |
|     showFileUpload: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     showAudioRecorder: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     onFileUpload: {
 | |
|       type: Function,
 | |
|       default: () => {},
 | |
|     },
 | |
|     toggleEmojiPicker: {
 | |
|       type: Function,
 | |
|       default: () => {},
 | |
|     },
 | |
|     toggleAudioRecorder: {
 | |
|       type: Function,
 | |
|       default: () => {},
 | |
|     },
 | |
|     toggleAudioRecorderPlayPause: {
 | |
|       type: Function,
 | |
|       default: () => {},
 | |
|     },
 | |
|     isRecordingAudio: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     recordingAudioState: {
 | |
|       type: String,
 | |
|       default: '',
 | |
|     },
 | |
|     isSendDisabled: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     showEditorToggle: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     isOnPrivateNote: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     enableMultipleFileUpload: {
 | |
|       type: Boolean,
 | |
|       default: true,
 | |
|     },
 | |
|     enableWhatsAppTemplates: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     enableContentTemplates: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     conversationId: {
 | |
|       type: Number,
 | |
|       required: true,
 | |
|     },
 | |
|     message: {
 | |
|       type: String,
 | |
|       default: '',
 | |
|     },
 | |
|     newConversationModalActive: {
 | |
|       type: Boolean,
 | |
|       default: false,
 | |
|     },
 | |
|     portalSlug: {
 | |
|       type: String,
 | |
|       required: true,
 | |
|     },
 | |
|     conversationType: {
 | |
|       type: String,
 | |
|       default: '',
 | |
|     },
 | |
|   },
 | |
|   emits: [
 | |
|     'replaceText',
 | |
|     'toggleInsertArticle',
 | |
|     'toggleEditor',
 | |
|     'selectWhatsappTemplate',
 | |
|     'selectContentTemplate',
 | |
|   ],
 | |
|   setup() {
 | |
|     const { setSignatureFlagForInbox, fetchSignatureFlagFromUISettings } =
 | |
|       useUISettings();
 | |
| 
 | |
|     const uploadRef = ref(false);
 | |
| 
 | |
|     const keyboardEvents = {
 | |
|       '$mod+Alt+KeyA': {
 | |
|         action: () => {
 | |
|           // TODO: This is really hacky, we need to replace the file picker component with
 | |
|           // a custom one, where the logic and the component markup is isolated.
 | |
|           // Once we have the custom component, we can remove the hacky logic below.
 | |
| 
 | |
|           const uploadTriggerButton = document.querySelector(
 | |
|             '#conversationAttachment'
 | |
|           );
 | |
|           uploadTriggerButton.click();
 | |
|         },
 | |
|         allowOnFocusedInput: true,
 | |
|       },
 | |
|     };
 | |
| 
 | |
|     useKeyboardEvents(keyboardEvents);
 | |
| 
 | |
|     return {
 | |
|       setSignatureFlagForInbox,
 | |
|       fetchSignatureFlagFromUISettings,
 | |
|       uploadRef,
 | |
|     };
 | |
|   },
 | |
|   data() {
 | |
|     return {
 | |
|       ALLOWED_FILE_TYPES,
 | |
|     };
 | |
|   },
 | |
|   computed: {
 | |
|     ...mapGetters({
 | |
|       accountId: 'getCurrentAccountId',
 | |
|       isFeatureEnabledonAccount: 'accounts/isFeatureEnabledonAccount',
 | |
|       uiFlags: 'integrations/getUIFlags',
 | |
|     }),
 | |
|     isNote() {
 | |
|       return this.mode === REPLY_EDITOR_MODES.NOTE;
 | |
|     },
 | |
|     wrapClass() {
 | |
|       return {
 | |
|         'is-note-mode': this.isNote,
 | |
|       };
 | |
|     },
 | |
|     showAttachButton() {
 | |
|       return this.showFileUpload || this.isNote;
 | |
|     },
 | |
|     showAudioRecorderButton() {
 | |
|       if (this.isALineChannel) {
 | |
|         return false;
 | |
|       }
 | |
|       // Disable audio recorder for safari browser as recording is not supported
 | |
|       // const isSafari = /^((?!chrome|android|crios|fxios).)*safari/i.test(
 | |
|       //   navigator.userAgent
 | |
|       // );
 | |
| 
 | |
|       return (
 | |
|         this.isFeatureEnabledonAccount(
 | |
|           this.accountId,
 | |
|           FEATURE_FLAGS.VOICE_RECORDER
 | |
|         ) && this.showAudioRecorder
 | |
|         // !isSafari
 | |
|       );
 | |
|     },
 | |
|     showAudioPlayStopButton() {
 | |
|       return this.showAudioRecorder && this.isRecordingAudio;
 | |
|     },
 | |
|     isInstagramDM() {
 | |
|       return this.conversationType === 'instagram_direct_message';
 | |
|     },
 | |
|     allowedFileTypes() {
 | |
|       // Use default file types for private notes
 | |
|       if (this.isOnPrivateNote) {
 | |
|         return this.ALLOWED_FILE_TYPES;
 | |
|       }
 | |
| 
 | |
|       let channelType = this.channelType || this.inbox?.channel_type;
 | |
| 
 | |
|       if (this.isAnInstagramChannel || this.isInstagramDM) {
 | |
|         channelType = INBOX_TYPES.INSTAGRAM;
 | |
|       }
 | |
| 
 | |
|       return getAllowedFileTypesByChannel({
 | |
|         channelType,
 | |
|         medium: this.inbox?.medium,
 | |
|       });
 | |
|     },
 | |
|     enableDragAndDrop() {
 | |
|       return !this.newConversationModalActive;
 | |
|     },
 | |
|     audioRecorderPlayStopIcon() {
 | |
|       switch (this.recordingAudioState) {
 | |
|         // playing paused recording stopped inactive destroyed
 | |
|         case 'playing':
 | |
|           return 'i-ph-pause';
 | |
|         case 'paused':
 | |
|           return 'i-ph-play';
 | |
|         case 'stopped':
 | |
|           return 'i-ph-play';
 | |
|         default:
 | |
|           return 'i-ph-stop';
 | |
|       }
 | |
|     },
 | |
|     showMessageSignatureButton() {
 | |
|       return !this.isOnPrivateNote;
 | |
|     },
 | |
|     sendWithSignature() {
 | |
|       // channelType is sourced from inboxMixin
 | |
|       return this.fetchSignatureFlagFromUISettings(this.channelType);
 | |
|     },
 | |
|     signatureToggleTooltip() {
 | |
|       return this.sendWithSignature
 | |
|         ? this.$t('CONVERSATION.FOOTER.DISABLE_SIGN_TOOLTIP')
 | |
|         : this.$t('CONVERSATION.FOOTER.ENABLE_SIGN_TOOLTIP');
 | |
|     },
 | |
|     enableInsertArticleInReply() {
 | |
|       return this.portalSlug;
 | |
|     },
 | |
|     isFetchingAppIntegrations() {
 | |
|       return this.uiFlags.isFetching;
 | |
|     },
 | |
|   },
 | |
|   mounted() {
 | |
|     ActiveStorage.start();
 | |
|   },
 | |
|   methods: {
 | |
|     toggleMessageSignature() {
 | |
|       this.setSignatureFlagForInbox(this.channelType, !this.sendWithSignature);
 | |
|     },
 | |
|     replaceText(text) {
 | |
|       this.$emit('replaceText', text);
 | |
|     },
 | |
|     toggleInsertArticle() {
 | |
|       this.$emit('toggleInsertArticle');
 | |
|     },
 | |
|   },
 | |
| };
 | |
| </script>
 | |
| 
 | |
| <template>
 | |
|   <div class="flex justify-between p-3" :class="wrapClass">
 | |
|     <div class="left-wrap">
 | |
|       <NextButton
 | |
|         v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_EMOJI_ICON')"
 | |
|         icon="i-ph-smiley-sticker"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="toggleEmojiPicker"
 | |
|       />
 | |
|       <FileUpload
 | |
|         ref="uploadRef"
 | |
|         v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_ATTACH_ICON')"
 | |
|         input-id="conversationAttachment"
 | |
|         :size="4096 * 4096"
 | |
|         :accept="allowedFileTypes"
 | |
|         :multiple="enableMultipleFileUpload"
 | |
|         :drop="enableDragAndDrop"
 | |
|         :drop-directory="false"
 | |
|         :data="{
 | |
|           direct_upload_url: '/rails/active_storage/direct_uploads',
 | |
|           direct_upload: true,
 | |
|         }"
 | |
|         @input-file="onFileUpload"
 | |
|       >
 | |
|         <NextButton
 | |
|           v-if="showAttachButton"
 | |
|           v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_ATTACH_ICON')"
 | |
|           icon="i-ph-paperclip"
 | |
|           slate
 | |
|           faded
 | |
|           sm
 | |
|         />
 | |
|       </FileUpload>
 | |
|       <NextButton
 | |
|         v-if="showAudioRecorderButton"
 | |
|         v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_AUDIORECORDER_ICON')"
 | |
|         :icon="!isRecordingAudio ? 'i-ph-microphone' : 'i-ph-microphone-slash'"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="toggleAudioRecorder"
 | |
|       />
 | |
|       <NextButton
 | |
|         v-if="showEditorToggle"
 | |
|         v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_FORMAT_ICON')"
 | |
|         icon="i-ph-quotes"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="$emit('toggleEditor')"
 | |
|       />
 | |
|       <NextButton
 | |
|         v-if="showAudioPlayStopButton"
 | |
|         v-tooltip.top-end="$t('CONVERSATION.REPLYBOX.TIP_FORMAT_ICON')"
 | |
|         :icon="audioRecorderPlayStopIcon"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         :label="recordingAudioDurationText"
 | |
|         @click="toggleAudioRecorderPlayPause"
 | |
|       />
 | |
|       <NextButton
 | |
|         v-if="showMessageSignatureButton"
 | |
|         v-tooltip.top-end="signatureToggleTooltip"
 | |
|         icon="i-ph-signature"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="toggleMessageSignature"
 | |
|       />
 | |
|       <NextButton
 | |
|         v-if="enableWhatsAppTemplates"
 | |
|         v-tooltip.top-end="$t('CONVERSATION.FOOTER.WHATSAPP_TEMPLATES')"
 | |
|         icon="i-ph-whatsapp-logo"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="$emit('selectWhatsappTemplate')"
 | |
|       />
 | |
|       <NextButton
 | |
|         v-if="enableContentTemplates"
 | |
|         v-tooltip.top-end="'Content Templates'"
 | |
|         icon="i-ph-whatsapp-logo"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="$emit('selectContentTemplate')"
 | |
|       />
 | |
|       <VideoCallButton
 | |
|         v-if="(isAWebWidgetInbox || isAPIInbox) && !isOnPrivateNote"
 | |
|         :conversation-id="conversationId"
 | |
|       />
 | |
|       <AIAssistanceButton
 | |
|         v-if="!isFetchingAppIntegrations"
 | |
|         :conversation-id="conversationId"
 | |
|         :is-private-note="isOnPrivateNote"
 | |
|         :message="message"
 | |
|         @replace-text="replaceText"
 | |
|       />
 | |
|       <transition name="modal-fade">
 | |
|         <div
 | |
|           v-show="uploadRef && uploadRef.dropActive"
 | |
|           class="flex fixed top-0 right-0 bottom-0 left-0 z-20 flex-col gap-2 justify-center items-center w-full h-full text-n-slate-12 bg-modal-backdrop-light dark:bg-modal-backdrop-dark"
 | |
|         >
 | |
|           <fluent-icon icon="cloud-backup" size="40" />
 | |
|           <h4 class="text-2xl break-words text-n-slate-12">
 | |
|             {{ $t('CONVERSATION.REPLYBOX.DRAG_DROP') }}
 | |
|           </h4>
 | |
|         </div>
 | |
|       </transition>
 | |
|       <NextButton
 | |
|         v-if="enableInsertArticleInReply"
 | |
|         v-tooltip.top-end="$t('HELP_CENTER.ARTICLE_SEARCH.OPEN_ARTICLE_SEARCH')"
 | |
|         icon="i-ph-article-ny-times"
 | |
|         slate
 | |
|         faded
 | |
|         sm
 | |
|         @click="toggleInsertArticle"
 | |
|       />
 | |
|     </div>
 | |
|     <div class="right-wrap">
 | |
|       <NextButton
 | |
|         :label="sendButtonText"
 | |
|         type="submit"
 | |
|         sm
 | |
|         :color="isNote ? 'amber' : 'blue'"
 | |
|         :disabled="isSendDisabled"
 | |
|         class="flex-shrink-0"
 | |
|         @click="onSend"
 | |
|       />
 | |
|     </div>
 | |
|   </div>
 | |
| </template>
 | |
| 
 | |
| <style lang="scss" scoped>
 | |
| .left-wrap {
 | |
|   @apply items-center flex gap-2;
 | |
| }
 | |
| 
 | |
| .right-wrap {
 | |
|   @apply flex;
 | |
| }
 | |
| 
 | |
| ::v-deep .file-uploads {
 | |
|   label {
 | |
|     @apply cursor-pointer;
 | |
|   }
 | |
| 
 | |
|   &:hover button {
 | |
|     @apply enabled:bg-n-slate-9/20;
 | |
|   }
 | |
| }
 | |
| </style>
 |