Send a template - GetReply

Send a template

curl --request POST \
  --url https://api.getreply.in/v1/messages/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "to": "+9198250*****",
  "template": {
    "name": "order_update",
    "language": "en"
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({to: '+9198250*****', template: {name: 'order_update', language: 'en'}})
};

fetch('https://api.getreply.in/v1/messages/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getreply.in/v1/messages/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'to' => '+9198250*****',
    'template' => [
        'name' => 'order_update',
        'language' => 'en'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.getreply.in/v1/messages/template"

payload = {
    "to": "+9198250*****",
    "template": {
        "name": "order_update",
        "language": "en"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "status": "<string>",
  "to": "<string>",
  "customer": {
    "phone": "<string>",
    "user_id": "<string>",
    "username": "<string>"
  },
  "country": "<string>",
  "category": "<string>",
  "price": "<string>",
  "reference": "<string>"
}

POST

/

v1

/

messages

/

template

Send a template

curl --request POST \
  --url https://api.getreply.in/v1/messages/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "to": "+9198250*****",
  "template": {
    "name": "order_update",
    "language": "en"
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({to: '+9198250*****', template: {name: 'order_update', language: 'en'}})
};

fetch('https://api.getreply.in/v1/messages/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getreply.in/v1/messages/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'to' => '+9198250*****',
    'template' => [
        'name' => 'order_update',
        'language' => 'en'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.getreply.in/v1/messages/template"

payload = {
    "to": "+9198250*****",
    "template": {
        "name": "order_update",
        "language": "en"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "status": "<string>",
  "to": "<string>",
  "customer": {
    "phone": "<string>",
    "user_id": "<string>",
    "username": "<string>"
  },
  "country": "<string>",
  "category": "<string>",
  "price": "<string>",
  "reference": "<string>"
}

Authorizations

Authorization

string

header

required

Your API key, e.g. gr_live_…

Headers

Idempotency-Key

string

required

Your own unique id for this request (at most 255 characters). The same id and body within 24 hours answers the first answer again — never a second send or charge.

Maximum string length: 255

Body

application/json

to

string

required

The person's WhatsApp number with its country code, e.g. +9198250***** — or their WhatsApp username id (e.g. "IN.1626…"; see Customer).

template

object

required

Show child attributes

reference

string

Your own reference for this message (at most 512 characters). It comes back on the message and its webhooks.

Maximum string length: 512

header

object

Only for a template with a header variable or a file header.

Show child attributes

body

string[]

One value per body variable, in order.

buttons

object[]

Show child attributes

Response

Accepted for sending. Follow its status with GET /v1/messages/{id} or webhooks.

id

string

status

string

to

string | null

customer

object

Who the customer is. phone can be null: a customer who uses a WhatsApp username may not share their number. user_id is WhatsApp's business-scoped user ID (for example "IN.13491208655302741918").

Show child attributes

country

string

category

string | null

price

string | null

reference

string | null