Pingtochat Docs

Pingtochat Docs

Did You Know?

Advanced visual search system powered by Ajax

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

No parameter with header-text and body and footer static with url button and with quick-replay

Estimated reading: 4 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_r",
    "language": "en_US",
    "category": "MARKETING",
    "allow_category_change": true,
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Our summer sale is on!"
        },
        {
            "type": "BODY",
            "text": "Shop now  and use code CR7000 to get more offers"
        },
        {
            "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"
                }
            ]
        }
    ]
}

Parameters

  • name (string, required) – The unique name identifier for the template (“edit_r”).
  • language (string, required) – The language code for the template (“en_US”).
  • category (string, required) – The category of the template (“MARKETING”).
  • allow_category_change (boolean, optional) – Whether the category can be changed (true).
  • components (array, required) – The structural components of the template.

Components Details

  1. HEADER
    • type (string, required) – “HEADER”
    • format (string, required) – “TEXT”
    • text (string, required) – “Our summer sale is on!”
  2. BODY
    • type (string, required) – “BODY”
    • text (string, required) – “Shop now and use code CR7000 to get more offers”
  3. FOOTER
    • type (string, required) – “FOOTER”
    • text (string, required) – “Thank you for choosing us!”
  4. BUTTONS
    • type (string, required) – “BUTTONS”
    • buttons (array, required) – Contains interactive buttons.
      • QUICK_REPLY
        • type (string, required) – “QUICK_REPLY”
        • text (string, required) – “Unsubscribe from Promos”
      • URL Button
        • type (string, required) – “url”
        • text (string, required) – “Go to link”
        • url (string, required) – “https://app.pingtochat.com

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 summer sale is on in Urwallet!"
        },
        {
            "type": "BODY",
            "text": "We are introducing our new product in Urwallet!"
        },
        {
            "type": "FOOTER",
            "text": "Thank you for choosing Urwallet!"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Unsubscribe Urwallet!"
                },
                {
                    "type": "url",
                    "text": "Go to link",
                    "url": "https://developers.pingtochat.com/{{1}}",
                    "example": [
                        "?docs=pingtochat/wp"
                    ]
                }
            ]
        }
    ]
}

Parameters

  • name (string, required) – The unique name identifier for the template (“edit_r”).
  • language (string, required) – The language code for the template (“en_US”).
  • category (string, required) – The category of the template (“MARKETING”).
  • allow_category_change (boolean, optional) – Whether the category can be changed (true).
  • components (array, required) – The structural components of the template.

Components Details

  1. HEADER
    • type (string, required) – “HEADER”
    • format (string, required) – “TEXT”
    • text (string, required) – “Our summer sale is on!”
  2. BODY
    • type (string, required) – “BODY”
    • text (string, required) – “Shop now and use code CR7000 to get more offers”
  3. FOOTER
    • type (string, required) – “FOOTER”
    • text (string, required) – “Thank you for choosing us!”
  4. BUTTONS
    • type (string, required) – “BUTTONS”
    • buttons (array, required) – Contains interactive buttons.
      • QUICK_REPLY
        • type (string, required) – “QUICK_REPLY”
        • text (string, required) – “Unsubscribe from Promos”
      • URL Button
        • type (string, required) – “url”
        • text (string, required) – “Go to link”
        • url (string, required) – “https://app.pingtochat.com

Response

{
    "success": true,
    "id": "xxxxxx",
    "name": "edit_r",
    "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

No parameter with header-text and body and footer static with url button and with quick-replay

Or copy link

CONTENTS