WhatsApp Authentication Template

what is an authentication templates? it allows businesses to send otp or delivery code messages to authenticate users through one time passcodes, typically digit alphanumeric codes without users initiating the conversation over whatsapp this is launched as a template message under the category of authentication what are the use cases? authentication templates are appropriate to use when providing an authentication code to the user on whatsapp verifying account or password reset transaction confirmation password reset two factor authentication for apps, or any business services delivery codes authentication message components sample authentication messages cases message default message {{​1}} is your verification code default message with security disclaimer {{​1}} is your verification code for your security, do not share this code default message with expiry disclaimer {{​1}} is your verification code footer this code expires in 15 minutes components fixed preset text \<verification code> is your verification code please note that you cannot edit or customize the authentication message an optional security disclaimer this is a preset text that gets added to your template message to display the security of your security, do not share this code optional expiration warning this is an optional present text that gets added to your message template as a footer to display the code expiry time this code expires in \<num minutes> minutes buttons the supported buttons are copy code enables users to copy the code to the clipboard for manual entry one tap autofill allows users to autofill the code with a single tap zero tap (not a button) seamlessly integrates code delivery within the app, currently supported on android authentication template message features authentication templates include optional add ons like security disclaimers and expiry warnings in addition, authentication templates must have a one time password button (copy code or one tap) template buttons copy code copy code authentication templates allow you to send a one time password or code along with a copy code button to your users user interaction when a whatsapp user taps the copy code button, the whatsapp client copies the password or code to the device's clipboard the user can then switch to your app and paste the password or code into your app limitations urls, media, and emojis are not supported one time autofill button includes either a copy code or a one tap autofill button which sends a one time password with a one tap autofill button user experience when a whatsapp user taps the autofill button, whatsapp triggers an activity that opens your app and delivers the password or code limitations only supported on android devices non android devices will see a copy code button instead important read more requirements and how to integrate your app to use the autofill functionality here one tap autofill whatsapp api zero tap button allows users to receive and use one time passwords without leaving the app technical integration the app captures the password automatically through a broadcast receiver, which requires integration user experience the password or code appears in the app automatically limitations only supported on android devices non android devices will see a copy code button instead important read more requirements and how to integrate your app to use the autofill functionality here zero tap whatsapp api note urls, media, and emojis are not supported because authentication templates with otp buttons only consist of preset text and buttons, their risk of being paused is significantly minimized time to live (ttl) time to live (ttl) is the duration for which meta will attempt to deliver a message to a whatsapp user before giving up if the message remains undelivered default ttl values general messages standard whatsapp messages typically have a ttl of 30 days authentication templates authentication templates have a shorter default ttl of 10 minutes how does ttl work meta continuously attempts to deliver the message to the recipient until the ttl expires if the message cannot be delivered within the ttl period, meta stops retrying and the message is dropped from the queue meta does not send you any callback notification if a message is not delivered after ttl expires ttl expiry webhook enhancement by exotel, we provide an enhanced experience by enabling this onto our webhook notifications we send a webhook update when a message fails to be delivered within the ttl with a specific error code, indicating that the message has been dropped this helps businesses monitor message delivery statuses and take timely actions if necessary best practices confirm user’s whatsapp number confirm the user's whatsapp phone number before sending the one time password or code to that number communicate delivery method make it clear to your users that the password or code will be delivered to their whatsapp phone number, especially if you offer multiple ways for the user to receive password or code delivery clarify code capture when the user pastes the password or code into your app, or your app receives it as part of the one tap autofill button flow, make it clear to the user that your app has captured it set appropriate ttl set a ttl that matches or is less than your code expiration time to ensure timely delivery and security authentication international rates authentication international rates specific countries have an authentication international rate like india & indonesia if you open an authentication conversation with a whatsapp user from such a country and meet the eligibility criteria, you will be billed the authentication–international rate (which is different than the normal domestic rate) criteria for authentication international rates your business is eligible for authentication international rates, doing more than 750k conversations in a rolling period your business is based in another country than that of the countries that have authentication international rates the conversation was opened on or after your start time for that country example if your business is based in indonesia and you open an authentication conversation with a user in indonesia, you will not be billed the authentication international rate however, if your business is based in india, you will be billed the authentication international rate if you meet all criteria eligibility for authentication international rate card usage if your business opens more than 750k conversations in a moving 30 day period across all of your whatsapp business accounts with users whose country calling codes are for a country that has an authentication international rate in india, the eligibility check is based on a 180 day period before the launch date primary business location authentication international rates are only applicable for certain regions and depend on two parameters, business location & user location hence meta has introduced new business settings for primary locations meta will attempt to determine your primary business location using publicly available information or ask you to update it from your meta business settings page under the business info page, here https //business facebook com/settings/info?business id=\<business id > note the businesses registered in the india or indonesia region are requested to update the primary business location to avoid getting charged for international rates start time once deemed eligible based on the above 2 points, meta will set your start times 30 days out for each country that has an authentication international rate from the date of eligibility notification meta will send an email to notify the business, once they are eligible for the authentication international rates and the primary location get notified once your business is eligible for authentication international rates meta will notify you of the international rate eligibility once you are eligible meta will send you an eligibility email (to all teh admins added under you waba) that includes these start times and the country that they set as your primary business location (if they were able to determine the country) please make sure that all your users or managers are added to your waba accounts as admins to receive such important updates this provides you with 30 days notice before authentication international rates apply webhooks will also be triggered that include your start times, and your primary business location note the eligibility is permanent once your business is deemed eligible, all authentication conversations opened on or after your start time will be charged the authentication international rate in markets where authorization international rates apply how to create the authentication templates via whatsapp manager dashboard access your whatsapp business account log in to your whatsapp business account navigate to templates go to the templates section create new template select ‘create new template’ and choose ‘authentication’ as the template type fill in template details select the required template details and configurations like security text, and expiry text add buttons choose to add either a one tap autofill button, a copy code button, or no button for zero tap set time to live optionally set the ttl by including the property with a value between 60 and 600 seconds or in minutes on the meta ui review and submit save the template and submit it for approval via create template apis use the create templates api to create & submit templates to whatsapp for approval the api supports both single and bulk creation post https //\<api key> \<api token>\<subdomain>/v2/accounts/\<your sid>/templates?waba id= replace \<your api key> and \<your api token> with the api key and token created by you replace \<your sid> with your “account sid” replace \<subdomain> with the region of your account \<subdomain> of singapore cluster is @api exotel com \<subdomain> of mumbai cluster is @api in exotel com \<your api key> , \<your api token> and \<your sid> are available in the api settings page of your exotel dashboard sample api request for authentication template with copy code button { "whatsapp" { "templates" \[ { "template" { "category" "authentication", "components" \[ { "type" "body", "add security recommendation" true }, { "type" "footer", "code expiration minutes" 10 }, { "type" "buttons", "buttons" \[ { "type" "otp", "otp type" "copy code" } ] } ], "name" "auth template copy code", "language" "en" } } ] } } for more sample requests, please go to our developer documentation preview the authentication templates after creating the template, it is equally important to review the message content before start using it you can preview the template on the whatsapp manager dashboard while creating the template or log in to the exotel messaging console via whatsapp manager dashboard access your templates go to the templates section in your whatsapp business account select template to preview choose the template you wish to preview preview message use the preview option to see how the message will appear to the user, including any buttons and optional text for exotel messaging dashboard log in to messaging console log in to the exotel console here and click on the whatsapp option available on the lhs navigation panel you can refer to these steps in case you are not able to navigate the whatsapp console here access your templates go to the templates section in your exotel messaging console seen on the lhs navigation bar select the waba id choose the correct waba id from the dropdown select template to preview choose the template you wish to preview preview message use the preview option to see how the message will appear to the user, including any buttons and optional text send the authentication templates via send message template apis this api can send messages to a single number with a message content or different numbers with different message contents for each number to send message through exotel api, you will need to make a http post request to post https //\<your api key> \<your api token>\<subdomain>/v2/accounts/\<your sid>/messages replace \<your api key> and \<your api token> with the api key and token created by you replace \<your sid> with your “account sid" replace \<subdomain> with the region of your account \<subdomain> of singapore cluster is @api exotel com \<subdomain> of mumbai cluster is @api in exotel com \<your api key> , \<your api token> and \<your sid> are available in the api settings page of your exotel dashboard sample api request { "custom data" "order123456", "status callback" "status callback url", "whatsapp" { "messages" \[ { "from" "{{​fromnumber}}", "to" "{{​tonumber}}", "content" { "type" "template", "template" { "name" "auth template copy code", "language" { "code" "en" }, "components" \[ { "type" "body", "parameters" \[ { "type" "text", "text" "123456" } ] }, { "type" "button", "sub type" "url", "index" "0", "parameters" \[ { "type" "text", "text" "123456" } ] } ] } } } ] } } for more sample requests, please go to our developer documentation checklists after sending the template messages initiate the message send request use your app to initiate a message send request with the chosen authentication template, and integrate the api with your system monitor delivery monitor the message delivery status through the webhook updates handle user interaction ensure your app can handle user interactions with the copy code button or one tap autofill button manage failures if a message fails to deliver within the ttl, handle it appropriately by considering alternative delivery methods or notifying the user