Pingtochat Docs

Pingtochat Docs

Did You Know?

You can create any type of product documentation with Docy

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

Parameter with body footer button – quick-replay ,visit-website and phone-number

Estimated reading: 3 minutes 72 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

Marketing Template AA

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

Components

The marketing_aa template consists of multiple components: Body, Footer, and Buttons.

1. Body Component

  • Type: BODY
  • Text: We are intraducing {{1}} new product about {{2}}
  • Example Usage:
    • Example Body Text: We are introducing our new product about WhatsApp message app.
    • Here, {{1}} is dynamically replaced with our, and {{2}} is replaced with WhatsApp message app.

2. Footer Component

  • Type: FOOTER
  • Text: Thank you for choosing us!
  • Purpose: This provides a polite closing message, enhancing customer engagement and gratitude.

3. Buttons Component

  • Type: BUTTONS
  • Buttons:
    • Type: QUICK_REPLY
    • Text: Unsubscribe from Promos
    • Purpose: Provides an interactive button for opting out of promotions.
    • Type: URL
    • Text: Go to link
    • URL: https://app.pingtochat.com/
    • Purpose: Directs users to an external link for further engagement.
    • Type: PHONE_NUMBER
    • Text: Call
    • Phone Number: 91xxxxxxxxxx
    • Purpose: Provides a direct call option for customer support or inquiries.

Dynamic Placeholders

The templates include placeholders for dynamic content:

  • {{1}} in Body: Represents an introductory phrase (e.g., our, the latest).
  • {{2}} in Body: Represents the product or service being introduced (e.g., WhatsApp message app).

Example Message Generation

Given the following placeholder values:

  • {{1}} (Body) = our
  • {{2}} (Body) = new chat feature

The generated message will be:

Body: We are introducing our new product about new chat feature.

Footer: Thank you for choosing us!

Buttons:

  • Unsubscribe from Promos
  • Go to link (redirects to https://app.pingtochat.com/)
  • Call (dials 91xxxxxxxxxx)

Sample Request

{
  "name": "marketing_aa",
  "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": "FOOTER",
        "text": "Thank you for choosing us!"
        },
        {
        "type":"BUTTONS",
        "buttons": [
                {
                "type": "QUICK_REPLY",
                "text": "Unsubscribe from Promos"
                },
                {
                "type": "url",
                "text": "Go to link",
                "url": "https://app.pingtochat.com/"
                },
                {
                "type": "PHONE_NUMBER",
                "text": "Call",
                "phone_number": "91xxxxxxxxxx"
                }
            ]
        }
    ]
}

Success Response

Status Code: 201 APPROVED

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

Notes

  • The template allows changes to the category since allow_category_change is set to true.
  • Proper spelling and grammar should be maintained in the placeholders to ensure a professional message.
  • Avoid hardcoding values and always use dynamic placeholders for flexibility.
  • The Unsubscribe from Promos button helps provide an easy opt-out option for users, ensuring compliance with marketing regulations.
  • The Go to link button helps direct users to external resources, while the Call button facilitates direct communication.

Leave a Comment

Share this Doc

Parameter with body footer button – quick-replay ,visit-website and phone-number

Or copy link

CONTENTS