Campanhas
Listar campanhas
Campanhas de voz e de WhatsApp da organização, com paginação
GET
/
api
/
v1
/
campaigns
Listar campanhas da organização
curl --request GET \
--url https://api.useintegra.com.br/api/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useintegra.com.br/api/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
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.useintegra.com.br/api/v1/campaigns"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.useintegra.com.br/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"channel": "<string>",
"template_name": "<string>",
"scheduled_at": "<string>",
"agent": {
"id": "<string>",
"name": "<string>"
},
"phone_number": {
"id": "<string>",
"number": "<string>",
"friendly_name": "<string>"
},
"project": {
"id": "<string>",
"name": "<string>"
},
"total_recipients": 123,
"dispatched_count": 123,
"completed_count": 123,
"failed_count": 123,
"started_at": "<string>",
"ended_at": "<string>",
"created_at": "<string>",
"config": "<unknown>"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}A lista traz os dois canais juntos. Use o campo
Um
channel de cada item para distinguir campanha de ligações (voice) de campanha de mensagens (whatsapp).
Filtros
| Parâmetro | Valores | Padrão |
|---|---|---|
page | Número da página | 1 |
limit | Itens por página, máximo 100 | 20 |
status | PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED | Todos |
project_id | ID de um projeto da organização | Todos |
status fora da lista responde 400 em vez de devolver uma lista vazia — assim um erro de digitação não passa por “nenhuma campanha”.
Campos por canal
Campanhas de WhatsApp vêm comagent, phone_number, config e started_at nulos, e com template_name preenchido. Os detalhes de cada campo estão em Detalhes da campanha.
A lista não traz os destinatários, só os contadores (
total_recipients, dispatched_count, completed_count, failed_count). Para ver contato a contato, e o motivo de cada falha, use o endpoint de detalhes.Exemplo
curl "https://api.useintegra.com.br/api/v1/campaigns?status=COMPLETED&limit=2" \
-H "Authorization: Bearer ik_live_xxx"
{
"campaigns": [
{
"id": "cmp_9f8e7d",
"name": "Retomada de matrículas",
"status": "COMPLETED",
"channel": "whatsapp",
"template_name": "retomada_matricula",
"scheduled_at": "2026-09-01T14:00:00.000Z",
"config": null,
"agent": null,
"phone_number": null,
"project": { "id": "proj_abc123", "name": "Comercial" },
"total_recipients": 2,
"dispatched_count": 2,
"completed_count": 1,
"failed_count": 1,
"started_at": null,
"ended_at": "2026-09-01T14:03:12.000Z",
"created_at": "2026-08-17T10:32:00.000Z"
},
{
"id": "cmp_1a2b3c",
"name": "Confirmação de consulta",
"status": "COMPLETED",
"channel": "voice",
"template_name": null,
"scheduled_at": "2026-08-30T13:00:00.000Z",
"config": { "call_timeout": 45, "max_concurrent": 2 },
"agent": { "id": "agt_xyz789", "name": "Bia" },
"phone_number": {
"id": "phn_456def",
"number": "+551130000000",
"friendly_name": "Comercial"
},
"project": { "id": "proj_abc123", "name": "Comercial" },
"total_recipients": 40,
"dispatched_count": 40,
"completed_count": 36,
"failed_count": 4,
"started_at": "2026-08-30T13:00:05.000Z",
"ended_at": "2026-08-30T13:41:22.000Z",
"created_at": "2026-08-29T18:10:00.000Z"
}
],
"pagination": { "page": 1, "limit": 2, "total": 12 }
}
Authorizations
API Key da organização (Authorization: Bearer ik_live_xxx)
Query Parameters
Página (default: 1)
Itens por página (default: 20, max: 100)
Filtrar por status (PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED)
Filtrar por projeto
⌘I
Listar campanhas da organização
curl --request GET \
--url https://api.useintegra.com.br/api/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useintegra.com.br/api/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
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.useintegra.com.br/api/v1/campaigns"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.useintegra.com.br/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"channel": "<string>",
"template_name": "<string>",
"scheduled_at": "<string>",
"agent": {
"id": "<string>",
"name": "<string>"
},
"phone_number": {
"id": "<string>",
"number": "<string>",
"friendly_name": "<string>"
},
"project": {
"id": "<string>",
"name": "<string>"
},
"total_recipients": 123,
"dispatched_count": 123,
"completed_count": 123,
"failed_count": 123,
"started_at": "<string>",
"ended_at": "<string>",
"created_at": "<string>",
"config": "<unknown>"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}