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-image and body and button quick-replay,visit-website, phone number

Estimated reading: 2 minutes 49 views

The Utility Attachment (Parameter) Template is designed for sending structured messages with media attachments. This template allows businesses to send confirmation messages with dynamic item numbers, along with interactive buttons for user actions.

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
  • Category: UTILITY
  • Allow Category Change: true

Components:

Header:

  • Type: HEADER
  • Format: MEDIA
  • Example Media URL: https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png

Body:

  • Type: BODY
  • Text: Item no {{1}} is confirmed!
  • Example: { "body_text": [["12CR007"]] }

Footer:

  • Type: FOOTER
  • Text: Thank you for choosing us!

Buttons:

  • Type: BUTTONS
  • Buttons:
    1. Quick Reply: { "type": "QUICK_REPLY", "text": "Unsubscribe from Promos" }
    2. URL Button: { "type": "url", "text": "Go to link", "url": "https://app.pingtochat.com/" }
    3. Phone Number Button: { "type": "PHONE_NUMBER", "text": "Call", "phone_number": "919526986676" }

Example API Request

{
  "name": "utility_attachment_parameter",
  "language": "en_US",
  "category": "UTILITY",
  "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": "Item no {{1}} is confirmed!",
      "example": {
        "body_text": [["12CR007"]]
      }
    },
    {
      "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

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

Notes

  • This template is designed for transactional confirmation messages.
  • The Quick Reply Button allows 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.
  • Since allow_category_change is true, the template can be used for multiple categories as needed.

Leave a Comment

Share this Doc

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

Or copy link

CONTENTS