Sincronizar templates

Sync templates

curl --request POST \
  --url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync', 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}/templates/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/templates/sync"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "1900296177408890",
      "name": "confirm_account",
      "status": "APPROVED",
      "category": "AUTHENTICATION",
      "language": "en_US",
      "parameter_format": "POSITIONAL",
      "message_send_ttl_seconds": 600,
      "components": [
        {
          "type": "BODY",
          "text": "Your verification code is *{{1}}*. For your security, do not share it.",
          "add_security_recommendation": true,
          "example": {
            "body_text": [
              [
                "123456"
              ]
            ]
          }
        }
      ]
    }
  ],
  "syncedCount": 2,
  "synced": true
}

{
  "error": 401,
  "message": "Unauthorized"
}

POST

businesses

{wabaId}

templates

sync

Sync templates

curl --request POST \
  --url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync', 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}/templates/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/templates/sync"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/sync")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "1900296177408890",
      "name": "confirm_account",
      "status": "APPROVED",
      "category": "AUTHENTICATION",
      "language": "en_US",
      "parameter_format": "POSITIONAL",
      "message_send_ttl_seconds": 600,
      "components": [
        {
          "type": "BODY",
          "text": "Your verification code is *{{1}}*. For your security, do not share it.",
          "add_security_recommendation": true,
          "example": {
            "body_text": [
              [
                "123456"
              ]
            ]
          }
        }
      ]
    }
  ],
  "syncedCount": 2,
  "synced": true
}

{
  "error": 401,
  "message": "Unauthorized"
}

Conceituação

Força a sincronização dos templates com a Meta, atualizando os status (PENDING, APPROVED, REJECTED) e demais informações dos templates locais. Útil quando você criou ou editou um template e quer verificar se o status de aprovação já foi atualizado pela Meta.

O wabaId é obtido através do endpoint de Listar WABAs.

Autorizações

Authorization

string

header

obrigatório

Secret Key generated in the Omni Z-API Security panel

Parâmetros de caminho

wabaId

string

obrigatório

WABA ID (obtained via List WABAs)

Exemplo:

"428083093730937"

Resposta

Synchronization completed successfully

data

object[]

List of synced templates

Show child attributes

syncedCount

integer

Number of synced templates

synced

boolean

Indicates whether the synchronization was successful

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Sincronizar templates

Conceituação

Autorizações

Parâmetros de caminho

Resposta

​Conceituação

Autorizações

Parâmetros de caminho

Resposta

Conceituação