Zero-Tap Template

This document provides detailed information about the Authentication Template used for secure verification purposes. These templates allow businesses to send structured messages to users for authentication via one-time passcodes (OTPs).

Endpoint

http://{{your_domain}}/api/v1.0/{{phone_number_id}}/{{key}}/message_templates

• {{your_domain}}: Your domain URL where the API is hosted.
• {{phone_number_id}}: The unique identifier of the phone number used for sending messages.
• {{key}}: Your API key for authentication.How to create key

Request Headers

• Authorization: Bearer token for authentication.
• Content-Type: Should be set to application/json.

Template Information

• Name: zero_tap_auth_template_one
• Language: en_US (English – United States)
• Category: AUTHENTICATION
• Message Send TTL: 60 seconds
• Allow Category Change: No

Components

The zero_tap_auth_template_one consists of a Body, Footer, and Buttons component.

Body

• Type: BODY
• Security Recommendation: true
• Purpose: Includes an OTP and a security recommendation advising users to keep their verification code confidential.

Footer

• Type: FOOTER
• Code Expiration: 5 minutes
• Purpose: Informs the user of the OTP validity period.

Buttons

• Type: BUTTONS
• Buttons:
  • Type: otp
  • OTP Type: zero_tap
  • Text: Copy Code
  • Autofill Text: Autofill
  • Zero-Tap Terms Accepted: true
  • Supported Apps:
    • Package Name: app.pingtochat.com
    • Signature Hash: K8a/AINcGX7

Sample Request

{
  "name": "zero_tap_auth_template_one",
  "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": "zero_tap",
          "text": "Copy Code",
          "autofill_text": "Autofill",
          "zero_tap_terms_accepted": true,
          "supported_apps": [
            { 
              "package_name": "app.pingtochat.com",
              "signature_hash": "K8a/AINcGX7"
            }
          ]
        }
      ]
    }
  ]
}

Success Response

• Status Code: 201 APPROVED

{
    "id": "xxxxxx",
    "status": "APPROVED",
    "category": "AUTHENTICATION"
}

Notes

• This template is designed specifically for authentication purposes, including account verification and secure access.
• The Zero-Tap Autofill feature enhances user experience by reducing manual entry.
• The Copy Code button provides an alternative for users who need to manually enter their OTP.
• The message format supports variable placeholders, making it adaptable for multiple authentication scenarios.