Parameter with header,body,footer buttons – quick-replay,visit-website

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

Components

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

• Header:
  • Type: HEADER
  • Format: TEXT
  • Text: Hi confirmation from {{1}}!
  • Example: "Hi confirmation from P2C!"
  • Purpose: Provides a personalized greeting that includes a dynamic value (e.g., company name or sender).
• Body:
  • Type: BODY
  • Text: Item no {{1}} is confirmed!
  • Example: "Item no 12CR007 is confirmed!"
  • Purpose: Serves as a confirmation notification for an item, order, or transaction with a dynamic item number.
• Footer:
  • Type: FOOTER
  • Text: "Thank you for choosing us!"
  • Purpose: Adds a closing remark to appreciate the recipient.
• Buttons:
  • Type: BUTTONS
  • Buttons:
    • Type: QUICK_REPLY
    • Text: "Unsubscribe from Promos"
    • Purpose: Allows the recipient to quickly opt out of promotional messages.
    • Type: URL
    • Text: "Go to link"
    • URL: https://app.pingtochat.com/
    • Purpose: Directs the recipient to an external link for further actions.

Example Message Generation

Header: "Hi confirmation from P2C!"
Body: "Item no 12CR007 is confirmed!"
Footer: "Thank you for choosing us!"
Buttons:

• "Unsubscribe from Promos"
• "Go to link" (URL: https://app.pingtochat.com/)

Sample Request

{
  "name": "utility_aa",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Hi confirmation from {{1}}!",
        "example": {
            "header_text": [
            "P2C"
            ]
        }
        },
        {
        "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/"
                }
            ]
        }
    ]
}

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.
• It is designed for utility purposes, such as order confirmations, service updates, or other transactional messages.
• The Header and Body are dynamic, allowing personalization for a more user-specific experience.
• The Footer provides a thank-you message to improve customer engagement.
• 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.