Pingtochat Docs

Pingtochat Docs

Did You Know?

We design Docy for the readers, optimizing not for page views or engagement

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

No parameter with header , body , footer and buttons – quick replay

Estimated reading: 3 minutes 127 views

Request URL

POST 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.

Headers

  • Content-Type: Specifies that the request body is in JSON format.
  • Authorization: A Bearer token is required for authentication.

Example Payload

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

6. 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 "utility_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.

Button Component

  • Type: button
  • Description: This component allows interactive Quick Replies.
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

{
  "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

Leave a Comment

Share this Doc

No parameter with header , body , footer and buttons – quick replay

Or copy link

CONTENTS