Pingtochat Docs

Pingtochat Docs

Did You Know?

Advanced visual search system powered by Ajax

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

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

Estimated reading: 3 minutes 48 views

This document provides detailed information about the Utility Templates used for communication purposes. These templates allow businesses to send structured messages to users for transactional or informational purposes.

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_attachment_no_parameter
  • Language: en_US (English – United States)
  • Category: UTILITY
  • Allow Category Change: Yes

Components

The utility_attachment_no_parameter template consists of a Header, Body, and Buttons component.

Header:

  • Type: HEADER
  • Format: MEDIA
  • Example Media URL: https://urwallet.pingtochat.com/template_media/1740161305.mp4
  • Purpose: Provides a media attachment such as a video to enhance the message.

Body:

  • Type: BODY
  • Text: "Item no 12CR007 is confirmed!"
  • Purpose: Provides a confirmation message for an item, order, or transaction.

Buttons:

  • Type: BUTTONS
  • Buttons List:
    • Quick Reply:"Unsubscribe from Promos"
      • Purpose: Allows the recipient to quickly opt out of promotional messages.
    • URL Button:"Go to link"Pingtochat
      • Purpose: Directs the recipient to an external link for further actions.
    • Phone Number Button:"Call"+91xxxxxxxxxx
      • Purpose: Allows the recipient to initiate a call directly for further assistance.

Buttons:

Sample Request

{
  "name": "utility_attachment_no_parameter",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
            "type": "HEADER",
            "format": "MEDIA",
            "example": {
                "media_url": "https://pingtochat.com/template_media/1740161305.mp4"
            }
        },
        {
            "type": "BODY",
            "text": "Item no 12CR007 is confirmed!"
        },
        {
            "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 CREATED
{
    "id": "xxxxxx",
    "status": "APPROVED",
    "category": "UTILITY"
}

Notes

  • The template allows changes to the category since allow_category_change is set to true.
  • It is designed for transactional confirmation messages with options for:
    • Opting out of promotions
    • Redirecting users to an external link
    • Calling a support number
  • The Quick Reply Button enables users to opt out of promotional messages easily.
  • The URL Button provides direct access to an external link for additional actions.
  • The Phone Number Button allows recipients to call customer support instantly.
  • The Header includes a video attachment, making it a rich media template.

Leave a Comment

Share this Doc

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

Or copy link

CONTENTS