Pingtochat Docs

Pingtochat Docs

Did You Know?

You can create any type of product documentation with Docy

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

Auto-Fill to Copy-Code

Estimated reading: 2 minutes 51 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": "autofill_to_copy_code",
  "language": "en_US",
  "category": "authentication",
  "message_send_ttl_seconds": 60,
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 10
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "one_tap",
          "text": "Copy Code",
          "autofill_text": "Autofill",
          "package_name": "app.pingtochat.com",
          "signature_hash": "K8a/AINcGX7"
        }
      ]
    }
  ]
}

Components

  • Body: Includes security recommendations for authentication messages.
  • Footer: Specifies the OTP code expiration time (5 minutes).
  • Buttons:
    • OTP Type: zero_tap
    • Button Text: “Copy Code”
    • Autofill Text: “Autofill”
    • Zero Tap Terms Accepted: true
    • Supported Apps: Defines package names and signature hashes for authentication.

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": "body",
            "add_security_recommendation": true
        },
        {
            "type": "footer",
            "code_expiration_minutes": 5
        },
        {
            "type": "buttons",
            "buttons": [
                {
                    "type": "otp",
                    "otp_type": "copy_code",
                    "text": "Copy Code"
                }
            ]
        }
    ]
}

Components

Body

  • TypeBODY
  • Security Recommendationtrue
  • TypeFOOTER
  • Code Expiration5 minutes

Buttons

  • TypeBUTTONS
  • Buttons:
    • Typeotp
    • OTP Typecopy_code
    • TextCopy Code

Success Response

  • Status Code201 APPROVED
{
    "success": true,
    "id": "xxxxxx",
    "name": "autofill_to_copy_code",
    "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 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

Auto-Fill to Copy-Code

Or copy link

CONTENTS