Criar nova campanha
curl --request POST \
--url https://api.nuvia.ai/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"audience_config": {
"filters": {
"agent_step_ids": [
"<string>"
],
"agent_ids": [
"<string>"
],
"conversation_status": [
"<string>"
],
"user_ids": [
"<string>"
]
},
"contact_ids": [
"<string>"
],
"lists": [
{
"id": "<string>",
"views": [
"<string>"
]
}
]
},
"description": "<string>",
"trigger_config": {},
"behavior_config": {
"ignore_business_hours": true
},
"linkedin_config": {
"first_step_as_invitation": true,
"send_invite_note": true,
"invite_note": "<string>"
},
"sender_config": {
"linkedin_inbox_id": "<string>",
"whatsapp_inbox_id": "<string>"
}
}
'import requests
url = "https://api.nuvia.ai/v1/campaigns"
payload = {
"name": "<string>",
"audience_config": {
"filters": {
"agent_step_ids": ["<string>"],
"agent_ids": ["<string>"],
"conversation_status": ["<string>"],
"user_ids": ["<string>"]
},
"contact_ids": ["<string>"],
"lists": [
{
"id": "<string>",
"views": ["<string>"]
}
]
},
"description": "<string>",
"trigger_config": {},
"behavior_config": { "ignore_business_hours": True },
"linkedin_config": {
"first_step_as_invitation": True,
"send_invite_note": True,
"invite_note": "<string>"
},
"sender_config": {
"linkedin_inbox_id": "<string>",
"whatsapp_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({
name: '<string>',
audience_config: {
filters: {
agent_step_ids: ['<string>'],
agent_ids: ['<string>'],
conversation_status: ['<string>'],
user_ids: ['<string>']
},
contact_ids: ['<string>'],
lists: [{id: '<string>', views: ['<string>']}]
},
description: '<string>',
trigger_config: {},
behavior_config: {ignore_business_hours: true},
linkedin_config: {
first_step_as_invitation: true,
send_invite_note: true,
invite_note: '<string>'
},
sender_config: {linkedin_inbox_id: '<string>', whatsapp_inbox_id: '<string>'}
})
};
fetch('https://api.nuvia.ai/v1/campaigns', 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",
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([
'name' => '<string>',
'audience_config' => [
'filters' => [
'agent_step_ids' => [
'<string>'
],
'agent_ids' => [
'<string>'
],
'conversation_status' => [
'<string>'
],
'user_ids' => [
'<string>'
]
],
'contact_ids' => [
'<string>'
],
'lists' => [
[
'id' => '<string>',
'views' => [
'<string>'
]
]
]
],
'description' => '<string>',
'trigger_config' => [
],
'behavior_config' => [
'ignore_business_hours' => true
],
'linkedin_config' => [
'first_step_as_invitation' => true,
'send_invite_note' => true,
'invite_note' => '<string>'
],
'sender_config' => [
'linkedin_inbox_id' => '<string>',
'whatsapp_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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/campaigns")
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 \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": {},
"company": {},
"name": "<string>",
"channel_type": {},
"trigger_config": {},
"audience_config": {},
"metrics": {},
"description": "<string>",
"behavior_config": {},
"linkedin_config": {},
"sender_config": {},
"last_execution_at": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}campaigns
Criar nova campanha
POST
/
v1
/
campaigns
Criar nova campanha
curl --request POST \
--url https://api.nuvia.ai/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"audience_config": {
"filters": {
"agent_step_ids": [
"<string>"
],
"agent_ids": [
"<string>"
],
"conversation_status": [
"<string>"
],
"user_ids": [
"<string>"
]
},
"contact_ids": [
"<string>"
],
"lists": [
{
"id": "<string>",
"views": [
"<string>"
]
}
]
},
"description": "<string>",
"trigger_config": {},
"behavior_config": {
"ignore_business_hours": true
},
"linkedin_config": {
"first_step_as_invitation": true,
"send_invite_note": true,
"invite_note": "<string>"
},
"sender_config": {
"linkedin_inbox_id": "<string>",
"whatsapp_inbox_id": "<string>"
}
}
'import requests
url = "https://api.nuvia.ai/v1/campaigns"
payload = {
"name": "<string>",
"audience_config": {
"filters": {
"agent_step_ids": ["<string>"],
"agent_ids": ["<string>"],
"conversation_status": ["<string>"],
"user_ids": ["<string>"]
},
"contact_ids": ["<string>"],
"lists": [
{
"id": "<string>",
"views": ["<string>"]
}
]
},
"description": "<string>",
"trigger_config": {},
"behavior_config": { "ignore_business_hours": True },
"linkedin_config": {
"first_step_as_invitation": True,
"send_invite_note": True,
"invite_note": "<string>"
},
"sender_config": {
"linkedin_inbox_id": "<string>",
"whatsapp_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({
name: '<string>',
audience_config: {
filters: {
agent_step_ids: ['<string>'],
agent_ids: ['<string>'],
conversation_status: ['<string>'],
user_ids: ['<string>']
},
contact_ids: ['<string>'],
lists: [{id: '<string>', views: ['<string>']}]
},
description: '<string>',
trigger_config: {},
behavior_config: {ignore_business_hours: true},
linkedin_config: {
first_step_as_invitation: true,
send_invite_note: true,
invite_note: '<string>'
},
sender_config: {linkedin_inbox_id: '<string>', whatsapp_inbox_id: '<string>'}
})
};
fetch('https://api.nuvia.ai/v1/campaigns', 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",
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([
'name' => '<string>',
'audience_config' => [
'filters' => [
'agent_step_ids' => [
'<string>'
],
'agent_ids' => [
'<string>'
],
'conversation_status' => [
'<string>'
],
'user_ids' => [
'<string>'
]
],
'contact_ids' => [
'<string>'
],
'lists' => [
[
'id' => '<string>',
'views' => [
'<string>'
]
]
]
],
'description' => '<string>',
'trigger_config' => [
],
'behavior_config' => [
'ignore_business_hours' => true
],
'linkedin_config' => [
'first_step_as_invitation' => true,
'send_invite_note' => true,
'invite_note' => '<string>'
],
'sender_config' => [
'linkedin_inbox_id' => '<string>',
'whatsapp_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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/campaigns")
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 \"name\": \"<string>\",\n \"audience_config\": {\n \"filters\": {\n \"agent_step_ids\": [\n \"<string>\"\n ],\n \"agent_ids\": [\n \"<string>\"\n ],\n \"conversation_status\": [\n \"<string>\"\n ],\n \"user_ids\": [\n \"<string>\"\n ]\n },\n \"contact_ids\": [\n \"<string>\"\n ],\n \"lists\": [\n {\n \"id\": \"<string>\",\n \"views\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"trigger_config\": {},\n \"behavior_config\": {\n \"ignore_business_hours\": true\n },\n \"linkedin_config\": {\n \"first_step_as_invitation\": true,\n \"send_invite_note\": true,\n \"invite_note\": \"<string>\"\n },\n \"sender_config\": {\n \"linkedin_inbox_id\": \"<string>\",\n \"whatsapp_inbox_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": {},
"company": {},
"name": "<string>",
"channel_type": {},
"trigger_config": {},
"audience_config": {},
"metrics": {},
"description": "<string>",
"behavior_config": {},
"linkedin_config": {},
"sender_config": {},
"last_execution_at": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}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
Required string length:
1 - 100Opções disponíveis:
WAP_AUTO_CLOSER, WEB_V2, EVOLUTION_API, LINKEDIN, MULTI_CHANNEL Opções disponíveis:
MANUAL, SCHEDULED, RECURRING, EXTERNAL_TRIGGER Show child attributes
Show child attributes
Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Resposta
201 - application/json
Opções disponíveis:
MANUAL, SCHEDULED, RECURRING, EXTERNAL_TRIGGER Opções disponíveis:
DRAFT, ACTIVE, PAUSED, COMPLETED, ARCHIVED Listar campanhasPreview da audiência - conta contatos sem criar enrollments, com validação por canal
⌘I