Retentar campanha

POST

api

campaigns

{id}

retry

Retentar destinatários com falha

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

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

fetch('https://api.useintegra.com.br/api/v1/campaigns/{id}/retry', 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}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/retry"

	req, _ := http.NewRequest("POST", 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}/retry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "status": "<string>",
  "retried_count": 123,
  "message": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

A retentativa devolve a campanha ao status PENDING e ela é reprocessada automaticamente. Só destinatários que falharam voltam para a fila: quem já recebeu não recebe de novo.

Quando cada canal aceita

Canal	Status da campanha	Destinatários que voltam para `PENDING`
`voice`	`COMPLETED` ou `FAILED`	`FAILED`, `NO_ANSWER` e `VOICEMAIL`
`whatsapp`	`COMPLETED`, `FAILED` ou `CANCELLED`	`FAILED`

Uma campanha IN_PROGRESS não pode ser retentada, e a recusa é proposital: existe um processo vivo percorrendo a lista, e reenfileirar no meio faria um segundo processo reivindicar os mesmos destinatários. O resultado seria a mesma pessoa recebendo duas vezes.

Contadores

Os contadores da campanha (dispatched_count, failed_count) são compensados na mesma operação: as tentativas que vão ser refeitas saem da conta antes de o reprocessamento começar. Sem isso, uma campanha de 100 com 10 falhas retentada com sucesso terminaria com dispatched_count 110 contra total_recipients 100.

Exemplo

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

{
  "id": "cmp_9f8e7d",
  "status": "PENDING",
  "retried_count": 7,
  "message": "7 recipients will be retried"
}

Erros

Status	Quando acontece
`400`	Status não permite retentativa, ou não há destinatários com falha
`404`	Campanha não encontrada na sua organização
`502`	Falha na comunicação com o serviço de WhatsApp
`503`	Integração de WhatsApp não configurada

No canal whatsapp existe um caso em que a campanha inteira falha sem nenhum destinatário ter falhado: quando o template é pausado, rejeitado ou desabilitado entre o agendamento e o disparo. Nesse caso a retentativa reenfileira a lista toda depois de você reativar o template, e retried_count volta 0 porque não havia falhas individuais para refazer.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

ID da campanha

Response

Retentativa iniciada

string

required

status

string

required

retried_count

number

required

message

string

required

Retentar destinatários com falha

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

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

fetch('https://api.useintegra.com.br/api/v1/campaigns/{id}/retry', 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}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/retry"

	req, _ := http.NewRequest("POST", 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}/retry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "status": "<string>",
  "retried_count": 123,
  "message": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Getting Started

Conceitos

API Reference

Quando cada canal aceita

Contadores

Exemplo

Erros

Authorizations

Path Parameters

Response

​Quando cada canal aceita

​Contadores

​Exemplo

​Erros

Authorizations

Path Parameters

Response

Quando cada canal aceita

Contadores

Exemplo

Erros