Pingtochat Docs

Pingtochat Docs

Did You Know?

Docy turns out that context is a key part of learning.

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

No parameter

Estimated reading: 2 minutes 74 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 A

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

Components

The utility_a template consists of a Body component.

1. Body Component

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

Example Message Generation

The generated message will be:

Body: Item no 12CR007 is confirmed!

Sample Request

{
  "name": "utility_a",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "BODY",
        "text": "Item no 12CR007 is confirmed!"
        }    
    ]
}

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 message format is fixed and does not include dynamic placeholders, making it suitable for standard notifications.

Leave a Comment

Share this Doc

No parameter

Or copy link

CONTENTS