Pingtochat Docs

Pingtochat Docs

Did You Know?

Advanced visual search system powered by Ajax

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

Message without parameters and with buttons

Estimated reading: 4 minutes 75 views

Description:

Send a template message without dynamic text parameters attachment with buttons message .

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": "utility_button",
    "language": {
      "code": "en"
    },
    "components": [
        {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe from Promos"
        },
       
        {
          "type": "url",
          "text": "Go to link",
          "url": "https://chat.pingtochat.com/"
       
        }
      ]
    } 
    ]
  }
}

Field Descriptions

  1. messaging_product
    • Description: Indicates the messaging platform being used.
    • Value: "whatsapp" (signifies this is a WhatsApp message).
  2. recipient_type
    • Description: Defines the type of recipient.
    • Value: "individual" (the message is sent to an individual user).
  3. to
    • Description: The recipient’s phone number in international format.
    • Value: "91xxxxxxxxxx" (replace with the intended recipient’s phone number).
  4. type
    • Description: Specifies the type of message being sent.
    • Value: "template" (indicates this is a pre-approved template message).
  5. template
    • Description: The container for the template message configuration.

Fields within template

  1. name
    • Description: The unique name of the pre-approved template on WhatsApp.
    • Value: "utility_button".
  2. language
    • Description: Specifies the language in which the template message is sent.
    • Fields:
      • code:
        • Description: The language code for the message.
        • Value: "en" (English).
  3. components
    • Description: Contains the dynamic parts of the template, such as text variables or buttons.

Fields within components

  1. type
    • Description: The type of dynamic component being used.
    • Value: "BUTTONS" (indicates that this template contains buttons).
  2. buttons
    • Description: An array of button configurations for the message.

Fields within buttons

Each button object in the buttons array has the following fields:

  1. For Button 1: Quick Reply
    • type:
      • Description: The type of button.
      • Value: "QUICK_REPLY" (a button that sends a predefined reply when clicked).
    • text:
      • Description: The text displayed on the button.
      • Value: "Unsubscribe from Promos".
  2. For Button 2: URL
    • type:
      • Description: The type of button.
      • Value: "url" (a button that redirects to an external link when clicked).
    • text:
      • Description: The text displayed on the button.
      • Value: "Go to link".
    • url:
      • Description: The URL the button opens when clicked.
      • Value: "https://chat.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 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

Leave a Comment

Share this Doc

Message without parameters and with buttons

Or copy link

CONTENTS