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

Parameter with header body without static button url and quick-replay, phone-number and copy-code

Estimated reading: 3 minutes 67 views

Create a Template

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.

Request Body

{
    "name": "edit_ab",
    "language": "en_US",
    "category": "UTILITY",
    "allow_category_change": true,
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Our pingtochat {{1}} is on!",
            "example": {
                "header_text": [
                    "Summer Sale"
                ]
            }
        },
        {
            "type": "BODY",
            "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
            "example": {
                "body_text": [
                    [
                        "the end of August",
                        "25OFF",
                        "25%"
                    ]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "Use the buttons below to manage your marketing subscriptions"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Unsubscribe from Promos"
                },
                {
                    "type": "PHONE_NUMBER",
                    "text": "Call",
                    "phone_number": "91xxxxxxxxxx"
                },
                {
                    "type": "copy_code",
                    "example": "WRETTT"
                }
            ]
        }
    ]
}

Components

Header
  • Text: "Our pingtochat {{1}} is on!"
  • Example: "Summer Sale"
Body
  • Text: "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise."
  • Example:
    • {{1}}: "the end of August"
    • {{2}}: "25OFF"
    • {{3}}: "25%"
Footer
  • Text: "Use the buttons below to manage your marketing subscriptions"
Buttons
  1. Quick Reply Button
    • Text: "Unsubscribe from Promos"
  2. Phone Number Button
    • Text: "Call"
    • Phone Number: "919526986676"
  3. Copy Code Button
    • Example Code: "WRETTT"

Success Response

Status Code: 201 APPROVED

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

Edit an Existing Template

Endpoint

http://{{your_domain}}/api/v1.0/{{phone_number_id}}/{{key}}/{{template_id}}/template_update

Request Body

{
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Our pingtochat {{1}} is on!",
            "example": {
                "header_text": [
                    "Winter Sale"
                ]
            }
        },
        {
            "type": "BODY",
            "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
            "example": {
                "body_text": [
                    [
                        "the end of August",
                        "45OFF",
                        "35%"
                    ]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "Use the buttons below to manage your Urwallet subscriptions"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Unsubscribe Urwallet"
                },
                {
                    "type": "url",
                    "text": "Go to link",
                    "url": "https://app.pingtochat.com"
                },
                {
                    "type": "PHONE_NUMBER",
                    "text": "Call",
                    "phone_number": "91xxxxxxxxxx"
                },
                {
                    "type": "copy_code",
                    "example": "WRETTT"
                }
            ]
        }
    ]
}

Components Breakdown

  • HEADER – Text: “Our summer sale is on in Urwallet!”
  • BODY – Text: “We are introducing our new product in Urwallet!”
  • FOOTER – Text: “Thank you for choosing Urwallet!”
  • BUTTONS
    • Quick Reply Button – “Unsubscribe Urwallet!”
    • URL Button – “Go to link” (Dynamic URL support with example values)
    • Phone Number Button – “Call” (Calls a specified phone number)
    • Copy Code Button – Provides a predefined code for easy copying

Response

{
    "success": true,
    "id": "xxxxxx",
    "name": "edit_ab",
    "category": "marketing"
}

Notes

  • The {{your_domain}} should be replaced with the actual domain.
  • The {{phone_number_id}}, {{key}}, and {{template_id}} should be replaced with the actual values.
  • Ensure that the request body is formatted correctly as JSON.
  • Only authorized users with a valid key can create or update templates.
  • Categories may be restricted based on platform policies.

Leave a Comment

Share this Doc

Parameter with header body without static button url and quick-replay, phone-number and copy-code

Or copy link

CONTENTS