The WhatsApp API enables businesses to integrate WhatsApp messaging into their customer communication workflows, providing a reliable, secure, and scalable way to interact with customers. It supports sending notifications, automated messages, and real-time customer interactions.

Features of the WhatsApp API in Pingtochat

• Rich Messaging
  • Supports text, images, videos and documents.
  • Interactive messages like buttons and list messages.
• Notification Messaging
  • Send alerts, order updates, and reminders to customers.
• Business Profile
  • Display company information, contact details, and catalogs.
• Multi-Agent Access
  • Support multiple agents interacting through one WhatsApp number.

Signing Up

To use Pingtochat Messaging APIs with WhatsApp, you will need a WhatsApp-enabled phone number, also referred to as a WhatsApp Sender.

Once you have an approved WhatsApp Sender, continue on below to get started with a WhatsApp Create Token in the language of your choice!

The REST API allows developers to interact programmatically with our platform to access and manage resources such as users, messages, and configurations. It follows standard RESTful principles, ensuring a stateless, secure, and scalable design.

With the REST API, you can:

• Send messages
• Fetch , list and delete messages
• Fetch , list and delete media messages

We have three categories of messaging, which are

• Marketing
• Utility
• Authentication

We provide simple messages and template messages. Template messages also support media messages.

Authentication

To add authentication, you need to register on our platform Pingtochat and log in to your account. Then, create the API key and access token. Click here on Add Token to learn more about creating the token.

First, you need to create an API key and token for WhatsApp configuration. To create these, click on the Pingtochat Register link to register, or the Pingtochat Login link to log in to Pingtochat. After successfully registering or logging in, you will find an option to add an API key and token on the left side of the dashboard.

To Generate Token
Navigate to: Settings ->API ->Token.

Select your WABA ID and Sender ID, then choose the version. Finally, click the “Generate Token” button to create your Token

Generate the Whatsapp Sender

If you don’t have a WhatsApp sender number, click the “Register” link for Sender ID to create one. Follow the steps provided to complete the registration process. Once registered, ensure the sender number is verified and linked to your account before proceeding with token generation.

Pingtochat supports webhooks that can alert you of the following via callback URLs.

• Messages received
• Messages sent (Template & Session)
• Status of the messages sent (Sent/Delivered/read)

How to add a Webhook to Pingtochat?

• Navigate to:Settings ->API ->Webhook.

• Create an HTML URL for the webhook.
• Enter your Hub Verification Token in the designated field on the webhook form.

• When an event occurs, we will send the hub verify token along with the hub challenge to the provided URL.
• For verification, the customer must return the same hub challenge to confirm receipt.

This ensures successful integration and validation of webhook events.

Example :

<?php

$input = file_get_contents('php://input');
$hub_challenge  = json_decode($input)->hub_challenge;
$verify_token  = json_decode($input)->hub_verify_token;
$expected_token = '123';

if ($verify_token === $expected_token) {
   
    http_response_code(200);
    echo $hub_challenge;
    exit;
}

http_response_code(400);
echo json_encode(["message" => "Bad request!"]);
?>

A session message in WhatsApp refers to any message exchanged between a business and a customer within a 24-hour messaging window that starts when the customer sends a message to the business. These messages are not pre-approved by WhatsApp and can include free-form text, media, or interactive content.

URL

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

Method

POST

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Request Payloads

Sending a Text Message

The payload for sending a plain text message via the WhatsApp API is structured as follows:

Example :

{
  "messaging_product": "whatsapp",
  "to": "91xxxxxxxxxx",
  "type": "text",
  "text": {
    "body": "Hello!"
  }
}

Field Descriptions

• messaging_product: (string) Specifies the messaging product. For WhatsApp, this is always whatsapp.
• to: (string) The recipient’s phone number in E.164 format. Example: 919880132082.
• type: (string) The type of message being sent. Use text for plain text messages.
• text: (object) Contains the message text.
  • body: (string) The text message content. Example: "Hello!".

Response

Example Success Response

A successful request returns a 200 OK status and a response payload similar to the following:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx"
    }
  ],
  "messages": [
    {
      "id": "RfzuNs4qpN"
    }
  ]
}

Field Descriptions

• messaging_product: (string) The messaging product used. Always whatsapp.
• contacts: (array) Contains information about the recipient.
  • input: (string) The phone number you provided in the request.
  • wa_id: (string) The WhatsApp ID associated with the provided phone number.
• messages: (array) Contains information about the sent message.
  • id: (string) The unique identifier for the sent message.

Notes

1. Domain and Credentials: Replace {{your_domain}}, {{phone_number_id}}, and {{key}} with your API domain, phone number ID, and API key respectively.
2. Rate Limits: Ensure your API calls comply with the rate limits set by WhatsApp to avoid being throttled.
3. Session Window: Text messages can only be sent within a 24-hour window of the last user interaction.
4. Template Pre-Approval: For template messages, ensure they are approved in the WhatsApp Business Manager before use.
5. Language Code Matching: Language codes in templates must match the approved template language.

Sample codes

In PinToChat, we provide three distinct categories of messages, each with its own supported types and functionalities

Categories:

1. Authentication:
   • Supports only the Body component for message templates.
   • Primarily used for identity verification and authentication purposes, such as sending OTPs or login confirmations.
2. Marketing:
   • Supports all types of messaging, including text and media.
   • Ideal for promotional campaigns and engaging with users through rich media content.
3. Utility:
   • Supports all types of messaging, including text and media.
   • Designed for sending notifications, alerts, and other informative content.

Message Types:

Messages are available in two main types:

1. Text:
   • Simple text-based messages for quick and clear communication.
2. Media:
   • Includes rich content for enhanced engagement, categorized into:
     • Image: Sending photos or images.
     • Video: Sharing video clips.
     • Document: Sending files like PDFs, Word documents, or spreadsheets

Message Types:

Messages are available in two main types:

1. Text:
   • Simple text-based messages for quick and clear communication.
2. Media:
   • Includes rich content for enhanced engagement, categorized into:
     • Image: Sending photos or images.
     • Video: Sharing video clips.
     • Document: Sending files like PDFs, Word documents, or spreadsheets.

Button Types:

Interactive buttons can be added to messages for better user engagement. The available button types are:

• Quick Reply Button:
  • Enables users to respond quickly with predefined options.
• Visit Website Button:
  • Directs users to a specific webpage.
• URL Button:
  • Opens a designated URL in the browser.
• Phone Number Button:
  • Allows users to call a predefined phone number directly.
• WhatsApp Number Button (Call on WhatsApp):
  • Initiates a call directly on WhatsApp to a given contact.
• Copy Offer Code Button:
  • Provides an option to copy a promo or offer code to the clipboard.

Authentication templates are specialized message formats used by businesses to verify user identities through one-time passcodes (OTPs) delivered via messaging platforms like WhatsApp. These templates ensure secure and efficient user authentication during processes such as account verification, recovery, and integrity challenges.

Key Features of Authentication Templates:

• Preset Message Content: The templates include fixed text, such as “<VERIFICATION_CODE> is your verification code,” along with optional security disclaimers and expiration warnings.
• Interactive Buttons: They feature buttons like “COPY_CODE,” which allows users to copy the OTP to their clipboard, and “ONE_TAP,” enabling automatic code autofill within the app. ​

Zero-Tap Authentication Templates

Zero-tap authentication templates allow your users to receive one-time passwords or codes via WhatsApp without having to leave your app.’

One-Tap Autofill Authentication Templates

One-tap autofill authentication templates allow you to send a one-time password or code along with an one-tap autofill button to your users. When a WhatsApp user taps the autofill button, the WhatsApp client triggers an activity which opens your app and delivers it the password or code.

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.

Overview

Marketing templates on WhatsApp are designed to send promotional messages, share information about products or services, or communicate business-related updates. These templates are pre-approved by WhatsApp and must comply with the platform’s policies to ensure they provide value to users without being spammy or intrusive. Below is the detailed documentation on marketing templates, their structure, and best practices.

Key Characteristics of Marketing Templates

1. Purpose:
   • To promote products, services, or offers.
   • To share informational updates about the business.
   • To engage users with campaigns, announcements, or events.
2. Use Cases:
   • Sending special offers or discounts.
   • Announcing a new product or service.
   • Inviting users to events or webinars.
   • Sharing business updates, such as holiday hours or relocations.
3. Compliance:
   • Must adhere to WhatsApp’s Business Policy.
   • Requires explicit user opt-in for promotional content.

Components of a Marketing Template

Marketing templates can consist of the following elements:

1. Header (Optional)

• Type: Text, Image, Video, or Document.
• Purpose: To grab attention with a visually appealing or textual header.
• Example: Including a product image or a “Special Offer” banner.

2. Body (Required)

• Type: Text.
• Purpose: Contains the primary message content, such as promotional text or product details.
• Example:
  • “Get 20% off on your next purchase! Use code SAVE20. Offer valid till Jan 31, 2025.”
  • “Introducing our latest collection! Check it out now and enjoy exclusive discounts.”

3. Footer (Optional)

• Type: Text.
• Purpose: Provides additional context, disclaimers, or contact information.
• Example: “Terms and conditions apply. Visit our website for more details.”

4. Buttons (Optional)

• Types: Quick Reply , URL ,Phone Number and Copy Code
• Purpose: To encourage user interaction and provide actionable options.
  • Quick Reply: Predefined responses (e.g., “I’m interested”).
  • URL: Redirects to a webpage (e.g., “Shop Now”).
  • Phone: Contact number or Company Phone number (e.f., +919xxxxxxxxx).
  • Copy Code : Use the code for any offers (e,g.,”12345axw”).
    

Overview

Utility templates on WhatsApp are specifically designed to provide functional and transactional support for existing orders or accounts. These templates are pre-approved by WhatsApp to ensure they meet compliance guidelines and are not used for promotional or marketing purposes. Below is the documentation detailing their usage, structure, and limitations.

Key Characteristics of Utility Templates

1. Purpose:
   • To provide updates related to a customer’s existing order or account.
   • Includes transactional messages such as:
     • Order confirmations.
     • Shipping updates.
     • Account notifications (e.g., password reset).
2. Restrictions:
   • Cannot be used for marketing or promotional purposes.
   • Only supports transactional and service-related use cases.
3. Compliance:
   • Must comply with WhatsApp’s Business Policy.
   • Requires prior approval in WhatsApp Business Manager.

Components of a Utility Template

Utility templates can consist of the following dynamic and static elements:

1. Header (Optional)

• Type: Text, Image, Video, or Document.
• Purpose: To highlight the primary content of the message.
• Example: Including an order invoice or a delivery tracking image.

2. Body (Required)

• Type: Text.
• Purpose: Contains the main content of the message.
• Example:
  • “Your order #12345 has been shipped. Track your delivery here: [tracking link].”
  • “Your account password was successfully changed.”

3. Footer (Optional)

• Type: Text.
• Purpose: Adds additional context, disclaimers, or legal information.
• Example: “For assistance, reply HELP or contact our support.”

4. Buttons (Optional)

• Types: Quick Reply ,URL and Phone Number.
• Purpose: To enhance interactivity by providing actionable options.
  • Quick Reply: For user responses (e.g., “Need Assistance”).
  • URL: Redirect to a webpage (e.g., “Track Your Order”).
  • Phone: Contact number or Company Phone number (e.f., +919xxxxxxxxx).

Overview

The Template Status Check API allows users to retrieve the approval status of a specific WhatsApp Business API message template. This API is useful for monitoring template approvals and ensuring that a template is available for use in messaging.

API End point

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

Replace the placeholders with:

• {phone_number_id} → Your WhatsApp Business Account phone number ID.
• {key} → Your authentication key (API key or access token).
• {template_id} → The unique ID of the template whose status is being checked.

Example Response

Success Response (Template Found)

{
    "success": true,
    "id": "353335",
    "name": "edit_al",
    "category": "marketing",
    "status": "APPROVED"
}

Explanation of Fields

success

• Type: boolean
• Value: true or false
• Description: Indicates whether the API request was successful.

id

• Type: string
• Example: "353335"
• Description: A unique identifier assigned to the template.

name

• Type: string
• Example: "edit_al"
• Description: The name of the WhatsApp template.

category

• Type: string
• Example: "marketing"
• Description: Specifies the category of the template (e.g., "marketing", "utility", "authentication").

status

• Type: string
• Values: "APPROVED", "PENDING", "REJECTED"
• Description: The current approval status of the template.

This document outlines the supported file types that can be sent as attachments in a session message. Attachments are categorized by media type: Image, Video, Audio, and Documents.

1. 📷 Image Attachments

Image files can be shared to visually communicate content such as photos, screenshots, infographics, or promotional materials.

2. 🎥 Video Attachments

Video files allow for sending motion content, tutorials, clips, and marketing videos.

3. 📄 Document Attachments

Documents can be shared to convey textual, tabular, or presentation-based information.

Pingtochat uses conventional HTTP response codes to indicate the success or failure of an API request.Below, we provide some common error codes:

API Verification Code

Template Creation Code

Default Rate Limits

Introduction to International APIs

An International API (Application Programming Interface) enables software applications to interact across borders by providing access to global services, data, or platforms. These APIs are designed to support multi-language, multi-currency, and multi-regional operations, making them essential for businesses that operate in multiple countries or serve international users.

International APIs can be found in various domains such as:

• Payments and Banking (e.g., Stripe, PayPal, Wise)
• Shipping and Logistics (e.g., FedEx, DHL, EasyPost)
• Travel and Booking (e.g., Skyscanner, Amadeus, Booking.com)
• Localization and Translation (e.g., Google Translate, Microsoft Translator)
• Social Media and Communication (e.g., WhatsApp Business API, Facebook Graph API)

These APIs help developers:

• Standardize integration with international services.
• Handle global compliance and localization.
• Enable real-time communication and data exchange across countries.

As globalization increases, international APIs play a key role in connecting businesses, services, and users worldwide.

First, you need to create an API key and token for WhatsApp configuration. To create these, click on the Pingtochat Register link to register, or the Pingtochat Login link to log in to Pingtochat. After successfully registering or logging in, you will find an option to add an API key and token on the left side of the dashboard.

To Generate Token
Navigate to: Settings ->API ->Internationak SMS Token.

Select your WABA ID and Sender ID, then choose the version. Finally, click the “Generate Token” button to create your Token

Generate the Whatsapp Sender

If you don’t have a WhatsApp sender number, click the “Register” link for Sender ID to create one. Follow the steps provided to complete the registration process. Once registered, ensure the sender number is verified and linked to your account before proceeding with token generation.

Overview

This API allows you to send international SMS messages via the Your Domain (pingtochat.com) service. It is useful for businesses looking to reach users across different countries with messages such as alerts, notifications, OTPs, or promotional content.

URL

https://{{your_domain}}/api/v1.0/{{key}}/Internationalsms

Method

POST

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Request PayloadsYour Domain (pingtochat.com)

Sending a Text Message

The payload for sending a plain text message via the WhatsApp API is structured as follows:

Example :

{
  "messaging_product": "sms",
  "to": "91 xxxxxxxxxx",
  "from": "PINGTOCHAT",
  "message": "test message",
  "templateId":6,
  "bulkId":1
}

Field description

✅ Success Response

HTTP 200 OK

{
    "status": "success",
    "messaging_product": "sms",
    "bulk_id": 1,
    "contacts": [
        {
            "phone_number": "+91xxxxxxxxxx",
            "status": "sent"
        }
    ],
    "messages": [
        {
            "transaction_id": "ABCDEFGHIJ"
        }
    ]
}

❌ Error Responses

RCS stands for Rich Communication Services. It’s a protocol designed to enhance traditional SMS (Short Message Service) and MMS (Multimedia Messaging Service) by offering a richer, more interactive messaging experience. While SMS is limited to basic text messages, RCS supports multimedia content, group chats, read receipts, typing indicators, and many other advanced features.

Overview

This API allows you to create a basic RCS template with a text type. A basic template is a simpler form of RCS message that contains text-based content only, making it ideal for simple notifications, greetings, or alerts.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_templates

URL Parameters:

• {{key}}: The account key in the URL should be replaced with your actual account key. .

HTTP Method

• POST: This method is used to send the data to create a new RCS template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

The request body should be a JSON object containing the RCS template details. Below is an example of the JSON payload for creating a new RCS template:

Example Request Payload:

{
    "name": "welcome_template",
    "type": "basic",
    "basic_types": "text",
    "components": [
    {
      "message": "welcome to PINGTOCHAT"
    }
  ]
}

Field Descriptions:

Success Response

If the template is successfully created, you will receive a 200 OK HTTP status with the details of the newly created template.

Example Response:

{
    "id": "3232",
    "status": "PENDING",
    "type": "BASIC"
}

Overview

This API allows you to create RCS templates for rich communication services. These templates can contain multiple cards, each with a title, description, media content, and buttons. The API is helpful for businesses that want to send rich, interactive messages to users via platforms that support RCS.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_templates

URL Parameters:

• {{key}}: The account key in the URL should be replaced with your actual account key. .

HTTP Method

• POST: This method is used to send the data to create a new RCS template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

The request body should be a JSON object containing the RCS template details. Below is an example of the JSON payload for creating a new RCS template:

Example Request Payload:

{
  "name": "template_name",
  "type": "advance",
  "advance_types": "single",
  "orientation": "vertical",
  "components": [
    {
      "cards": [
        {
          "title": "your_title",
          "description": "your_description",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://your_file_path"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        }
      ]
    }
  ]
}

Field Descriptions:

Success Response

If the template is created successfully, the server will return a 200 OK status with details of the created template.

Example Response:

{
    "id": "3232",
    "status": "PENDING",
    "type": "ADVANCE"
}

Overview

This API allows you to create multiple RCS templates with a slider configuration. The slider type template lets you add multiple cards to the message, where each card can contain different content such as images, text, and interactive buttons. These types of templates are ideal for promotional offers, product galleries, or multiple steps in an onboarding process.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_templates

URL Parameters:

• {{key}}: The account key in the URL should be replaced with your actual account key. .

HTTP Method

• POST: This method is used to send the data to create a new RCS template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

The request body should be a JSON object containing the RCS template details. Below is an example of the JSON payload for creating a new RCS template:

Example Request Payload:

{
  "name": "template_name",
  "type": "advance",
  "advance_types": "slider",
  "thumbnail_alignment": "left",
  "card_width": "small",
  "components": [
    {
      "cards": [
        {
          "title": "title_one",
          "description": "description_one",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://example.com/image.png"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        },
        {
          "title": "title_two",
          "description": "description_two",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://example.com/image.png"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        }
      ]
    }
  ]
}

Field Descriptions:

Success Response

If the template is successfully created, you will receive a 200 OK HTTP status, along with the details of the newly created template.

Example Response:

{
    "id": "3232",
    "status": "PENDING",
    "type": "ADVANCE"
}

Overview

This API allows you to send an RCS message to an individual recipient, using an advance card template. The message can contain a single card with media, buttons, title, and description. It’s ideal for sending rich content, such as promotional offers, product updates, or alerts, to a user’s device.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_message

• {{your_domain}}: Replace this with your actual domain (e.g., pingtochat.com).
• {{key}}: Replace this with your API key.

HTTP Method

• POST: Used to send a message using the provided template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

This is the JSON structure used to send the RCS message with a single card template:

Example Request Payload:

{
  "messaging_product": "rcs",
  "recipient_type": "individual",
  "to": "9198xxxxxxxx",
  "type": "advance",
  "template": {
    "name": "basicmessgage",
    "components": [
      {
        "cards": [
          {
            "title": "your_title",
            "description": "your_description",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://your_image_path"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          }
        ]
      }
    ]
  }
}

Field Description

Success Response

If the message is successfully sent, you will receive a 200 OK HTTP status, along with details about the sent message.

Example Response:

{
    "status": "success",
    "message": "Message send successfully",
    "transaction_id": "abvXXXXXXXXX"
}

Overview

This API allows you to send a basic RCS message to an individual recipient. In this case, no media, buttons, or advanced components are included, just a simple text message using a basic template.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_message

• {{your_domain}}: Replace this with your actual domain (e.g., pingtochat.com).
• {{key}}: Replace this with your API key.

HTTP Method

• POST: Used to send the basic message.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

This is the JSON structure used to send the basic RCS message with no advanced components:

Example Request Payload:

{
  "messaging_product": "rcs",
  "recipient_type": "individual",
  "to": "9198xxxxxxxx",
  "type": "basic",
  "template": {
    "name": "basicmessgage",
    "components": [
      {
        "message": "Hello! Welcome to P2C."
      }
    ]
  }
}

Field description

Success Response

If the message is successfully sent, you will receive a 200 OK HTTP status, along with details about the sent message.

Example Response:

{
    "status": "success",
    "message": "Message send successfully",
    "transaction_id": "abcxxxxxxxx"
}

Overview

This API allows you to create and send advanced RCS templates with carousel configuration. The carousel template enables you to display multiple cards that users can swipe through. Each card can contain different content such as images, text, and interactive buttons. This template is ideal for showcasing multiple products, offers, or steps in a process.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_message

• {{your_domain}}: Replace this with your actual domain (e.g., pingtochat.com).
• {{key}}: Replace this with your API key.

HTTP Method

• POST: Used to send the basic message.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

This is the JSON structure used to send the basic RCS message with no advanced components:

Example Request Payload:

{
  "messaging_product": "rcs",
  "recipient_type": "individual",
  "to": "9198xxxxxxxx",
  "type": "advance",
  "template": {
    "name": "basicmessage",
    "components": [
      {
        "cards": [
          {
            "title": "title_one",
            "description": "description_one",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://example.com/image.png"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          },
          {
            "title": "title_two",
            "description": "description_two",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://example.com/image.png"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          }
        ]
      }
    ]
  }
}

Field Descriptions:

Success Response

If the template is successfully created, you will receive a 200 OK HTTP status, along with the details of the newly created template.

Example Response:

{
    "status": "success",
    "message": "Message send successfully",
    "transaction_id": "abcxxxxxxxx"
}

The REST API allows developers to interact programmatically with our platform to access and manage resources such as users, messages, and configurations. It follows standard RESTful principles, ensuring a stateless, secure, and scalable design.

With the REST API, you can:

• Send messages
• Fetch , list and delete messages
• Fetch , list and delete media messages

We have three categories of messaging, which are

• Marketing
• Utility
• Authentication

We provide simple messages and template messages. Template messages also support media messages.

Authentication

To add authentication, you need to register on our platform Pingtochat and log in to your account. Then, create the API key and access token. Click here on Add Token to learn more about creating the token.

First, you need to create an API key and token for WhatsApp configuration. To create these, click on the Pingtochat Register link to register, or the Pingtochat Login link to log in to Pingtochat. After successfully registering or logging in, you will find an option to add an API key and token on the left side of the dashboard.

To Generate Token
Navigate to: Settings ->API ->Token.

Select your WABA ID and Sender ID, then choose the version. Finally, click the “Generate Token” button to create your Token

Generate the Whatsapp Sender

If you don’t have a WhatsApp sender number, click the “Register” link for Sender ID to create one. Follow the steps provided to complete the registration process. Once registered, ensure the sender number is verified and linked to your account before proceeding with token generation.

Pingtochat supports webhooks that can alert you of the following via callback URLs.

• Messages received
• Messages sent (Template & Session)
• Status of the messages sent (Sent/Delivered/read)

How to add a Webhook to Pingtochat?

• Navigate to:Settings ->API ->Webhook.

• Create an HTML URL for the webhook.
• Enter your Hub Verification Token in the designated field on the webhook form.

• When an event occurs, we will send the hub verify token along with the hub challenge to the provided URL.
• For verification, the customer must return the same hub challenge to confirm receipt.

This ensures successful integration and validation of webhook events.

Example :

<?php

$input = file_get_contents('php://input');
$hub_challenge  = json_decode($input)->hub_challenge;
$verify_token  = json_decode($input)->hub_verify_token;
$expected_token = '123';

if ($verify_token === $expected_token) {
   
    http_response_code(200);
    echo $hub_challenge;
    exit;
}

http_response_code(400);
echo json_encode(["message" => "Bad request!"]);
?>

A session message in WhatsApp refers to any message exchanged between a business and a customer within a 24-hour messaging window that starts when the customer sends a message to the business. These messages are not pre-approved by WhatsApp and can include free-form text, media, or interactive content.

URL

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

Method

POST

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Request Payloads

Sending a Text Message

The payload for sending a plain text message via the WhatsApp API is structured as follows:

Example :

{
  "messaging_product": "whatsapp",
  "to": "91xxxxxxxxxx",
  "type": "text",
  "text": {
    "body": "Hello!"
  }
}

Field Descriptions

• messaging_product: (string) Specifies the messaging product. For WhatsApp, this is always whatsapp.
• to: (string) The recipient’s phone number in E.164 format. Example: 919880132082.
• type: (string) The type of message being sent. Use text for plain text messages.
• text: (object) Contains the message text.
  • body: (string) The text message content. Example: "Hello!".

Response

Example Success Response

A successful request returns a 200 OK status and a response payload similar to the following:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx"
    }
  ],
  "messages": [
    {
      "id": "RfzuNs4qpN"
    }
  ]
}

Field Descriptions

• messaging_product: (string) The messaging product used. Always whatsapp.
• contacts: (array) Contains information about the recipient.
  • input: (string) The phone number you provided in the request.
  • wa_id: (string) The WhatsApp ID associated with the provided phone number.
• messages: (array) Contains information about the sent message.
  • id: (string) The unique identifier for the sent message.

Notes

1. Domain and Credentials: Replace {{your_domain}}, {{phone_number_id}}, and {{key}} with your API domain, phone number ID, and API key respectively.
2. Rate Limits: Ensure your API calls comply with the rate limits set by WhatsApp to avoid being throttled.
3. Session Window: Text messages can only be sent within a 24-hour window of the last user interaction.
4. Template Pre-Approval: For template messages, ensure they are approved in the WhatsApp Business Manager before use.
5. Language Code Matching: Language codes in templates must match the approved template language.

Sample codes

In PinToChat, we provide three distinct categories of messages, each with its own supported types and functionalities

Categories:

1. Authentication:
   • Supports only the Body component for message templates.
   • Primarily used for identity verification and authentication purposes, such as sending OTPs or login confirmations.
2. Marketing:
   • Supports all types of messaging, including text and media.
   • Ideal for promotional campaigns and engaging with users through rich media content.
3. Utility:
   • Supports all types of messaging, including text and media.
   • Designed for sending notifications, alerts, and other informative content.

Message Types:

Messages are available in two main types:

1. Text:
   • Simple text-based messages for quick and clear communication.
2. Media:
   • Includes rich content for enhanced engagement, categorized into:
     • Image: Sending photos or images.
     • Video: Sharing video clips.
     • Document: Sending files like PDFs, Word documents, or spreadsheets

Message Types:

Messages are available in two main types:

1. Text:
   • Simple text-based messages for quick and clear communication.
2. Media:
   • Includes rich content for enhanced engagement, categorized into:
     • Image: Sending photos or images.
     • Video: Sharing video clips.
     • Document: Sending files like PDFs, Word documents, or spreadsheets.

Button Types:

Interactive buttons can be added to messages for better user engagement. The available button types are:

• Quick Reply Button:
  • Enables users to respond quickly with predefined options.
• Visit Website Button:
  • Directs users to a specific webpage.
• URL Button:
  • Opens a designated URL in the browser.
• Phone Number Button:
  • Allows users to call a predefined phone number directly.
• WhatsApp Number Button (Call on WhatsApp):
  • Initiates a call directly on WhatsApp to a given contact.
• Copy Offer Code Button:
  • Provides an option to copy a promo or offer code to the clipboard.

Authentication templates are specialized message formats used by businesses to verify user identities through one-time passcodes (OTPs) delivered via messaging platforms like WhatsApp. These templates ensure secure and efficient user authentication during processes such as account verification, recovery, and integrity challenges.

Key Features of Authentication Templates:

• Preset Message Content: The templates include fixed text, such as “<VERIFICATION_CODE> is your verification code,” along with optional security disclaimers and expiration warnings.
• Interactive Buttons: They feature buttons like “COPY_CODE,” which allows users to copy the OTP to their clipboard, and “ONE_TAP,” enabling automatic code autofill within the app. ​

Zero-Tap Authentication Templates

Zero-tap authentication templates allow your users to receive one-time passwords or codes via WhatsApp without having to leave your app.’

One-Tap Autofill Authentication Templates

One-tap autofill authentication templates allow you to send a one-time password or code along with an one-tap autofill button to your users. When a WhatsApp user taps the autofill button, the WhatsApp client triggers an activity which opens your app and delivers it the password or code.

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.

This API enables you to send WhatsApp authentication template messages using the provided template configuration. The messages are sent to individual recipients using a specific template ID, phone number ID, and API key.

Request Format

HTTP Method

• POST

API Version

• V1.0

Request URL

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

Replace placeholders:

• {{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 Body

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "bulk_id":"12345",
  "type": "template",
  "template": {
    "name": "authentication_template",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "958625"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "url",
        "index": "0",
        "parameters": [
          {
            "type": "text",
            "text": "958625"
          }
        ]
      }
    ]
  }
}

Response

Success Response

HTTP Status Code: 200 OK

Sample Response:

{
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "91xxxxxxxxxx",
            "wa_id": "91xxxxxxxxxx",
            "status_id": "ODIxMTE="
        }
    ],
    "messages": [
        {
            "id": "RFPQoMGZWt",
            "message_status": "accepted"
        }
    ]
}

Message Sample View

958625 is your verification code. For your security, do not share this code.

Field Descriptions

Root-Level Fields

Template-Level Fields

Notes

1. Ensure the template name matches an approved template in your WhatsApp Business Account.
2. The phone number must be in E.164 format (e.g., 91xxxxxxxxxx for Indian numbers).
3. Language codes must follow ISO 639-1 standards.

Sample codes

Overview

Marketing templates on WhatsApp are designed to send promotional messages, share information about products or services, or communicate business-related updates. These templates are pre-approved by WhatsApp and must comply with the platform’s policies to ensure they provide value to users without being spammy or intrusive. Below is the detailed documentation on marketing templates, their structure, and best practices.

Key Characteristics of Marketing Templates

1. Purpose:
   • To promote products, services, or offers.
   • To share informational updates about the business.
   • To engage users with campaigns, announcements, or events.
2. Use Cases:
   • Sending special offers or discounts.
   • Announcing a new product or service.
   • Inviting users to events or webinars.
   • Sharing business updates, such as holiday hours or relocations.
3. Compliance:
   • Must adhere to WhatsApp’s Business Policy.
   • Requires explicit user opt-in for promotional content.

Components of a Marketing Template

Marketing templates can consist of the following elements:

1. Header (Optional)

• Type: Text, Image, Video, or Document.
• Purpose: To grab attention with a visually appealing or textual header.
• Example: Including a product image or a “Special Offer” banner.

2. Body (Required)

• Type: Text.
• Purpose: Contains the primary message content, such as promotional text or product details.
• Example:
  • “Get 20% off on your next purchase! Use code SAVE20. Offer valid till Jan 31, 2025.”
  • “Introducing our latest collection! Check it out now and enjoy exclusive discounts.”

3. Footer (Optional)

• Type: Text.
• Purpose: Provides additional context, disclaimers, or contact information.
• Example: “Terms and conditions apply. Visit our website for more details.”

4. Buttons (Optional)

• Types: Quick Reply , URL ,Phone Number and Copy Code
• Purpose: To encourage user interaction and provide actionable options.
  • Quick Reply: Predefined responses (e.g., “I’m interested”).
  • URL: Redirects to a webpage (e.g., “Shop Now”).
  • Phone: Contact number or Company Phone number (e.f., +919xxxxxxxxx).
  • Copy Code : Use the code for any offers (e,g.,”12345axw”).
    

Description:

Send a basic template message without any parameters.

Endpoint:

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

Replace the placeholders:

• {{your_domain}}: Your API domain.
• {{phone_number_id}}: The ID linked to your WhatsApp Business API number.
• {{key}}: Your API key for authentication.How to create key

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example :

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_newyear",
    "language": {
      "code": "en"
    },
    "components": [
    ]
  }
}

Field Descriptions:

1. messaging_product: Always "whatsapp" for WhatsApp messaging.
2. recipient_type: "individual" for single-user messages.
3. to: Recipient’s phone number in E.164 format (e.g., 91xxxxxxxxxx for an Indian number).
4. type: "template" for template messages.
5. template: Contains details about the template:
   • name: Name of the pre-approved template (marketing_newyear in this case).
   • language: Specifies the language code.
     • code: Language code for the template (e.g., en for English).
   • components: An array for dynamic content or interactive elements (leave empty for simple messages).

Example Response

When the API processes the request successfully, it returns a response similar to this:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MDM="
    }
  ],
  "messages": [
    {
      "id": "8AVoq6uUPP",
      "message_status": "accepted"
    }
  ]
}

Response Details:

• contacts:
  • input: The phone number you provided in the to field.
  • wa_id: WhatsApp ID of the recipient.
  • status_id: A unique identifier for the status of this contact.
• messages:
  • id: A unique ID for the message.
  • message_status: Status of the message (e.g., "accepted").

Sample View:

Hi welcome to 2025

Sample codes

Description:

Send a template message that includes dynamic text parameters.

Endpoint:

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

Replace the placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your API domain.

{{phone_number_id}}: The ID linked to your WhatsApp Business API number.

Example Payload:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_newyear_va",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "user_name"
          },
          {
            "type": "text",
            "text": "Features"
          }
        ]
      }
    ]
  }
}

Field Breakdown:

1. messaging_product: Specifies the messaging product, always "whatsapp".
2. recipient_type: "individual" for single-user messages.
3. to: The recipient’s phone number in E.164 format (e.g., 91xxxxxxxxxx).
4. type: "template" for sending a template message.
5. template:
   • name: The name of the pre-approved template (marketing_newyear_va in this case).
   • language:
     • code: The language code of the template (e.g., en for English).
   • components:
     • type: Specifies the part of the template being populated. Use "body" for main content placeholders.
     • parameters: Contains dynamic data to replace placeholders in the template:
       • type: The type of data (e.g., "text").
       • text: The value that replaces the placeholder in the template.

Dynamic Parameters and Placeholders

Templates can include dynamic placeholders represented as variables like {{1}}, {{2}}, etc. Each placeholder is replaced by the corresponding value in the parameters array.

Template Example:

Template name: marketing_newyear_va
Template content:

Hi {{1}}, welcome to our platform! Check out these amazing {{2}}.

Example:

"parameters": [
  {
    "type": "text",
    "text": "user_name"  // Replaces {{1}}
  },
  {
    "type": "text",
    "text": "Features"  // Replaces {{2}}
  }
]

Resulting message:

Hi user_name, welcome to our platform! Check out these amazing Features.

Response Structure

A successful API call returns a 200 OK response with details about the sent message.

Example Response:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTI="
    }
  ],
  "messages": [
    {
      "id": "phoSwcGtbL",
      "message_status": "accepted"
    }
  ]
}

Response Details:

• contacts:
  • input: The phone number from the to field.
  • wa_id: WhatsApp ID of the recipient.
  • status_id: Identifier for the delivery status.
• messages:
  • id: A unique identifier for the message.
  • message_status: Status of the message, e.g., "accepted".

Notes and Best Practices

1. Pre-approved Templates:
   • Templates must be created and approved in the WhatsApp Business Manager.
   • Ensure placeholders ({{1}}, {{2}}, etc.) align with the payload.
2. Dynamic Content:
   • Use the parameters array to customize messages.
   • Include text, media, or buttons as required by your template.
3. Language Codes:
   • Match the language code with the template’s approved language.
   • Full list of ISO 639-1 codes.
4. Testing:
   • Use a sandbox environment to test integrations.
   • Validate payloads and monitor logs for issues.

Sample codes

Description:

Send a template message with dynamic text parameters and an image attachment in the header.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Example:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_template_doc",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": 
                      "https://chat.pingtochat.com/template_media/1736424548.png"
            }
          }
        ]
      }
    ]
  }
}

Field Descriptions

General Fields

• messaging_product: (string) Always whatsapp.
• recipient_type: (string) Set to individual for one-to-one messages.
• to: (string) The recipient’s phone number in E.164 format (e.g., 91xxxxxxxxxx).
• type: (string) Always template.

Template Object

• name: (string) The name of the pre-approved template (e.g., marketing_newyear_va_images).
• language: (object) Specifies the language for the template.
  • code: (string) The language code (e.g., en for English).

Components Array

1. Header:
   • type: (string) Always header for attachments.
   • parameters: (array) Holds the media or placeholders for the header.
     • type: (string) Always image for images.
     • image: (object) Contains the image details.
       • link: (string) URL of the image (e.g., https://chat.pingtochat.com/template_media/1736424548.png).

Response

A successful request will return an HTTP status code of 200 OK along with the following response structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Field Descriptions

1. messaging_product:
   • Type: String
   • Description: Indicates the messaging platform. Always returns whatsapp for messages sent via the WhatsApp Business API.
2. contacts:
   • Type: Array
   • Description: Contains information about the message recipient(s).
   • Fields:
     • input:
       • Type: String
       • Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx).
     • wa_id:
       • Type: String
       • Description: The WhatsApp ID associated with the input phone number.
     • status_id:
       • Type: String
       • Description: A unique identifier for the status of the message.
3. messages:
   • Type: Array
   • Description: Contains details about the seMessages Without Buttonsnt message.
   • Fields:
     • id:
       • Type: String
       • Description: A unique identifier for the message sent (e.g., M2s4da2y4P).
     • message_status:
       • Type: String
       • Description: The status of the message at the time of the response. Example values include:
         • accepted: The message was successfully accepted by the system.

Sample codes

Description:

Send a template message with dynamic text parameters and an image attachment in the header.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Example:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_newyear_va_images",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "User_Name"
          },
          {
            "type": "text",
            "text": "Features"
          }
        ]
      },
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": "https://chat.pingtochat.com/template_media/1736424548.png"
            }
          }
        ]
      }
    ]
  }
}

Field Descriptions

General Fields

• messaging_product: (string) Always whatsapp.
• recipient_type: (string) Set to individual for one-to-one messages.
• to: (string) The recipient’s phone number in E.164 format (e.g., 91xxxxxxxxxx).
• type: (string) Always template.

Template Object

• name: (string) The name of the pre-approved template (e.g., marketing_newyear_va_images).
• language: (object) Specifies the language for the template.
  • code: (string) The language code (e.g., en for English).

Components Array

1. Header:
   • type: (string) Always header for attachments.
   • parameters: (array) Holds the media or placeholders for the header.
     • type: (string) Always image for images.
     • image: (object) Contains the image details.
       • link: (string) URL of the image (e.g., https://chat.pingtochat.com/template_media/1736424548.png).
2. Body:
   • type: (string) Always body for the main text content.
   • parameters: (array) Holds the placeholders to populate the template.
     • type: (string) Always text.
     • text: (string) The value to replace placeholders (e.g., "User_Name", "Features").

Response

A successful request will return an HTTP status code of 200 OK along with the following response structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Field Descriptions

1. messaging_product:
   • Type: String
   • Description: Indicates the messaging platform. Always returns whatsapp for messages sent via the WhatsApp Business API.
2. contacts:
   • Type: Array
   • Description: Contains information about the message recipient(s).
   • Fields:
     • input:
       • Type: String
       • Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx).
     • wa_id:
       • Type: String
       • Description: The WhatsApp ID associated with the input phone number.
     • status_id:
       • Type: String
       • Description: A unique identifier for the status of the message.
3. messages:
   • Type: Array
   • Description: Contains details about the seMessages Without Buttonsnt message.
   • Fields:
     • id:
       • Type: String
       • Description: A unique identifier for the message sent (e.g., M2s4da2y4P).
     • message_status:
       • Type: String
       • Description: The status of the message at the time of the response. Example values include:
         • accepted: The message was successfully accepted by the system.

Sample codes

Description:

Send a template message with dynamic text parameters and an image attachment in the header.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Example:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_buttons",
    "language": {
      "code": "en"
    },
    "components": [
        {
        "type":"BUTTONS",
        "buttons": [
            {
            "type": "QUICK_REPLY",
            "text": "Unsubscribe from Promos"
            },
        
            {
            "type": "url",
            "text": "Go to link",
            "url": "https://developers.pingtochat.com/"
        
            }
        
        
        ]
        }
    ]
  }
}

Field Descriptions

1. messaging_product
   • Description: Indicates the messaging product being used.
   • Value: "whatsapp" (since this message is for WhatsApp).
2. recipient_type
   • Description: Specifies the type of recipient.
   • Value: "individual" (indicates the message is intended for an individual user).
3. to
   • Description: The recipient’s WhatsApp phone number in international format.
   • Value: "91xxxxxxxxxx" (replace xxxxxxxxxx with the actual phone number).
4. type
   • Description: Specifies the type of message being sent.
   • Value: "template" (indicates this is a template message).
5. template
   • Description: The main object containing template message details.
   • Fields:
     • name:
       • Description: The name of the message template.
       • Value: "marketing_buttons" (name of the pre-approved template on WhatsApp).
     • language:
       • code:
         • Description: The language code for the message.
         • Value: "en" (English).
     • components:
       • Description: An array of objects specifying dynamic content for the template.
6. components
   • Description: Holds the dynamic elements of the template.
   • Fields:
     • type:
       • Description: The type of dynamic element in the template.
       • Value: "BUTTONS" (indicates buttons will be included in the message).
     • buttons:
       • Description: An array of button objects within the template.
7. buttons
   • Description: Defines individual buttons within the template.
   • Fields:
     1. type:
        • Description: The type of button.
        • Value:
          • "QUICK_REPLY": A button that sends a predefined reply when clicked.
          • "url": A button that redirects the user to a specified URL.
     2. text:
        • Description: The text displayed on the button.
        • Value:
          • "Unsubscribe from Promos": Text for the quick reply button.
          • "Go to link": Text for the URL button.
     3. url (for url buttons only):
        • Description: The URL the button redirects to.
        • Value: "https://developers.pingtochat.com/".

Response

A successful request will return an HTTP status code of 200 OK along with the following response structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Field Descriptions

1. messaging_product:
   • Type: String
   • Description: Indicates the messaging platform. Always returns whatsapp for messages sent via the WhatsApp Business API.
2. contacts:
   • Type: Array
   • Description: Contains information about the message recipient(s).
   • Fields:
     • input:
       • Type: String
       • Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx).
     • wa_id:
       • Type: String
       • Description: The WhatsApp ID associated with the input phone number.
     • status_id:
       • Type: String
       • Description: A unique identifier for the status of the message.
3. messages:
   • Type: Array
   • Description: Contains details about the seMessages Without Buttonsnt message.
   • Fields:
     • id:
       • Type: String
       • Description: A unique identifier for the message sent (e.g., M2s4da2y4P).
     • message_status:
       • Type: String
       • Description: The status of the message at the time of the response. Example values include:
         • accepted: The message was successfully accepted by the system.

Sample codes

Description:

Send a basic template message with any parameters.

Endpoint:

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

Replace the placeholders:

• {{your_domain}}: Your API domain.
• {{phone_number_id}}: The ID linked to your WhatsApp Business API number.
• {{key}}: Your API key for authentication.How to create key

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example :

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_newyear_va_images",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "User_Name"
          },
          {
            "type": "text",
            "text": "Features"
          }
        ]
      },
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": "https://chat.pingtochat.com/template_media/1736424548.png"
            }
          }
        ]
      },
       {
        "type": "FOOTER",
        "text": "Use the buttons below to visit our website"
        },
        {
        "type":"BUTTONS",
        "buttons": [
                {
                "type": "QUICK_REPLY",
                "text": "Unsubscribe from Promos"
                },
                {
                "type": "url",
                "text": "Go to link",
                "url": "https://developers.pingtochat.com/"
                }
               
            ]
        }
    ]
  }
}

Key Points in the Payload

1. Components:
   • header: Includes an image URL.
   • body: Contains text with placeholders replaced by dynamic values.
   • footer: Simple static text.
   • buttons: Supports two types of buttons:
     • QUICK_REPLY: For quick interactions.
     • URL: Redirects to a specific URL.
2. Parameters:
   • The parameters inside header and body match the placeholders defined in the template.
3. URL Requirements:
   • The URL in the buttons section must be publicly accessible.
4. Template Approval:
   • Templates (e.g., marketing_newyear_va_images) must be pre-approved.

Response

A successful request will return an HTTP status code of 200 OK along with the following response structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Field Descriptions

1. messaging_product:
   • Type: String
   • Description: Indicates the messaging platform. Always returns whatsapp for messages sent via the WhatsApp Business API.
2. contacts:
   • Type: Array
   • Description: Contains information about the message recipient(s).
   • Fields:
     • input:
       • Type: String
       • Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx).
     • wa_id:
       • Type: String
       • Description: The WhatsApp ID associated with the input phone number.
     • status_id:
       • Type: String
       • Description: A unique identifier for the status of the message.
3. messages:
   • Type: Array
   • Description: Contains details about the seMessages Without Buttonsnt message.
   • Fields:
     • id:
       • Type: String
       • Description: A unique identifier for the message sent (e.g., M2s4da2y4P).
     • message_status:
       • Type: String
       • Description: The status of the message at the time of the response. Example values include:
         • accepted: The message was successfully accepted by the system.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number, Copy Code)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_all_buttons",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Hi user"
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Our"
                    },
                    {
                        "type": "text",
                        "text": "whatsapp message app"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            },
             {
                "type": "button",
                "sub_type": "copy_code", 
                "index": 1,
                "parameters": [
                    {
                        "type": "text",
                        "text": "WRETTT" 
                    }
                ]
            }
        ]
    }
}

Key Points in the Payload

Components:

• Header: Includes an image URL.
• Body: Contains text with placeholders replaced by dynamic values.
• Footer: Simple static text.
• Buttons: Supports two types of buttons:
  • QUICK_REPLY: For quick interactions.
  • URL: Redirects to a specific URL.

Parameters:

• The parameters inside the header and body match the placeholders defined in the template.

URL Requirements:

• The URL in the buttons section must be publicly accessible.

Template Approval:

• Templates (e.g., marketing_all_buutons) must be pre-approved.

Response Structure

A successful request will return an HTTP status code of 200 OK along with the following response structure:

{
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "91xxxxxxxxxx",
            "wa_id": "91xxxxxxxxxx",
            "status_id": "MTA0NDI3"
        }
    ],
    "messages": [
        {
            "id": "kfGlB7LpVI",
            "message_status": "accepted"
        }
    ]
}

Field Descriptions

messaging_product:

• Type: String
• Description: Indicates the messaging platform. Always returns "whatsapp" for messages sent via the WhatsApp Business API.

contacts:

• Type: Array
• Description: Contains information about the message recipient(s).

Fields:

• input:
  • Type: String
  • Description: The phone number input used in the API request (e.g., 91xxxxxxxxxx).
• wa_id:
  • Type: String
  • Description: The WhatsApp ID associated with the input phone number.
• status_id:
  • Type: String
  • Description: A unique identifier for the status of the message.

messages:

• Type: Array
• Description: Contains details about the sent message.

Fields:

• id:
  • Type: String
  • Description: A unique identifier for the message sent (e.g., "M2s4da2y4P").
• message_status:
  • Type: String
  • Description: The status of the message at the time of the response. Example values include:
    • “accepted” – The message was successfully accepted by the system.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_h",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_h".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

1. Button Component

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the type of button.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxx",
      "wa_id": "91xxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply)

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_p",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_p".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number, Copy Code)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_o",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "copy_code", 
                "index": 1,
                "parameters": [
                    {
                        "type": "text",
                        "text": "WRETTT" 
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_o".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Copy Code Button

• Type: button
• Description: Adds an interactive Copy Code button.

sub_type

• Value: "copy_code"
• Description: Defines the button as a Copy Code button.
  • "copy_code": Allows users to copy a predefined code.

index

• Type: Integer
• Description: Position of the button in the template.
  • "1": The second button.

parameters

• Type: `Array**
• Description: Defines the copy code text.
  • text: "WRETTT" (example code that users can copy).

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL)

For URL buttons, they do not need to be included in the example payload request.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_i",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_i".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

1. Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxxx",
      "wa_id": "91xxxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL)

For URL buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_q",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_q".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: `Array**
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: `Array**
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number)

For URL and Phone Number buttons, they do not need to be included in the Example code.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_r",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_r".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: `Array**
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: `Array**
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_j",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_j".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: `Array**
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: `Array**
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number, Copy Code)

For URL and Phone Number buttons, they do not need to be included in the Example payload.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_s",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply", 
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "copy_code", 
                "index": 1,
                "parameters": [
                    {
                        "type": "text",
                        "text": "WRETTT" 
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_s".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: `Array**
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Copy Code Button

• Type: button
• Description: Adds a Copy Code button.

sub_type

• Value: "copy_code"
• Description: Defines the button as a Copy Code button.
  • "copy_code": Allows users to copy a predefined code.

index

• Type: Integer
• Description: Position of the button in the template.
  • "1": The second button.

parameters

• Type: `Array**
• Description: Defines the text associated with the Copy Code button.
  • text: "WRETTT"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: `Array**
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number, Copy Code)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_k",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "copy_code",
                "index": 1,
                "parameters": [
                    {
                        "type": "text",
                        "text": "WRETTT"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_k".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

1. Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

2. Copy Code Button

• Type: button
• Description: Adds a Copy Code button, which allows users to copy a given promo code.

sub_type

• Value: "copy_code"
• Description: Allows users to copy a promo code for future use.

index

• Type: Integer
• Description: Position of the button in the template.
  • "1": The second button.

parameters

• Type: Array
• Description: Contains the promo code to be copied.
  • text: "WRETTT"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

Overview

• A header that dynamically personalizes the message with text.
• A body that provides additional message content with placeholders for dynamic text.

This template is used for sending marketing-related messages to users.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_t",
    "language": {
      "code": "en_us"
    },
    "components": [
        {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "text": "Hi user"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Our"
          },
          {
            "type": "text",
            "text": "whatsapp message app"
          }
        ]
      }
    ]
  }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_t".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Header

• Type: header
• Description: The header section of the template message.
• parameters:
  • type: "text" – Specifies that the header contains text.
  • text: "Hi user" – The actual content of the header.

Body

• Type: body
• Description: The main content of the template message.
• parameters:
  • type: "text"
  • text: "Our" – First part of the message.
  • text: "whatsapp message app" – Second part of the message.

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "91xxxxxxxxxx",
            "wa_id": "91xxxxxxxxxx",
            "status_id": "MTA0NDQ5"
        }
    ],
    "messages": [
        {
            "id": "KrNLbzOCZb",
            "message_status": "accepted"
        }
    ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_l",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_l".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

Overview

• A header that dynamically personalizes the message with text.
• A body that provides additional message content with placeholders for dynamic text.

The footer example payload does not need to be included in the example payload, as it is already in the template; it will function correctly on its own.

This template is used for sending marketing-related messages.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "template",
  "template": {
    "name": "marketing_u",
    "language": {
      "code": "en_us"
    },
    "components": [
        {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "text": "Hi user"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Our"
          },
          {
            "type": "text",
            "text": "whatsapp message app"
          }
        ]
      }
    ]
  }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_u".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Header

• Type: header
• Description: The header section of the template message.
• parameters:
  • type: "text" – Specifies that the header contains text.
  • text: "Hi user" – The actual content of the header.

Body

• Type: body
• Description: The main content of the template message.
• parameters:
  • type: "text"
  • text: "Our" – First part of the message.
  • text: "whatsapp message app" – Second part of the message.

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

Overview

• A header that dynamically personalizes the message with text.
• A body that provides additional message content with placeholders for dynamic text.
• A Quick Reply Button that allows users to opt out of promotional messages.

The footer example payload does not need to be included in the example payload, as it is already in the template; it will function correctly on its own.

This template is used for sending marketing-related messages with an easy opt-out option.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_v",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Hi user"
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Our"
                    },
                    {
                        "type": "text",
                        "text": "whatsapp message app"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_v".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Header

• Type: header
• Description: The header section of the template message.
• parameters:
  • type: "text" – Specifies that the header contains text.
  • text: "Hi user" – The actual content of the header.

Body

• Type: body
• Description: The main content of the template message.
• parameters:
  • type: "text"
  • text: "Our" – First part of the message.
  • text: "whatsapp message app" – Second part of the message.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.
• sub_type: "quick_reply"
• index: 0 (First button in the list)
• parameters:
  • type: "text"
  • text: "Unsubscribe from Promos" – The text displayed on the button.

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: Array
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL)

For URL buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_m",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_m".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

PingtoChat’s Marketing Category enables businesses to send pre-approved WhatsApp template messages through the WhatsApp Business API. The supported message types include:

1. Messages Without Parameters
2. Messages With Parameters
3. Messages With Parameters and Attachments
4. Messages With Buttons (Quick Reply, URL, Phone Number, Copy Code)

For URL and Phone Number buttons, they do not need to be included in the response.

Description:

A basic template message without dynamic parameters.

Endpoint:

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

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxx",
    "type": "template",
    "template": {
        "name": "markting_n",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "markting_n".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.

sub_type

• Value: "quick_reply"
• Description: Defines the button as a Quick Reply.
  • "quick_reply": Provides a predefined response option.

index

• Type: Integer
• Description: Position of the button in the template.
  • "0": The first button.

parameters

• Type: Array
• Description: Defines the button text.
  • text: "Unsubscribe from Promos"

Response

If the request is successful, the API returns a 200 OK response with the following JSON structure:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "91xxxxxxxxxx",
      "wa_id": "91xxxxxxxxxx",
      "status_id": "NTg0MTc="
    }
  ],
  "messages": [
    {
      "id": "M2s4da2y4P",
      "message_status": "accepted"
    }
  ]
}

Response Field Descriptions

messaging_product

• Type: String
• Description: Always returns "whatsapp".

contacts

• Type: Array
• Description: Contains recipient details.

Fields within contacts:

• input: The phone number used in the API request.
• wa_id: WhatsApp ID linked to the phone number.
• status_id: A unique identifier for message status.

messages

• Type: `Array**
• Description: Contains details about the sent message.

Fields within messages:

• id: A unique message identifier.
• message_status: Indicates the message processing status.
  • "accepted": The message was successfully processed.

Sample codes

Overview

• A header with dynamic text personalization.
• A body containing the main message text with placeholders for dynamic content.
• A Quick Reply Button that enables users to opt out of promotional messages.

The footer example payload does not need to be included in the example payload, as it is already in the template; it will function correctly on its own.

This template is suitable for sending marketing messages while providing an easy opt-out option.

Endpoint:

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

Replace placeholders:

{{key}}: Your API key for authentication.How to create key

{{your_domain}}: Your domain URL where the API is hosted.

{{phone_number_id}}: The unique identifier of the phone number used for sending messages.

Method:

POST

Headers:

• Content-Type: application/json
• Authorization: Bearer <your_access_token>

Example Payload:

{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "91xxxxxxxxxx",
    "type": "template",
    "template": {
        "name": "marketing_x",
        "language": {
            "code": "en_us"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Hi user"
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Our"
                    },
                    {
                        "type": "text",
                        "text": "whatsapp message app"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "text",
                        "text": "Unsubscribe from Promos"
                    }
                ]
            }
        ]
    }
}

Key Components in the Payload

messaging_product

• Type: String
• Description: Specifies the messaging platform. Always set to "whatsapp".

recipient_type

• Type: String
• Description: Defines the recipient type. Use "individual" for one-on-one messaging.

to

• Type: String
• Description: The recipient’s WhatsApp number in international format (e.g., "91xxxxxxxxxx").

type

• Type: String
• Description: Defines the type of message. Always set to "template".

template.name

• Type: String
• Description: Specifies the pre-approved WhatsApp template name. In this case, it is "marketing_x".

template.language.code

• Type: String
• Description: Language code for the template. Must match the approved template settings.
• Example: "en_us" for English (United States).

components

• Type: Array
• Description: Defines the interactive elements in the template.

Header

• Type: header
• Description: The header section of the template message.
• parameters:
  • type: "text" – Specifies that the header contains text.
  • text: "Hi user" – The actual content of the header.

Body

• Type: body
• Description: The main content of the template message.
• parameters:
  • type: "text"
  • text: "Our" – First part of the message.
  • text: "whatsapp message app" – Second part of the message.

Quick Reply Button

• Type: button
• Description: Adds an interactive Quick Reply button.
• sub_type: "quick_reply"
• index: 0 (First button in the list)
• parameters:
  • type: "text"
  • text: "Unsubscribe from Promos" – The text displayed on the button.