Template message - document

Send WhatsApp Message API

POST http://api.koreroplatforms.com/v1/whatsapp/send

Headers

NameTypeDescription

api_key

string

API Key

Request Body

NameTypeDescription

from

string

The WhatsApp number associated with your WABA account

to

string

Recipient mobile number

type

string

pass value as 'template'

template

object

template_id

string

The template ID provided on the user panel

header

string

The object to pass the document information

type

string

pass value as 'document'

document

object

accessory_url

string

Pass the URL which hosts the document file

filename

string

The name of the file to be displayed to the recipient

body

object

type

string

pass value as 'text'

personalization

string

The array of personalized values

{
    "timestamp": "2021-05-19T11:01:22.0Z",
    "status": "success",
    "request_id": "5ef1eda4-9cd1-42d2-bf3f-4661e4e6f7bc",
    "recipients": [
        {
            "to": "919699112120",
            "message_id": "WA162140228225012"
        }
    ]
}

Sample Request Body

{
    "from": "919311815518",
    "to": "919699112120",
    "type": "template",
    "template": {
        "template_id": "201077",
        "header": {
            "type": "document",
            "document": {
                "accessory_url": "https://www.dbs.com/in/iwov-resources/pdf/forms-and-legal/form-15g.pdf",
                "filename":"form_15",
                "caption":"kingson"
            }
        },
        "body": {
            "type": "text",
            "personalization": ["Nitin"]
        }
    }
}

Last updated