Parameter with body buttons – quick-replay,visit-website,phone-number

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

Components

The utility_al template consists of a Body and a Buttons component.

• Body:
  • Type: BODY
  • Text: "Item no {{1}} is confirmed!"
  • Example: "Item no 12CR007 is confirmed!"
  • Purpose: Provides a confirmation message for an item, order, or transaction with a dynamic item number.
• 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.
    • Type: PHONE_NUMBER
    • Text: "Call"
    • Phone Number: 91xxxxxxxxxx
    • Purpose: Allows the recipient to initiate a call directly for further assistance.

Example Message Generation

Body: "Item no 12CR007 is confirmed!"
Buttons:

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

Sample Request

{
  "name": "utility_al",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "BODY",
        "text": "Item no {{1}} is confirmed!",
        "example": {
            "body_text": [
            [
                "12CR007"
            ]
            ]
        }
        },
        {
        "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.
• It is designed for transactional confirmation messages with options for opting out of promotions, redirecting users to an external link, and 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.
• There is no Footer or Header, keeping the template minimal and functional.