diff --git a/docs/4. Product Features/03. Flows/2. Flow Actions/02. Send the contact a message.md b/docs/4. Product Features/03. Flows/2. Flow Actions/02. Send the contact a message.md index 2324799f7..f8f0337c4 100644 --- a/docs/4. Product Features/03. Flows/2. Flow Actions/02. Send the contact a message.md +++ b/docs/4. Product Features/03. Flows/2. Flow Actions/02. Send the contact a message.md @@ -1,260 +1,163 @@ -### **3 minutes read                                                                                                                         `Beginner`** + + + + + + +
4 minutes readLevel: BeginnerLast Updated: October 2025
-___ +

Send the contact a message

+As the name suggests, Send Message node allows the user to send a simple message to the end user. +This node is particularly useful in the following scenarios: -## Send the contact a message +1. Sending a plain text message that does not include any interactive elements such as buttons or lists. -It sends the message to the contact in the flow. You can also add variables in the content of the message to publish the value in the message. -Text messages can contain up to **4096** characters. Refer [Supported Contect Types](https://docs.gupshup.io/reference/msg#supported-content-types) to know more about it. -
-Refer [Flow level & Contact level variables](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Variables/Flow%20variables%20vs%20Contact%20variables) to know more about how to use variables in flow. +2. Sending media files as attachments to the end user. -image -## Format the text in messages. +3. Sending HSM templates to reinitiate engagement and bring the end user back into an active session window. -Basic WhatsApp text formatting option are available in flow editor. Refer [this article](https://faq.whatsapp.com/general/chats/how-to-format-your-messages/?lang=en) for more details +This document provides detailed guidance on: + -## Text Formatting +## Steps to use the Send Messsage node +Step 1: Log in to Glific. -1 . Place two asterisks before and after the text to make the text bold. Example: ** text ** **Bold** +Step 2: From the left panel, navigate to Flows and click on the Flows tab. -2 . Place one underscore before and after the text to make the text italic. Example: _ text _ **_Italic_** +Screenshot 2025-10-09 at 10 36 04 PM -3 . Place one (~) tilde before and after the text to apply a strikethrough effect to text. Example: ~ text ~ **~Strikethrough~** +Step 3: Click on the `+Create` button at the top right to start creating a new flow from scratch. -4 . Place one (``) backtick before and after the text to apply for monospace. Example: ` text ` +Screenshot 2025-10-09 at 10 37 13 PM -![image](https://user-images.githubusercontent.com/32592458/220825997-0e940f0f-2ca9-43b7-949a-0a53ee7f6fa5.png) +Step 4: Enter the required details to set up the new flow and click Configure to proceed. +Step 5: Create a `Send Message` node. -## Add Emojis +Step 6: The following node opens up: -Generally, all browser provide Emojis extension. Once you have added the extension, you can add emojis with right click in the text editor of message. +Screenshot 2025-10-09 at 10 38 27 PM -Below example is from chrome. +a. Home Tab: This tab allows the user to add the message content for a simple message. The content can include plain text, plain text with emojis, special characters, or external URL links (e.g., YouTube or website links). -![image](https://user-images.githubusercontent.com/32592458/220826004-44f8faf5-267c-4e2b-bea0-08bf9c21718e.png) +Basic text formatting can be applied as follows: -![image](https://user-images.githubusercontent.com/32592458/220826011-054d2829-c06a-4ff7-8cdd-78647fe01b35.png) -___ -## Send media files in a Message +
    +
  1. Bold: Place two asterisks before and after the text. Example: **text** → text
    2. +
  2. Italic: Place one underscore before and after the text. Example: _text_ → text
    3. +
  3. Strikethrough: Place one tilde (~) before and after the text. Example: ~text~ → text
    4. +
  4. Monospace: Place backticks (`) before and after the text. Example: `text` → text
    5. +
-Glific users can **upload the media files directly from their computer** for that you will need to setup GCS and make it active in Glific. -
-or -**[Upload the files on GCS](https://glific.github.io/docs/docs/Onboarding/GCS%20Setup/Upload%20files%20on%20GCS)** and use the URL as attachment in multiple flow. +For emojis, you can use browser extensions or type the text with emojis directly in WhatsApp and copy-paste it into the `Send Message` node. -## Activate GCS in Glific +Stored values in result or contact variables can also be referenced within the `Send Message` node. Read more about variables here -image +b. Attachments Tab: This tab allows the user to attach media files to be sent to the end user. +Screenshot 2025-10-09 at 11 20 29 PM -## Upload the media files directly from your computer. +Important Notes: -1 . Open a flow from where you want to send the file as an attachment. + -2 . Create a `Send message` Note. +c. HSM Templates: This tab allows the user to send an HSM template message to the end user. More information on HSM templates and their usage can be found here -3 . Click on `attachment` tab. +Screenshot 2025-10-09 at 11 19 57 PM +d. Character Count: The counter at the bottom left displays the total number of characters in the message. Note that text messages can contain up to 4096 characters. For further details on character limits, please refer to this link. -Screenshot 2024-03-05 at 1 38 48 PM +Step 7: After filling in the message contents, click `OK`. +Step 8: Publish the flow and test its functionality by clicking Preview on the simulator. -4 . Choose **upload attachment** option from dropdown +Screenshot 2025-10-09 at 10 54 45 PM +## Working with Media Files (Sending & Receiving) -Screenshot 2024-03-05 at 2 05 02 PM +For any business, there are two operations that are primarily possible, that involve media files: +1) The chatbot sends the media to the end user. +2) The end user sends the media to the chatbot. +For both operations to happen, the GCS (Google Cloud Storage) needs to be set up and made active. Refer to this section to understand how this can be done. -5 . Computer folders window will open up. Choose the file you want to upload. +### Chatbot sending the media to the end user. -**_Note :_** _WhatsApp business API_ **_doesn't support .gif files_** _to be send as messages. Use .jpeg or .png to send as an attachment. For more details please refer_ [https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media/) +There are two ways in which this can be achieved. -6 . After successful upload, option to **download** and **remove** the attachment will be shown. +1. Upload the media files directly from the computer. -7 . Click on `ok` button to save the attachment in the node. +Step 1: Open the flow from which you want to send a file as an attachment. -![image](https://user-images.githubusercontent.com/32592458/218255061-1cea068d-c206-44b7-ba2a-217e1e61d687.png) +Step 2: Create a Send Message node. + +Step 3: Click on the Attachments tab. -## +Screenshot 2025-10-09 at 10 59 52 PM -8 . Test the flow to verify the attachment sent with the message. +Step 4: Select the ‘Upload Attachment’ option from the dropdown menu. -![image](https://user-images.githubusercontent.com/32592458/218255067-5df94168-f97a-456b-a73d-8a8231e74821.png) +Screenshot 2025-10-09 at 11 00 28 PM -**Note :-** To give a name to the attachment, Enter the name in the send message box. Other wise the attachment will be names ad NULL. +Step 5: A file explorer window will open. Select the file you want to upload. -___ -## Upload media file in GCS +Step 6: Once the upload is successful, options to download or remove the attachment will be available. -1. Upload the file you want to send to the contact. Refer to the [integration with the GCS](https://glific.github.io/docs/docs/Onboarding/GCS%20Setup/Upload%20files%20on%20GCS/#upload-media-files-in-the-gcs-bucket) article for detailed steps. +Screenshot 2025-10-09 at 11 01 06 PM -![image](https://user-images.githubusercontent.com/32592458/218255076-94608d82-8ee0-4baf-9324-de902bbd1e33.png) +Step 7: Click `OK` to save the attachment in the node. -2. Copy the public URL of the image uploaded. +Step 8: Test the flow to confirm that the attachment is successfully sent to the end user. -![image](https://user-images.githubusercontent.com/32592458/218255079-a502b011-d960-4236-8645-d619b8da1806.png) -___ -## Send media file with dynamic file names +2. Upload files on the GCS and use the public URL generated in the Glific. -**Note** - _It will require a developers assistance to use this feature. Please check with your tech team or consult Glific team, if you wish to use this feature._ +As shown in the dropdown options under the Attachments tab, you can also add public URLs of media files (images, audio, video, stickers, PDFs) to send them. For details on file size and dimension restrictions, refer to this section. -**Use case** :- `Expression` option is used in attachment, when there is a requirement to send media files with dynamic names. +Please note - Google Drive links of media files cannot be used as public URLs. -For an example: The requirement is to send the map on the basis of the city contact belongs to. +To generate a public URL, first upload the media file to GCS. Once uploaded, copy the generated public URL and use it in this field. -1 . Upload map files of all cities in the GCS. +Steps to configure: -2 . Use the expression to pass the contact's city name in the attachment . +Step 1: Navigate to your GCS bucket using the steps mentioned here -Syntax- `<%= "@results.city_name" %>.` +Step 2: Upload the media files, following the steps mentioned here -3 . In a flow, city map will be send as per the contact's city +Step 3: In the flow editor, go to the ‘Attachments’ tab and select the applicable URL dropdown, depending on the media type uploaded on GCS. For example, if the media file is an image, select the ‘Image URL’ option from the dropdown. -Use `Expression` option from the dropdown, if media files name are needed to send with dynamic name. +Step 4: Paste the URL copied in Step 2. -Screenshot 2024-03-05 at 2 08 43 PM +Screenshot 2025-10-09 at 11 05 39 PM -The value of expression will be a variable and the syntax used in is `<%= "@results.fieldname" %>` +Step 5: Click on `Ok` -![image](https://user-images.githubusercontent.com/32592458/218255093-f78abcd6-7502-4ab7-9db4-deca30c1a4dc.png) -___ -## Attach the media file in a message +Step 6: Test the flow to confirm that the attachment is successfully sent to the end user. -1. While editing a flow, select `Send a message` node. +#### Sending Media files using Expressions -2. Click on the `Attachments` tab. +Common Use Case: This approach is useful when multiple media files need to be sent and Google Sheets is used to streamline the process. All media files are first uploaded to GCS, and their public URLs are added to a column in a Google Sheet. Each link is then fetched from the appropriate row and sent to the end user using the Expressions option. +- Refer to this documentation to learn how Google Sheets can be linked and configured within flows. + +- The syntax for expressions is: `@results.sheet.image`, where "image" is the column header in the sheet containing the public URL links to be sent to the end user. -Screenshot 2024-03-05 at 1 38 48 PM +Screenshot 2025-10-09 at 11 08 58 PM -3. Select the relevant media file option from the dropdown and paste the URL copied from GCS. - -**Note:** _google drive URLs will_ **_not_** _work in this attachment_ - - -Screenshot 2024-03-05 at 2 15 23 PM - - -![image](https://user-images.githubusercontent.com/32592458/218255111-7fc55f48-74a4-4f49-b126-97bd4e694179.png) - -4 . Click `ok` to save. -___ -## Test the media message in the simulator - -1. Run the simulator with the `preview` button(bottom right) on the flow editor screen. Select the required response and you will see the media file in the simulator. - -![image](https://user-images.githubusercontent.com/32592458/218255115-c412b26f-f9ad-46c8-a40b-2b3192e86674.png) - -**Note:-** Need to **add some text in the send message node**, otherwise the attachment will not be sent through flows - -![image](https://user-images.githubusercontent.com/16541548/210726298-2a705406-f00a-42fd-9826-56b8e5cac4ab.png) -___ -## Size of image - -Please use images of less than **5 MB**. It is the maximum size limit currently. - -Maximum size limit - -1. image file=> **5.120 MB** -1. Video file => **16.384 MB** -1. Audio file => **16.384 MB** -1. Document file => **102.400 MB** -1. Sticker file => **0.09 MB** - -Please Note : Whatsapp doesn't support send message node with audio file. Instead of using a single send message node, you can use two separate nodes for text and audio. -___ -## File Formats works - -Please check the list of file formats that work in the below document. [https://developers.facebook.com/docs/whatsapp/on-premises/reference/media](https://developers.facebook.com/docs/whatsapp/on-premises/reference/media) - -**Note: Stickers** - .webp ( **_Note:- Animated stickers are not allowed by WhatsApp_**). - -WhatsApp supports stickers with a **dimension of 512\*512 px** only. It needs to be exactly the same. - -![image](https://user-images.githubusercontent.com/32592458/218255148-973143ab-a092-47d9-984a-662da9e418b6.png) - -___ -## Store media files using GCS Integration - -Go to your Google Cloud storage GCS account ([https://console.cloud.google.com/apis/credentials/serviceaccountkey](https://console.cloud.google.com/apis/credentials/serviceaccountkey)) to generate project API keys. - -If you don't have an account in GCS please refer to [Create an account in Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/quickstart-console) to set up a new account in Google Cloud storage GCS?. - -Below screens may get change by Google. Refer below article from google for more details. [https://cloud.google.com/iam/docs/creating-managing-service-account-keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) - -1 . At top Bar enter Service account. Select `Service account` from the drop down. - -![image](https://user-images.githubusercontent.com/32592458/218255188-c6dc7c0a-843f-4e8e-b9fd-443744bebf26.png) - -2 . Click on `+Create Service account` link from top bar. - -![image](https://user-images.githubusercontent.com/32592458/218255191-f3b0c425-878b-4874-9447-776b61e23f76.png) - -3 . Enter the details. - - a) Serive account name - - b)Service account id auto filled. - - c) Description. - -4 . Click on `Done`. - -![image](https://user-images.githubusercontent.com/32592458/218255192-70bec877-205c-4c32-a895-3dfdd35d85af.png) - - - -5 . Click on `Add Key` button. - -![image](https://user-images.githubusercontent.com/32592458/218255199-d4d1c0dd-5fb8-4617-a825-bd8dde5d167a.png) - - - -6 . Select `json` and click on `create` button. - -![image](https://user-images.githubusercontent.com/32592458/218255204-8598019b-23bf-4ebe-b895-94cfa2a45a9a.png) - -___ -## Save the JSON in Glific to integrate - -1. Save the JSON file downloaded and copy its content. -2. Login to your Glific account. Go to the `setting` option in Glific and click on **Google Cloud Storage**. - - Screenshot 2024-03-05 at 2 19 54 PM - - - -3. Click on the `is_active` check. - -Screenshot 2024-03-05 at 2 21 28 PM - - - - - -4. Fill in the details from the downloaded JSON file. - - 1. Paste the copied JSON content inside Goth Credentials input. - 1. Project Email as `client_email` in the JSON file. - 1. **_"client_email": "xxx@xxx.iam.gserviceaccount.com",_** - 1. Bucket as the **bucket name** of the newly created bucket in the GCS dashboard - -![image](https://user-images.githubusercontent.com/32592458/218255222-24334f6f-d437-4705-97c6-707e25528446.png) - - - -5. Click on `Save` button - -6. Once Credentials are set up, all media files will be synced in a bucket inside the uploads directory. - -7. Now all the media files you will receive from the beneficiary contact (Via WhatsApp), will save in the Google cloud bucket in **uploads** folder. - - -![image](https://user-images.githubusercontent.com/32592458/218255243-9e5d9e3e-648e-43ac-8952-8b98d59339ce.png) - -![image](https://user-images.githubusercontent.com/32592458/218255247-f5887a21-328b-4217-ac62-2d37a61f8d5f.png) +Please find the other applications of this option here