Listar templates do canal
Lista os templates do canal. Aqui você encontra o nome a usar em template.name e quantas variáveis cada template exige.
A lista sai do Connecta DESK, e não de uma consulta ao provedor: por isso ela responde rápido e aceita os filtros de situação e de fila. O catálogo é alimentado pela sincronização com a Meta/Gupshup, então um template aprovado agora no provedor aparece aqui depois da próxima sincronização.
Canal sem nenhum template sincronizado devolve lista vazia e agenda a sincronização em segundo plano — a chamada seguinte já encontra o catálogo. Um canal que não usa template aprovado também devolve lista vazia, sem erro.
curl --request GET \
--url https://api.connectadesk.com/api/v1/channels/{id}/templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/channels/{id}/templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.connectadesk.com/api/v1/channels/{id}/templates', 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.connectadesk.com/api/v1/channels/{id}/templates",
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.connectadesk.com/api/v1/channels/{id}/templates"
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.connectadesk.com/api/v1/channels/{id}/templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/channels/{id}/templates")
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": "confirmacao_pedido",
"language": "pt_BR",
"status": "APPROVED",
"category": "UTILITY",
"bodyText": "Olá {{1}}, seu pedido {{2}} foi confirmado.",
"bodyVariables": 2,
"headerType": "TEXT",
"headerText": "<string>",
"headerVariables": 0,
"headerRequiresMedia": true,
"footerText": "<string>",
"buttons": [
{}
]
}
],
"meta": {
"page": 1,
"perPage": 20,
"hasMore": true
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}Autorizações
Token da API no formato sk_live_….
Parâmetros de caminho
Parâmetros de consulta
Número da página, começando em 1. Um valor inválido é tratado como 1.
x >= 1Quantidade de itens por página. O máximo depende do ambiente (padrão 100).
1 <= x <= 100Situação do template. Aceita mais de uma, separadas por vírgula. Sem o filtro, vêm todas — inclusive rascunho e reprovado.
| Valor | Quando aparece |
|---|---|
APPROVED | Aprovado pelo provedor, pronto para disparo |
PENDING | Enviado e aguardando análise |
REJECTED | Reprovado |
PAUSED | Pausado pelo provedor, por qualidade |
DISABLED | Desativado pela Meta por qualidade, de forma definitiva |
ARCHIVED | Arquivado |
DRAFT | Rascunho, ainda não enviado para análise |
Traz só os modelos que esta fila pode usar: os que valem para todas as filas mais os vinculados a ela. A fila precisa ser da sua empresa.
curl --request GET \
--url https://api.connectadesk.com/api/v1/channels/{id}/templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/channels/{id}/templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.connectadesk.com/api/v1/channels/{id}/templates', 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.connectadesk.com/api/v1/channels/{id}/templates",
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.connectadesk.com/api/v1/channels/{id}/templates"
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.connectadesk.com/api/v1/channels/{id}/templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/channels/{id}/templates")
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": "confirmacao_pedido",
"language": "pt_BR",
"status": "APPROVED",
"category": "UTILITY",
"bodyText": "Olá {{1}}, seu pedido {{2}} foi confirmado.",
"bodyVariables": 2,
"headerType": "TEXT",
"headerText": "<string>",
"headerVariables": 0,
"headerRequiresMedia": true,
"footerText": "<string>",
"buttons": [
{}
]
}
],
"meta": {
"page": 1,
"perPage": 20,
"hasMore": true
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}
