Engati - User Guide
...
Simplified Broadcast
Activating Broadcasts
Send WhatsApp Template Message
20min
send template message using engati send template message using engati the template message feature allows sending personalized broadcast messages to all your active whatsapp users this is useful for sending announcements, promotions, alerts and more key benefits of template messages include reaching your entire whatsapp userbase with important updates personalizing messages by adding user specific parameters driving engagement by sending relevant, non promotional content getting your message content approved by whatsapp for broadcasting automating and scheduling broadcasts to engage users with template messages, you can customize content for each user while reaching your entire audience this allows sending relevant updates at scale to drive growth overall, it enables engaging users in a personalized, non intrusive manner availability availability this feature is available if you have an active whatsapp setup with 360dialog, kaleyra navigate to configure>deployment > whatsapp to set up your whatsapp account setting up setting up after deploying your bot on whatsapp step 1 navigate to broadcast > broadcast history and then click "create new broadcast" to start a new broadcast campaign step 2 select whatsapp as the channel when only whatsapp is selected, you will see a "send template message" option in the broadcast type dropdown step 3 choose "send template message" from the dropdown menu so once your bot is live on whatsapp, you can create a new broadcast, choose whatsapp as the channel, and select the "send template message" option to get started with sending an approved template message to your users this allows you to send personalized broadcast messages to all your active whatsapp users for 360dialog you can select the required template from the list of approved templates in the select template drop down menu once you select a template its preview will be loaded on the right and corresponding parameters/media/document fields on the left if you had given parameters while creating a template you can now enter the desired value/attribute against those fields you can only use user level attributes, all other custom attributes cannot be used if an attribute is not present for a user, that will be sent as a blank field you can similarly upload media/documents against the corresponding field, if the approved template contains those fields there is a support two types of buttons 1\) call to action if you have used a parameter field in the url during template creation then you will be able to pass an attribute/value to it however the rest of the url along with the button field values and button names will not be editable 2\) quick reply for the quick reply button type, a customer can select the path that will be triggered upon clicking the button for kaleyra the basic broadcast functionality remains the same however previews will not be available for kaleyra as a provider if kaleyra is the whatsapp provider, you will see fields to enter template name, body parameters and image/document (if any) template name go to kaleyra https //kaleyra io/whatsapp/templates portal, channels>whatsapp> configurations and select template tab title can be copied and pasted in ‘template name’ field on engati parameter header select the header type from the drop down menu to match the header type of the corresponding template on kaleyra you can choose from none, text, image, document, and video and the ui will adjust to let you fill in the header fields with text/attribute for type text and a url for image, document, and video types none text –by default there would be one parameter field present you can add more fields if required to match the number of fields present in the template on kaleyra you can choose an attribute or value to pass to this parameter, just add the required number of parameters in ‘header’ column image – upload the required image document – upload the required pdf file as a document video – upload the required image parameters by default there would be one parameter field present you can add more fields if required to match the number of fields present in the template on kaleyra you can choose an attribute or value to pass to this parameter note 1\ in case of no parameters in header or body, just leave the field ‘parameter 1’ as empty 2 while editing the template you have to ensure that the configurations i e the number of parameters, media fields and buttons match exactly with the template created on kaleyra or else the template will not be sent to the users visit kaleyra logs https //kaleyra io/whatsapp/logs to see the status and reports of the sent templates you can test out the broadcast, by sending it to an existing user connected with the bot customers can now download the csv file with status of broadcasted messages from engati portal go to published broadcast and select view broadcast click on the number of target users once the broadcast is completed to download the status for each number test broadcast test broadcast this option is only available for whatsapp as a channel you can fill all the fields and choose to click on ‘test broadcast’ to send it to one of the existing users type the number and select an existing number from the auto fill dropdown or search for a existing contact and then click on send to send the template send template message using postman send template message using postman engati allows sending whatsapp template messages via postman for more technical users this is useful when you want to integrate broadcast messaging into other systems key benefits of using postman include integrating broadcast messaging into your existing workflows building customized scripts and tools to manage messaging scheduling and automating broadcast messages programmatically tracking message status and insights programmatically managing broadcasts at scale more efficiently for developers and technical teams, leveraging postman for template messaging provides more flexibility to build custom tools and workflows around engati's broadcast capabilities the apis allow managing and scaling messaging in ways tailored to your needs whatsapp template messages for 360dialog whatsapp template messages for 360dialog whatsapp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that have opted in to notifications messages can include appointment reminders, shipping information, issue resolution or payment updates there are two advantages to using a template you can send it to any whatsapp user even if they have not interacted with your business number templates can be sent to users who have crossed the limit of last interaction within 24 hours for more information you can refer to message templates https //developers facebook com/docs/whatsapp/api/messages/message templates/ creation of templates templates are static messages that need to be approved by the whatsapp team before execution for creating templates follow the following steps step 1 log into the 360 client hub step 2 you can access the platform for setup of templates by navigating to dashboard > select the account > manage templates step 3 click on the add template button to create a new template step 4 fill in the fields available with valid inputs step 5 once you have created a template then you would need to submit it for approval approval process takes time and hence we would advise you to send the correct template for approval to reduce back and forth, violation of rules set by whatsapp team would lead to rejection of the template sending template messages via api logs for it will be present in the api logs, and can be viewed by the filter whatsapp api here the api keys need to be added in the authorization header as follows – request type post request url https //api engati com/whatsapp api/v1 0/customer/\<customerid>/bot/\<botkey>/template header add these to the header authorization basic \<api key> content type application/json note to get your customer id, bot key and api key, navigate to integrations > engati api to generate an api key click on "+create app" once you've grasped the concepts of customer id, bot identifier, and api key, as well as where to locate them, proceed to follow the steps below to send a template message via api step 1 in the engati portal navigate to broadcast > message templates , click on " " button beside the template you want to sent and select generate curl step 2 copy the curl generated step 3 import the copied curl in postman and replace the variables with the values of the attributes in the body section that were created during the template creation process step 4 once done adding text, images and receiver phone number in respective places, click on "send" to send the template sample request send template curl curl location request post 'https //api engati com/whatsapp api/v1 0/customer/51638/bot/9d643f365ca14ae3/template' \\ \ header 'authorization basic 07c0996c ec01 424e 94fb cd0fdebb8cf4 fo5w5st' \\ \ header 'content type application/json' \\ \ data raw '{ "phonenumber" "+917366879580", "payload" { "language" { "policy" "deterministic", "code" "en" }, "namespace" "d44848c7 08b0 4a15 9c53 fbe0bcvbvbv353185", "components" \[ { "parameters" \[ { "type" "image", "image" { "link" "https //test com/wp content/uploads/2017/01/random jpg" } } ], "type" "header" }, { "parameters" \[ { "type" "text", "text" "dwded" }, { "type" "text", "text" "deede" } ], "type" "body" }, { "parameters" \[ { "type" "payload", "payload" "flow greetings 30234" } ], "type" "button", "index" 0, "sub type" "quick reply" }, { "parameters" \[ { "type" "payload", "payload" "flow greetings 30234" } ], "type" "button", "index" 1, "sub type" "quick reply" } ], "name" "food delivery confirmation" } }' responses success { "status" { "code" 1000, "desc" "success" } } failed to validate contact { "status" { "code" 2001, "desc" "failed to validate contact" } } failed to send message { "status" { "code" 2002, "desc" "failed to send message" }, "errors" \[] } bot not found { "status" { "code" 2003, "desc" "bot not found" } } api key not found { "status" { "code" 2004, "desc" "api key not found" } } other failures { "status" { "code" 2000, "desc" "failure" } } if you face any issues or queries please reach out to us at support\@engati com