Campanhas
Criar campanha
Cria uma campanha de ligações automáticas. As ligações serão iniciadas no horário agendado.
Onde encontrar os IDs?
project_id: No painel, clique no projeto e copie o ID no header (ícone de clipboard ao lado do nome)agent_id: No painel, cada card de agente mostra o ID no rodapé (ícone de clipboard)phone_number_id: Use o endpoint GET /api/v1/phone-numbers ou copie do painel em Telecom
POST
/
api
/
v1
/
campaigns
Criar nova campanha de ligações
curl --request POST \
--url https://api.useintegra.com.br/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Campanha Março 2026",
"project_id": "b9c80a57-fad2-41a0-a304-727337ad1b1f",
"agent_id": "7e09d093-904a-48de-ac49-b0445906c38e",
"phone_number_id": "d1082e49-1b2c-4337-81e2-8eb74810351d",
"scheduled_at": "2026-03-25T14:00:00Z",
"recipients": [
{
"phone_number": "+5511999999999",
"recipient_name": "João Silva",
"dynamic_variables": {
"leadName": "Joao",
"companyName": "Acme Corp"
}
},
{
"phone_number": "+5511888888888",
"recipient_name": "Maria Santos",
"dynamic_variables": {
"leadName": "Maria",
"companyName": "Beta Ltd"
}
}
],
"config": {
"call_timeout": 45,
"voicemail_mode": "hangup",
"outbound_auto_greet": true,
"max_concurrent": 2
}
}
'import requests
url = "https://api.useintegra.com.br/api/v1/campaigns"
payload = {
"name": "Campanha Março 2026",
"project_id": "b9c80a57-fad2-41a0-a304-727337ad1b1f",
"agent_id": "7e09d093-904a-48de-ac49-b0445906c38e",
"phone_number_id": "d1082e49-1b2c-4337-81e2-8eb74810351d",
"scheduled_at": "2026-03-25T14:00:00Z",
"recipients": [
{
"phone_number": "+5511999999999",
"recipient_name": "João Silva",
"dynamic_variables": {
"leadName": "Joao",
"companyName": "Acme Corp"
}
},
{
"phone_number": "+5511888888888",
"recipient_name": "Maria Santos",
"dynamic_variables": {
"leadName": "Maria",
"companyName": "Beta Ltd"
}
}
],
"config": {
"call_timeout": 45,
"voicemail_mode": "hangup",
"outbound_auto_greet": True,
"max_concurrent": 2
}
}
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: 'Campanha Março 2026',
project_id: 'b9c80a57-fad2-41a0-a304-727337ad1b1f',
agent_id: '7e09d093-904a-48de-ac49-b0445906c38e',
phone_number_id: 'd1082e49-1b2c-4337-81e2-8eb74810351d',
scheduled_at: '2026-03-25T14:00:00Z',
recipients: [
{
phone_number: '+5511999999999',
recipient_name: 'João Silva',
dynamic_variables: {leadName: 'Joao', companyName: 'Acme Corp'}
},
{
phone_number: '+5511888888888',
recipient_name: 'Maria Santos',
dynamic_variables: {leadName: 'Maria', companyName: 'Beta Ltd'}
}
],
config: {
call_timeout: 45,
voicemail_mode: 'hangup',
outbound_auto_greet: true,
max_concurrent: 2
}
})
};
fetch('https://api.useintegra.com.br/api/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.useintegra.com.br/api/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' => 'Campanha Março 2026',
'project_id' => 'b9c80a57-fad2-41a0-a304-727337ad1b1f',
'agent_id' => '7e09d093-904a-48de-ac49-b0445906c38e',
'phone_number_id' => 'd1082e49-1b2c-4337-81e2-8eb74810351d',
'scheduled_at' => '2026-03-25T14:00:00Z',
'recipients' => [
[
'phone_number' => '+5511999999999',
'recipient_name' => 'João Silva',
'dynamic_variables' => [
'leadName' => 'Joao',
'companyName' => 'Acme Corp'
]
],
[
'phone_number' => '+5511888888888',
'recipient_name' => 'Maria Santos',
'dynamic_variables' => [
'leadName' => 'Maria',
'companyName' => 'Beta Ltd'
]
]
],
'config' => [
'call_timeout' => 45,
'voicemail_mode' => 'hangup',
'outbound_auto_greet' => true,
'max_concurrent' => 2
]
]),
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.useintegra.com.br/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\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.useintegra.com.br/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useintegra.com.br/api/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\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "PENDING",
"total_recipients": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}Authorizations
API Key da organização (Authorization: Bearer ik_live_xxx)
Body
application/json
Nome da campanha
Minimum string length:
1Example:
"Campanha Março 2026"
ID do projeto (copie do Panel → header do projeto)
Example:
"b9c80a57-fad2-41a0-a304-727337ad1b1f"
ID do agente que fará as ligações (copie do Panel → card do agente)
Example:
"7e09d093-904a-48de-ac49-b0445906c38e"
ID do número de telefone de origem
Example:
"d1082e49-1b2c-4337-81e2-8eb74810351d"
Data/hora para iniciar as ligações (ISO 8601 com timezone)
Example:
"2026-03-25T14:00:00Z"
Lista de destinatários (max 10.000)
Required array length:
1 - 10000 elementsShow child attributes
Show child attributes
Configurações opcionais da campanha
Show child attributes
Show child attributes
⌘I
Criar nova campanha de ligações
curl --request POST \
--url https://api.useintegra.com.br/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Campanha Março 2026",
"project_id": "b9c80a57-fad2-41a0-a304-727337ad1b1f",
"agent_id": "7e09d093-904a-48de-ac49-b0445906c38e",
"phone_number_id": "d1082e49-1b2c-4337-81e2-8eb74810351d",
"scheduled_at": "2026-03-25T14:00:00Z",
"recipients": [
{
"phone_number": "+5511999999999",
"recipient_name": "João Silva",
"dynamic_variables": {
"leadName": "Joao",
"companyName": "Acme Corp"
}
},
{
"phone_number": "+5511888888888",
"recipient_name": "Maria Santos",
"dynamic_variables": {
"leadName": "Maria",
"companyName": "Beta Ltd"
}
}
],
"config": {
"call_timeout": 45,
"voicemail_mode": "hangup",
"outbound_auto_greet": true,
"max_concurrent": 2
}
}
'import requests
url = "https://api.useintegra.com.br/api/v1/campaigns"
payload = {
"name": "Campanha Março 2026",
"project_id": "b9c80a57-fad2-41a0-a304-727337ad1b1f",
"agent_id": "7e09d093-904a-48de-ac49-b0445906c38e",
"phone_number_id": "d1082e49-1b2c-4337-81e2-8eb74810351d",
"scheduled_at": "2026-03-25T14:00:00Z",
"recipients": [
{
"phone_number": "+5511999999999",
"recipient_name": "João Silva",
"dynamic_variables": {
"leadName": "Joao",
"companyName": "Acme Corp"
}
},
{
"phone_number": "+5511888888888",
"recipient_name": "Maria Santos",
"dynamic_variables": {
"leadName": "Maria",
"companyName": "Beta Ltd"
}
}
],
"config": {
"call_timeout": 45,
"voicemail_mode": "hangup",
"outbound_auto_greet": True,
"max_concurrent": 2
}
}
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: 'Campanha Março 2026',
project_id: 'b9c80a57-fad2-41a0-a304-727337ad1b1f',
agent_id: '7e09d093-904a-48de-ac49-b0445906c38e',
phone_number_id: 'd1082e49-1b2c-4337-81e2-8eb74810351d',
scheduled_at: '2026-03-25T14:00:00Z',
recipients: [
{
phone_number: '+5511999999999',
recipient_name: 'João Silva',
dynamic_variables: {leadName: 'Joao', companyName: 'Acme Corp'}
},
{
phone_number: '+5511888888888',
recipient_name: 'Maria Santos',
dynamic_variables: {leadName: 'Maria', companyName: 'Beta Ltd'}
}
],
config: {
call_timeout: 45,
voicemail_mode: 'hangup',
outbound_auto_greet: true,
max_concurrent: 2
}
})
};
fetch('https://api.useintegra.com.br/api/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.useintegra.com.br/api/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' => 'Campanha Março 2026',
'project_id' => 'b9c80a57-fad2-41a0-a304-727337ad1b1f',
'agent_id' => '7e09d093-904a-48de-ac49-b0445906c38e',
'phone_number_id' => 'd1082e49-1b2c-4337-81e2-8eb74810351d',
'scheduled_at' => '2026-03-25T14:00:00Z',
'recipients' => [
[
'phone_number' => '+5511999999999',
'recipient_name' => 'João Silva',
'dynamic_variables' => [
'leadName' => 'Joao',
'companyName' => 'Acme Corp'
]
],
[
'phone_number' => '+5511888888888',
'recipient_name' => 'Maria Santos',
'dynamic_variables' => [
'leadName' => 'Maria',
'companyName' => 'Beta Ltd'
]
]
],
'config' => [
'call_timeout' => 45,
'voicemail_mode' => 'hangup',
'outbound_auto_greet' => true,
'max_concurrent' => 2
]
]),
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.useintegra.com.br/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\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.useintegra.com.br/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useintegra.com.br/api/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\": \"Campanha Março 2026\",\n \"project_id\": \"b9c80a57-fad2-41a0-a304-727337ad1b1f\",\n \"agent_id\": \"7e09d093-904a-48de-ac49-b0445906c38e\",\n \"phone_number_id\": \"d1082e49-1b2c-4337-81e2-8eb74810351d\",\n \"scheduled_at\": \"2026-03-25T14:00:00Z\",\n \"recipients\": [\n {\n \"phone_number\": \"+5511999999999\",\n \"recipient_name\": \"João Silva\",\n \"dynamic_variables\": {\n \"leadName\": \"Joao\",\n \"companyName\": \"Acme Corp\"\n }\n },\n {\n \"phone_number\": \"+5511888888888\",\n \"recipient_name\": \"Maria Santos\",\n \"dynamic_variables\": {\n \"leadName\": \"Maria\",\n \"companyName\": \"Beta Ltd\"\n }\n }\n ],\n \"config\": {\n \"call_timeout\": 45,\n \"voicemail_mode\": \"hangup\",\n \"outbound_auto_greet\": true,\n \"max_concurrent\": 2\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "PENDING",
"total_recipients": 123,
"scheduled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}