Pingtochat Docs

Pingtochat Docs

Did You Know?

Docy turns out that context is a key part of learning.

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

Parameter with body , button – quick-replay, visit-website

Estimated reading: 2 minutes 64 views

This document provides detailed information about the Marketing Templates used for marketing purposes. These templates allow businesses to send customizable messages to users with dynamic placeholders, enabling personalized communication.

Endpoint

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

Request Headers

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

Template Information

  • Name: marketing_ad
  • Language: en_US (English – United States)
  • Category: MARKETING
  • Allow Category Change: Yes

Components

The marketing_ad template consists of a Body and a Buttons component.

Body:

  • Type: BODY
  • Text: "We are introducing {{1}} new product about {{2}}"
  • Example: "We are introducing our new product about WhatsApp message app"
  • Purpose: Used for marketing campaigns to introduce new products or services dynamically.

Buttons:

  • Type: BUTTONS
  • Buttons:
    • Type: QUICK_REPLY
    • Text: "Unsubscribe from Promos"
    • Purpose: Allows users to opt out of future marketing messages.
    • Type: URL
    • Text: "Go to link"
    • URL: https://app.pingtochat.com/
    • Purpose: Redirects the recipient to an external site for more details or purchase options.

Example Message Generation:

"We are introducing our new product about WhatsApp message app"

Buttons:

  • "Unsubscribe from Promos"
  • "Go to link" (URL: https://app.pingtochat.com/)

Sample Request

{
  "name": "marketing_ad",
  "language": "en_US",
  "category": "MARKETING",
  "allow_category_change": true,
  "components": [
        {
        "type": "BODY",
        "text": "We are intraducing  {{1}} new product about {{2}}",
        "example": {
            "body_text": [
            [
                "our","whatsapp message app"
            ]
            ]
        }
        },
        {
        "type":"BUTTONS",
        "buttons": [
                {
                "type": "QUICK_REPLY",
                "text": "Unsubscribe from Promos"
                },
                {
                "type": "url",
                "text": "Go to link",
                "url": "https://app.pingtochat.com/"
                }
            ]
        }
    ]
}

Success Response

Status Code: 201 APPROVED

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

Notes:

  • This is a Marketing Template, meaning it is designed to promote and advertise new products.
  • Dynamic placeholders ({{1}} and {{2}}) allow customization for different products and topics.
  • Quick Reply Button enables users to opt out of promotional messages.
  • URL Button provides direct access to the product or promotional landing page.
  • There is no header or footer, keeping the message concise and action-oriented.

Leave a Comment

Share this Doc

Parameter with body , button – quick-replay, visit-website

Or copy link

CONTENTS