Introduction

This guide provides specifications of the Gupshup Messaging API for WhatsApp Business for the purpose of sending and receiving messages on WhatsApp via a simple REST API through HTTP/HTTPS modes. This guide is intended for the developers and IT personnel of enterprises who plan to integrate their systems with the Gupshup Messaging API.

WhatsApp Template Categories

WhatsApp Business Messaging has categorized the messaging templates into 3 broad categories.

  • Utility
  • Marketing
  • Authentication

MARKETING

Marketing templates are flexible and do not relate to a specific, agreed-upon transaction. They may include the below definitions: promotions or offers, welcoming/closing messages, updates, invitations or recommendations, or requests to respond to or complete a new transaction.

UTILITY

Utility templates relate to a specific, agreed-upon transaction and accomplish one of the following: Confirm, suspend, or change a transaction or subscription.

AUTHENTICATION

Authentication templates can be used by businesses to authenticate users with one-time passcodes (usually 4-8 digit alphanumeric codes) for account verification, account recovery, etc. usually via a mobile app where users have the option to receive one-time passwords or verification codes via the WhatsApp app.

The Authentication templates can be created using Gupshup’s Unify panel. As a Meta implementation, this type
the template must include either a copy code or a one-tap autofill button. Buttons behave differently when tapped by a user:

  • A copy code button copies the one-time password or code to the user's clipboard. The user can then manually switch to your app and paste the password or code into your app's interface. Maximum number of permitted characters for the button name is 25.
  • A one-tap autofill button automatically loads and passes your app the one-time password or code. This feature will only be supported for recipients with an Android mobile device.
  • Zero-tap authentication templates allow your users to receive one-time passwords or codes via WhatsApp without having to leave your app

Note: Media Messages are not supported in the Authentication Template.