Detalhes da campanha

GET

api

campaigns

{id}

Detalhes de uma campanha

curl --request GET \
  --url https://api.useintegra.com.br/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useintegra.com.br/api/v1/campaigns/{id}', 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/{id}",
  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/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.useintegra.com.br/api/v1/campaigns/{id}")

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

{
  "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>",
  "recipients": [
    {
      "id": "<string>",
      "phone_number": "<string>",
      "recipient_name": "<string>",
      "status": "<string>",
      "error_message": "<string>",
      "conversation_id": "<string>",
      "duration_ms": 123,
      "cost_usd": 123,
      "started_at": "<string>",
      "ended_at": "<string>",
      "dynamic_variables": "<unknown>"
    }
  ],
  "config": "<unknown>"
}

{
  "error": "<string>"
}

Campos por canal

O campo channel diz se a campanha é de voz ou de WhatsApp, e alguns campos só fazem sentido em um dos dois.

Campo	`voice`	`whatsapp`
`agent`	O agente que liga	`null`
`phone_number`	O número de origem	`null`
`config`	Parâmetros de discagem	`null`
`template_name`	`null`	Nome do template aprovado na Meta
`started_at`	Quando a campanha começou	`null`

started_at vem null no canal whatsapp de propósito. Internamente aquele carimbo é o batimento do processo de disparo, recarimbado a cada destinatário, e não o horário em que a campanha começou. Publicá-lo mentiria. Use created_at e scheduled_at.

Status dos destinatários

Cada item de recipients tem um status próprio. O canal de WhatsApp usa a escala de entrega da Meta:

Status	Significado
`PENDING`	Ainda não disparado
`SENT`	Template entregue à Meta
`DELIVERED`	Chegou ao aparelho
`READ`	O contato abriu a mensagem
`REPLIED`	O contato respondeu
`FAILED`	A Meta recusou o envio. O motivo está em `error_message`
`CANCELLED`	A campanha foi cancelada antes de disparar este contato

Os status nunca regridem: um recibo de entrega atrasado não rebaixa quem já respondeu.

error_message traz o erro cru da Meta, com código e tudo (por exemplo (#132000) Number of parameters does not match the expected number of params). É o único lugar da API que diz por que um envio específico falhou — a lista de campanhas só sabe contar falhas.

Exemplo

curl https://api.useintegra.com.br/api/v1/campaigns/cmp_9f8e7d \
  -H "Authorization: Bearer ik_live_xxx"

{
  "id": "cmp_9f8e7d",
  "name": "Retomada de matrículas",
  "status": "COMPLETED",
  "channel": "whatsapp",
  "template_name": "retomada_matricula",
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "agent": null,
  "phone_number": null,
  "config": 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",
  "recipients": [
    {
      "id": "rcp_111",
      "phone_number": "+5511999999999",
      "recipient_name": "Ana",
      "status": "REPLIED",
      "error_message": null,
      "dynamic_variables": { "1": "Ana", "2": "quinta às 14h" }
    },
    {
      "id": "rcp_222",
      "phone_number": "+5521988887777",
      "recipient_name": "Bruno",
      "status": "FAILED",
      "error_message": "(#132000) Number of parameters does not match the expected number of params",
      "dynamic_variables": { "1": "Bruno" }
    }
  ]
}

Authorizations

Authorization

string

header

required

API Key da organização (Authorization: Bearer ik_live_xxx)

Path Parameters

string

required

ID da campanha

Response

Detalhes da campanha com recipients

string

required

name

string

required

status

string

required

channel

string

required

template_name

string | null

required

scheduled_at

string

required

agent

object | null

required

Show child attributes

phone_number

object | null

required

Show child attributes

project

object

required

Show child attributes

total_recipients

number

required

dispatched_count

number

required

completed_count

number

required

failed_count

number

required

started_at

string | null

required

ended_at

string | null

required

created_at

string

required

recipients

object[]

required

Show child attributes

config

any

Detalhes de uma campanha

curl --request GET \
  --url https://api.useintegra.com.br/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useintegra.com.br/api/v1/campaigns/{id}', 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/{id}",
  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/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.useintegra.com.br/api/v1/campaigns/{id}")

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

{
  "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>",
  "recipients": [
    {
      "id": "<string>",
      "phone_number": "<string>",
      "recipient_name": "<string>",
      "status": "<string>",
      "error_message": "<string>",
      "conversation_id": "<string>",
      "duration_ms": 123,
      "cost_usd": 123,
      "started_at": "<string>",
      "ended_at": "<string>",
      "dynamic_variables": "<unknown>"
    }
  ],
  "config": "<unknown>"
}

{
  "error": "<string>"
}

Getting Started

Conceitos

API Reference

Campos por canal

Status dos destinatários

Exemplo

Authorizations

Path Parameters

Response

​Campos por canal

​Status dos destinatários

​Exemplo

Authorizations

Path Parameters

Response

Campos por canal

Status dos destinatários

Exemplo