Upload de mídia para template
curl --request POST \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-file \
--form type=image/jpegimport requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "type": "image/jpeg" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('type', 'image/jpeg');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media', 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/media",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"h": "4::aW1hZ2UvanBlZw==:ARZ...:e:1770000000:..."
}{
"error": "Authorization invalid"
}{
"error": "Content Too Large"
}{
"error": "Unsupported Media Type"
}{
"error": {
"status": 400,
"errors": [
{
"code": "377",
"name": "META_WHATSAPP_MEDIA_URL_NOT_ALLOWED",
"message": "Media URL not allowed"
}
]
}
}{
"error": "<string>"
}{
"error": "integration_timeout",
"message": "The operation took too long to complete. Try again in a few moments."
}Outros endpoints
Upload de mídia
Obtenha o header_handle para templates com HEADER de imagem, vídeo ou documento
POST
/
whatsapp
/
businesses
/
{wabaId}
/
templates
/
media
Upload de mídia para template
curl --request POST \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-file \
--form type=image/jpegimport requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "type": "image/jpeg" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('type', 'image/jpeg');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media', 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/media",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage/jpeg\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"h": "4::aW1hZ2UvanBlZw==:ARZ...:e:1770000000:..."
}{
"error": "Authorization invalid"
}{
"error": "Content Too Large"
}{
"error": "Unsupported Media Type"
}{
"error": {
"status": 400,
"errors": [
{
"code": "377",
"name": "META_WHATSAPP_MEDIA_URL_NOT_ALLOWED",
"message": "Media URL not allowed"
}
]
}
}{
"error": "<string>"
}{
"error": "integration_timeout",
"message": "The operation took too long to complete. Try again in a few moments."
}Conceituação
A Meta não aceita o arquivo direto na criação do template. Ela exige umheader_handle produzido pela Resumable Upload API, que depende do token da aplicação — por isso o upload passa por aqui, e não pelo seu frontend.
Este endpoint recebe o arquivo, ou o link público dele, e devolve o handle pronto para usar.
Quando você precisa disso
Somente quando o template tem um componenteHEADER do tipo IMAGE, VIDEO ou DOCUMENT. Templates com header de texto, ou sem header, não precisam de upload.
Duas formas de enviar
O formato é escolhido peloContent-Type da requisição.
- Arquivo (multipart)
- Link público (JSON)
multipart/form-data com o arquivo no campo file.O campo type é opcional. O MIME type usado é o da própria parte file; type só entra quando a parte chega sem tipo ou como application/octet-stream.curl -X POST https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media \
-H "Authorization: Bearer SUA_SECRET_KEY" \
-F "file=@banner.jpg;type=image/jpeg"
application/json com o endereço público da mídia no campo url.curl -X POST https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates/media \
-H "Authorization: Bearer SUA_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://cdn.exemplo.com/banner.jpg"}'
http ou https e público: endereços privados ou internos são recusados.Fluxo
1
Suba o arquivo ou o link
POST /whatsapp/businesses/{wabaId}/templates/media, em uma das duas formas acima.2
Guarde o handle
A resposta traz o handle no campo
h.3
Use no componente HEADER
Passe o handle como
example do HEADER em Referência da API:{
"type": "HEADER",
"format": "IMAGE",
"example": { "header_handle": ["4::aW1hZ2UvanBlZw==:ARZ..."] }
}
O handle tem validade. Suba o arquivo e crie o template na mesma sessão — não guarde o handle para usar dias depois.
Em arquivos maiores, o handle pode vir com quebras de linha. Use o valor de
h exatamente como recebido, sem remover nada.Pré-requisito de configuração
O upload depende do App ID da Meta cadastrado na conta. Sem ele a chamada retorna422, com o código 375 no corpo de erro.
Isso é configurado no painel, em Segurança — não há endpoint público para cadastrar as credenciais do app. Veja também Origens do SDK, que trata do outro pré-requisito do fluxo via SDK.
Limites
| Item | Valor |
|---|---|
| Tamanho máximo por arquivo | 100 MB |
| Tamanho máximo por link | 5 MB |
| Campo obrigatório (multipart) | file |
| Campo obrigatório (JSON) | url |
Erros
| Status | Quando |
|---|---|
400 | file ausente ou vazio, url ausente ou em branco, JSON inválido, ou secret key inválida ({"error": "Authorization invalid"}) |
413 | Arquivo acima de 100 MB |
415 | Content-Type diferente de multipart/form-data e application/json |
422 | A plataforma ou a Meta recusou o upload, ou a Meta falhou ao processá-lo (formato, tamanho, token vencido ou Meta fora do ar). O corpo de erro vem em error. Códigos mais comuns: 375 (canal sem App ID), 377 (link não permitido), 380 (falha ao baixar o link) |
502 | Plataforma indisponível. Recusa ou falha da Meta não sai como 502: vem como 422 |
Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do WABA (obtido via Listar WABAs)
Exemplo:
"428083093730937"
Corpo
multipart/form-dataapplication/json
Resposta
Upload concluído
Handle a ser usado como example do componente HEADER na criação do template