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

Parameter with header-video and body and button quick-replay,visit-website, phone number

Estimated reading: 2 minutes 212 views

This document provides detailed information about the Utility Parameter Attachment template, which is used for marketing communications that include media attachments and dynamic parameters.

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: utility_parameter_attachment
  • Language: en_US (English – United States)
  • Category: MARKETING
  • Allow Category Change: true

Components

Header

  • Type: HEADER
  • Format: MEDIA
  • Example Media URL: Google Logo
  • Purpose: Displays an image attachment in the message.

Body

  • Type: BODY
  • Text: We are introducing {{1}} new product about {{2}}
  • Example:
    • our
    • whatsapp message app
  • Purpose: Provides dynamic placeholders to introduce a new product.

Footer

  • Type: FOOTER
  • Text: Thank you for choosing us!
  • Purpose: Adds a closing remark to the message.

Buttons

  • Type: BUTTONS
  • Buttons:
    • Quick Reply
      • Text: Unsubscribe from Promos
      • Purpose: Allows users to opt out of marketing messages.
    • URL Button
      • Text: Go to link
      • URL: PingToChat
      • Purpose: Redirects users to an external link.
    • Phone Number Button
      • Text: Call
      • Phone Number: +91xxxxxxxxxx
      • Purpose: Allows users to initiate a call for inquiries.

Example Request

{
    "name": "utility_parameter_attachment",
    "language": "en_US",
    "category": "MARKETING",
    "allow_category_change": true,
    "components": [
        {
            "type": "HEADER",
            "format": "MEDIA",
            "example": {
                "media_url": "https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png"
            }
        },
        {
            "type": "BODY",
            "text": "We are introducing {{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
  • Example Response:
{
    "id": "xxxxxx",
    "status": "APPROVED",
    "category": "MARKETING"
}

Notes

  • This template is designed for marketing communications involving product introductions.
  • The Body section allows dynamic placeholders for product customization.
  • The Quick Reply button lets users opt out of future promotional messages.
  • The URL Button provides a direct link to additional information or a product page.
  • The Phone Number Button facilitates instant customer support.

Leave a Comment

Share this Doc

Parameter with header-video and body and button quick-replay,visit-website, phone number

Or copy link

CONTENTS