Preview de mensagem - resolve variáveis e retorna mensagem formatada
curl --request POST \
--url https://api.nuvia.ai/v1/campaigns/preview-message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action_config": {
"text_content": "<string>",
"template_name": "<string>",
"language_code": "pt_BR",
"components": [
{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}
]
},
"list_id": "<string>",
"row_id": "<string>",
"contact_id": "<string>",
"variables": {},
"inbox_id": "<string>"
}
'import requests
url = "https://api.nuvia.ai/v1/campaigns/preview-message"
payload = {
"action_config": {
"text_content": "<string>",
"template_name": "<string>",
"language_code": "pt_BR",
"components": [
{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": { "link": "<string>" },
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}
]
},
"list_id": "<string>",
"row_id": "<string>",
"contact_id": "<string>",
"variables": {},
"inbox_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action_config: {
text_content: '<string>',
template_name: '<string>',
language_code: 'pt_BR',
components: [
{
index: '<string>',
parameters: [
{
image: {link: '<string>', id: '<string>'},
document: {link: '<string>', filename: '<string>'},
video: {link: '<string>'},
text: '<string>',
value: '<string>',
link: '<string>',
imageUrl: '<string>',
imageId: '<string>',
documentUrl: '<string>',
documentFilename: '<string>',
videoUrl: '<string>',
currencyCode: '<string>',
currencyAmount: 123,
dateTime: '<string>',
payload: '<string>',
parameter_name: '<string>',
variable_ref: '<string>'
}
]
}
]
},
list_id: '<string>',
row_id: '<string>',
contact_id: '<string>',
variables: {},
inbox_id: '<string>'
})
};
fetch('https://api.nuvia.ai/v1/campaigns/preview-message', 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.nuvia.ai/v1/campaigns/preview-message",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_config' => [
'text_content' => '<string>',
'template_name' => '<string>',
'language_code' => 'pt_BR',
'components' => [
[
'index' => '<string>',
'parameters' => [
[
'image' => [
'link' => '<string>',
'id' => '<string>'
],
'document' => [
'link' => '<string>',
'filename' => '<string>'
],
'video' => [
'link' => '<string>'
],
'text' => '<string>',
'value' => '<string>',
'link' => '<string>',
'imageUrl' => '<string>',
'imageId' => '<string>',
'documentUrl' => '<string>',
'documentFilename' => '<string>',
'videoUrl' => '<string>',
'currencyCode' => '<string>',
'currencyAmount' => 123,
'dateTime' => '<string>',
'payload' => '<string>',
'parameter_name' => '<string>',
'variable_ref' => '<string>'
]
]
]
]
],
'list_id' => '<string>',
'row_id' => '<string>',
'contact_id' => '<string>',
'variables' => [
],
'inbox_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.nuvia.ai/v1/campaigns/preview-message"
payload := strings.NewReader("{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.nuvia.ai/v1/campaigns/preview-message")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/campaigns/preview-message")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}campaigns
Preview de mensagem - resolve variáveis e retorna mensagem formatada
POST
/
v1
/
campaigns
/
preview-message
Preview de mensagem - resolve variáveis e retorna mensagem formatada
curl --request POST \
--url https://api.nuvia.ai/v1/campaigns/preview-message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action_config": {
"text_content": "<string>",
"template_name": "<string>",
"language_code": "pt_BR",
"components": [
{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}
]
},
"list_id": "<string>",
"row_id": "<string>",
"contact_id": "<string>",
"variables": {},
"inbox_id": "<string>"
}
'import requests
url = "https://api.nuvia.ai/v1/campaigns/preview-message"
payload = {
"action_config": {
"text_content": "<string>",
"template_name": "<string>",
"language_code": "pt_BR",
"components": [
{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": { "link": "<string>" },
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}
]
},
"list_id": "<string>",
"row_id": "<string>",
"contact_id": "<string>",
"variables": {},
"inbox_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action_config: {
text_content: '<string>',
template_name: '<string>',
language_code: 'pt_BR',
components: [
{
index: '<string>',
parameters: [
{
image: {link: '<string>', id: '<string>'},
document: {link: '<string>', filename: '<string>'},
video: {link: '<string>'},
text: '<string>',
value: '<string>',
link: '<string>',
imageUrl: '<string>',
imageId: '<string>',
documentUrl: '<string>',
documentFilename: '<string>',
videoUrl: '<string>',
currencyCode: '<string>',
currencyAmount: 123,
dateTime: '<string>',
payload: '<string>',
parameter_name: '<string>',
variable_ref: '<string>'
}
]
}
]
},
list_id: '<string>',
row_id: '<string>',
contact_id: '<string>',
variables: {},
inbox_id: '<string>'
})
};
fetch('https://api.nuvia.ai/v1/campaigns/preview-message', 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.nuvia.ai/v1/campaigns/preview-message",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_config' => [
'text_content' => '<string>',
'template_name' => '<string>',
'language_code' => 'pt_BR',
'components' => [
[
'index' => '<string>',
'parameters' => [
[
'image' => [
'link' => '<string>',
'id' => '<string>'
],
'document' => [
'link' => '<string>',
'filename' => '<string>'
],
'video' => [
'link' => '<string>'
],
'text' => '<string>',
'value' => '<string>',
'link' => '<string>',
'imageUrl' => '<string>',
'imageId' => '<string>',
'documentUrl' => '<string>',
'documentFilename' => '<string>',
'videoUrl' => '<string>',
'currencyCode' => '<string>',
'currencyAmount' => 123,
'dateTime' => '<string>',
'payload' => '<string>',
'parameter_name' => '<string>',
'variable_ref' => '<string>'
]
]
]
]
],
'list_id' => '<string>',
'row_id' => '<string>',
'contact_id' => '<string>',
'variables' => [
],
'inbox_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.nuvia.ai/v1/campaigns/preview-message"
payload := strings.NewReader("{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.nuvia.ai/v1/campaigns/preview-message")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/campaigns/preview-message")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_config\": {\n \"text_content\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language_code\": \"pt_BR\",\n \"components\": [\n {\n \"index\": \"<string>\",\n \"parameters\": [\n {\n \"image\": {\n \"link\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"document\": {\n \"link\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"video\": {\n \"link\": \"<string>\"\n },\n \"text\": \"<string>\",\n \"value\": \"<string>\",\n \"link\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageId\": \"<string>\",\n \"documentUrl\": \"<string>\",\n \"documentFilename\": \"<string>\",\n \"videoUrl\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"currencyAmount\": 123,\n \"dateTime\": \"<string>\",\n \"payload\": \"<string>\",\n \"parameter_name\": \"<string>\",\n \"variable_ref\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"list_id\": \"<string>\",\n \"row_id\": \"<string>\",\n \"contact_id\": \"<string>\",\n \"variables\": {},\n \"inbox_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}Autorizações
Token JWT de autenticação
Cabeçalhos
Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.
Corpo
application/json
Resposta
201 - application/json
The response is of type object.
Preview da audiência - conta contatos sem criar enrollments, com validação por canalContar campanhas por status
⌘I