Get an specific WhatsApp template - Hilos Docs

Get WhatsApp Template

curl --request GET \
  --url https://api.hilos.io/api/channels/whatsapp/template/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hilos.io/api/channels/whatsapp/template/{id}', 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.hilos.io/api/channels/whatsapp/template/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/channels/whatsapp/template/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/channels/whatsapp/template/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "language": "af",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "ACCOUNT_UPDATE",
  "channel": {
    "id": 123,
    "channel_id": "<string>",
    "channel_type": "WHATSAPP",
    "name": "<string>",
    "status": "NEW",
    "created_on": "2023-11-07T05:31:56Z",
    "channel_provider": "META_CLOUD_API",
    "is_sandbox": true
  },
  "components": {},
  "status": "draft",
  "rejected_reason": "<string>",
  "is_deleted": true,
  "is_sample": true
}

GET

/

api

/

channels

/

whatsapp

/

template

/

{id}

Get WhatsApp Template

curl --request GET \
  --url https://api.hilos.io/api/channels/whatsapp/template/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hilos.io/api/channels/whatsapp/template/{id}', 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.hilos.io/api/channels/whatsapp/template/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/channels/whatsapp/template/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/channels/whatsapp/template/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "language": "af",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "ACCOUNT_UPDATE",
  "channel": {
    "id": 123,
    "channel_id": "<string>",
    "channel_type": "WHATSAPP",
    "name": "<string>",
    "status": "NEW",
    "created_on": "2023-11-07T05:31:56Z",
    "channel_provider": "META_CLOUD_API",
    "is_sandbox": true
  },
  "components": {},
  "status": "draft",
  "rejected_reason": "<string>",
  "is_deleted": true,
  "is_sample": true
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

id

string<uuid>

required

Response

200 - application/json

name

string

required

Maximum string length: 120

language

enum<string>

required

Available options:

af,

sq,

ar,

az,

bn,

bg,

ca,

zh_CN,

zh_HK,

zh_TW,

hr,

cs,

da,

nl,

en,

en_GB,

en_US,

et,

fil,

fi,

fr,

ka,

de,

el,

gu,

ha,

he,

hi,

hu,

id,

ga,

it,

ja,

kn,

kk,

rw_RW,

ko,

ky_KG,

lo,

lv,

lt,

mk,

ms,

ml,

mr,

nb,

fa,

pl,

pt_BR,

pt_PT,

pa,

ro,

ru,

sr,

sk,

sl,

es,

es_AR,

es_ES,

es_MX,

sw,

sv,

ta,

te,

th,

tr,

uk,

ur,

uz,

vi,

zu

id

string<uuid>

required

read-only

The UUID of the WhatsApp Template to be sent.

category

enum<string>

required

Available options:

ACCOUNT_UPDATE,

PAYMENT_UPDATE,

PERSONAL_FINANCE_UPDATE,

SHIPPING_UPDATE,

RESERVATION_UPDATE,

ISSUE_RESOLUTION,

APPOINTMENT_UPDATE,

TRANSPORTATION_UPDATE,

TICKET_UPDATE,

ALERT_UPDATE,

AUTO_REPLY,

TRANSACTIONAL,

MARKETING,

OTP,

AUTHENTICATION,

UTILITY

channel

object

required

The ID of the WhatsApp Channel that the WhatsApp Template is for.

Show child attributes

components

object | null

Show child attributes

status

enum<string>

Available options:

draft,

approved,

in_appeal,

pending,

rejected,

pending_deletion,

deleted,

disabled,

submitted

rejected_reason

string | null

is_deleted

boolean

is_sample

boolean