Listar biblioteca de templates
curl --request GET \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library', 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.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library",
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: Bearer <token>"
],
]);
$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.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "order_confirmation_1",
"category": "UTILITY",
"languages": [
"pt_BR",
"en_US",
"es_ES"
],
"body": "Ola {{1}}, seu pedido {{2}} foi confirmado."
}
]
}{
"error": 123,
"message": "<string>"
}Outros endpoints
Biblioteca de templates
Use templates prontos da Meta sem passar por revisão
GET
/
whatsapp
/
businesses
/
{wabaId}
/
template-library
Listar biblioteca de templates
curl --request GET \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library', 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.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library",
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: Bearer <token>"
],
]);
$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.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/template-library")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "order_confirmation_1",
"category": "UTILITY",
"languages": [
"pt_BR",
"en_US",
"es_ES"
],
"body": "Ola {{1}}, seu pedido {{2}} foi confirmado."
}
]
}{
"error": 123,
"message": "<string>"
}Conceituação
A Meta mantém uma biblioteca de templates prontos para casos de uso comuns — confirmação de pedido, aviso de entrega, código de verificação. Templates criados a partir dela não passam por revisão: já nascem aprovados. Este endpoint lista o que está disponível para o seu WABA.A biblioteca é definida pela Meta e varia por categoria e idioma. Você não pode adicionar templates a ela.
Como descobrir quais modelos existem
A lista é da Meta e muda com o tempo, então ela se consulta, não se decora. O endpoint acima devolve os modelos disponíveis para o seu WABA, e cada um vem com o tema e o caso de uso dele.Na Graph API da Meta, a busca (
GET /message_template_library) aceita os
filtros topic, usecase, industry e language, mais search e name.
A nossa rota hoje não repassa esses filtros: ela devolve a lista, e a
filtragem é sua. Os valores abaixo servem para você reconhecer o tema e o
caso de uso de cada modelo que vier na resposta.Temas e casos de uso
| Filtro | Valores |
|---|---|
| Tema | ACCOUNT_UPDATE, CUSTOMER_FEEDBACK, ORDER_MANAGEMENT, PAYMENTS |
| Setor | E_COMMERCE, FINANCIAL_SERVICES |
| Tema | Casos de uso |
|---|---|
ORDER_MANAGEMENT | ORDER_CONFIRMATION, ORDER_ACTION_NEEDED, ORDER_DELAY, ORDER_PICK_UP, ORDER_OR_TRANSACTION_CANCEL, DELIVERY_CONFIRMATION, DELIVERY_UPDATE, DELIVERY_FAILED, SHIPMENT_CONFIRMATION, RETURN_CONFIRMATION |
PAYMENTS | PAYMENT_CONFIRMATION, PAYMENT_DUE_REMINDER, PAYMENT_OVERDUE, PAYMENT_ACTION_REQUIRED, PAYMENT_SCHEDULED, PAYMENT_REJECT_FAIL, AUTO_PAY_REMINDER, LOW_BALANCE_WARNING, RECEIPT_ATTACHMENT, STATEMENT_ATTACHMENT, STATEMENT_AVAILABLE, TRANSACTION_ALERT |
ACCOUNT_UPDATE | ACCOUNT_CREATION_CONFIRMATION, FRAUD_ALERT |
CUSTOMER_FEEDBACK | FEEDBACK_SURVEY |
delivery_update_1 ou
low_balance_warning_1: é ele que vai em library_template_name.
Criar a partir de um modelo
A criação usa o mesmo endpoint de Referência da API, mas o corpo é outro: em vez decomponents, vão o nome do modelo e as entradas
que ele aceita.
{
"name": "aviso_de_entrega",
"category": "UTILITY",
"language": "pt_BR",
"library_template_name": "delivery_update_1",
"library_template_body_inputs": [
{ "add_contact_number": true, "add_track_package_link": true }
],
"library_template_button_inputs": [
{
"type": "URL",
"url": {
"base_url": "https://sualoja.com/pedido/{{1}}",
"url_suffix_example": "https://sualoja.com/pedido/1042"
}
},
{ "type": "PHONE_NUMBER", "phone_number": "+5511988881234" }
]
}
add_contact_number, add_learn_more_link,
add_security_recommendation, add_track_package_link) e informa os dados dos
botões que ele pede.
Modelo usado como está já nasce aprovado. A doc da Meta diz que
personalizar muda isso: “If you choose Customize template, your template
will have to go through review before you are able to send messages.” Se
você mudar o conteúdo, ele volta para a fila normal de revisão.