Copy code authentication templates

Copy code authentication templates allow you to send a one-time password or code along with a copy code button to your users. 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.

Note: The "I didn't request a code" button is currently in beta and is being rolled out incrementally to business customers.

Copy code button authentication templates consist of:

• Preset text: <VERIFICATION_CODE> is your verification code.
• An optional security disclaimer: For your security, do not share this code.
• An optional expiration warning (optional): This code expires in <NUM_MINUTES> minutes.
• A copy code button.

Limitations

URLs, media, and emojis are not supported.

Creating authentication templates

Use the WhatsApp Business Account > Message Templates endpoint to create authentication templates.

Request Syntax

curl 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates' \   -H 'Content-Type: application/json' \   -H 'Authorization: Bearer EAAJB...' \   -d ' {     "name": "<TEMPLATE_NAME>",     "language": "<TEMPLATE_LANGUAGE>",     "category": "authentication",     "message_send_ttl_seconds": <TIME_TO_LIVE>,  // Optional     "components": [       {         "type": "body",         "add_security_recommendation": <SECURITY_RECOMMENDATION>  // Optional       },       {         "type": "footer",         "code_expiration_minutes": <CODE_EXPIRATION>  // Optional       },       {         "type": "buttons",         "buttons": [           {             "type": "otp",             "otp_type": "copy_code",             "text": "<COPY_CODE_BUTTON_TEXT>"  // Optional           }         ]       }     ]   }'

Note that in your template creation request the button type is designated as OTP, but upon creation the button type will be set to URL. You can confirm this by performing a GET request on a newly created authentication template and analyzing its components.

Request parameters

Example request

 curl 'https://graph.facebook.com/v24.0/102290129340398/message_templates' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer EAAJB...' \ -d ' {   "name": "authentication_code_copy_code_button",   "language": "en_US",   "category": "authentication",   "message_send_ttl_seconds": 60,   "components": [     {       "type": "body",       "add_security_recommendation": true     },     {       "type": "footer",       "code_expiration_minutes": 5     },     {       "type": "buttons",       "buttons": [         {           "type": "otp",           "otp_type": "copy_code",           "text": "Copy Code"         }       ]     }   ] }' 

Example response

 {   "id": "594425479261596",   "status": "PENDING",   "category": "AUTHENTICATION" } 

Sample app

See our WhatsApp One-Time Password (OTP) Sample App for Android on Github. The sample app demonstrates how to send and receive OTP passwords and codes via the API, how to integrate the one-tap autofill and copy code buttons, how to create a template, and how to spin up a sample server.

Sending authentication templates

This document explains how to send approved authentication templates with one-time password buttons.

Note that you must first initiate a handshake between your app and the WhatsApp client. See Handshake above.

Request syntax

curl -X POST "https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages" \   -H "Authorization: Bearer <ACCESS_TOKEN>" \   -H "Content-Type: application/json" \   -d ' {     "messaging_product": "whatsapp",     "recipient_type": "individual",     "to": "<CUSTOMER_PHONE_NUMBER>",     "type": "template",     "template": {       "name": "<TEMPLATE_NAME>",       "language": {         "code": "<TEMPLATE_LANGUAGE_CODE>"       },       "components": [         {           "type": "body",           "parameters": [             {               "type": "text",               "text": "<ONE-TIME PASSWORD>"             }           ]         },         {           "type": "button",           "sub_type": "url",           "index": "0",           "parameters": [             {               "type": "text",               "text": "<ONE-TIME PASSWORD>"             }           ]         }       ]     } }'

Request parameters

Response

Upon success, the API will respond with:

{   "messaging_product": "whatsapp",   "contacts": [     {       "input": "<INPUT>",       "wa_id": "<WA_ID>"     }   ],   "messages": [     {       "id": "<ID>"     }   ] }

Response parameters

Example request

 curl -L 'https://graph.facebook.com/v24.0/105954558954427/messages' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer EAAJB...' \ -d '{       "messaging_product": "whatsapp",       "recipient_type": "individual",       "to": "12015553931",       "type": "template",       "template": {         "name": "verification_code",         "language": {           "code": "en_US"       },       "components": [         {           "type": "body",           "parameters": [             {               "type": "text",               "text": "J$FpnYnP"             }           ]         },         {           "type": "button",           "sub_type": "url",           "index": "0",           "parameters": [             {               "type": "text",               "text": "J$FpnYnP"             }           ]         }       ]     }   }' 

Example response

 {   "messaging_product": "whatsapp",   "contacts": [     {       "input": "12015553931",       "wa_id": "12015553931"     }   ],   "messages": [     {       "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI4Qzc5QkNGNTc5NTMyMDU5QzEA"     }   ] }