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

No parameter body,footer and buttons – quick-replay,visit-website,phone-number

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

Utility Template N

  • Name: utility_n
  • Language: en_US (English – United States)
  • Category: UTILITY
  • Allow Category Change: Yes

Components

Utility Template N Components

The utility_n template consists of a Body, a Footer, and a Buttons component.

  • Body:
    • Type: BODY
    • Text: Item no CR7000 is confirmed!
    • Purpose: Serves as a confirmation notification for an item, order, or transaction.
  • Footer:
    • Type: FOOTER
    • Text: Thank you for choosing us!
    • Purpose: Provides a closing remark to thank the recipient.
  • Buttons:
    • Type: BUTTONS
    • Buttons:
      • Type: QUICK_REPLY
      • Text: Unsubscribe from Promos
      • Purpose: Allows the recipient to opt out of promotional messages.
      • Type: URL
      • Text: Go to link
      • URL: https://app.pingtochat.com/
      • Purpose: Provides a link for the recipient to access additional resources or actions.
      • Type: PHONE_NUMBER
      • Text: Call
      • Phone Number: 91xxxxxxxxxx
      • Purpose: Allows the recipient to directly call a designated phone number for support or inquiries.

Example Message Generation

Utility Template N

Body: Item no CR7000 is confirmed! Footer: Thank you for choosing us! Buttons:

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

Sample Request

{
  "name": "utility_n",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "BODY",
        "text": "Item no CR7000 is confirmed!"
        },
         {
        "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.
  • This template is intended for utility purposes, such as order confirmations, service updates, or other transactional messages.
  • The inclusion of Quick Reply, URL Button, and Phone Number Button allows recipients to opt out of promotions, access resources, or make direct calls conveniently.
  • The message format is mostly fixed and does not include dynamic placeholders, making it suitable for standard notifications.

Leave a Comment

Share this Doc

No parameter body,footer and buttons – quick-replay,visit-website,phone-number

Or copy link

CONTENTS