Skip to main content
POST
/
v1
/
campaigns
/
{id}
/
resume
Resume a campaign
curl --request POST \
  --url https://api4.kinbox.com.br/v1/campaigns/{id}/resume \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "channelId": "<string>",
  "channelIds": [
    "<string>"
  ],
  "operatorId": "<string>",
  "operatorName": "<string>",
  "businessHoursId": "<string>",
  "channelType": "1",
  "leadType": "lead",
  "scheduledTo": "<string>",
  "nextScheduledTo": "<string>",
  "originalScheduledTo": "<string>",
  "finishedAtPrediction": "<string>",
  "leadsAssetUrl": "<string>",
  "message": "<string>",
  "textRaw": "<string>",
  "assetsUrls": [
    "<string>"
  ],
  "active": true,
  "shouldCreateConversation": false,
  "status": "processing",
  "chunksCount": 123,
  "leadsCount": 123,
  "secondsBetweenMessages": 123,
  "secondsBetweenChunks": 123,
  "trackAllChannels": true,
  "trackMaxHours": 96,
  "chunkSize": 123,
  "template": {},
  "progress": 123,
  "resultCounts": {
    "sent": 123,
    "received": 123,
    "read": 123,
    "answered": 123,
    "chunksExecuted": 123,
    "byChunkId": {}
  },
  "messagesProcessed": 123,
  "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
  "healthCheckData": {
    "messagesProcessed": 123,
    "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
    "healthCheckExecutions": 123,
    "jobId": "<string>",
    "chunkId": "<string>",
    "nextHealthCheckAt": "2023-11-07T05:31:56Z",
    "lastHealthCheckAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required
​
name
string
required

Nome da campanha

​
channelId
string

ID do canal

​
channelIds
string[]

IDs dos canais

​
operatorId
string

ID do operador

​
operatorName
string

Nome do operador

​
businessHoursId
string

ID do horário de atendimento

​
channelType
enum<string>

Tipo do canal

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
​
leadType
enum<string>

Tipo dos leads

Available options:
lead,
file
​
scheduledTo
string

Data de agendamento

​
nextScheduledTo
string

Próxima data de agendamento

​
originalScheduledTo
string

Data de agendamento original

​
finishedAtPrediction
string

Previsão de término

​
leadsAssetUrl
string

URL do arquivo de leads

​
message
string

Mensagem da campanha

​
textRaw
string

Texto bruto da mensagem

​
assetsUrls
string[]

URLs dos anexos/arquivos

​
active
boolean
default:true

Indica se a campanha está ativa

​
shouldCreateConversation
boolean
default:false

Indica se deve criar conversa

​
status
enum<string>

Status da campanha

Available options:
processing,
scheduled,
executing,
paused,
awaiting-chunk,
awaiting-business-hours,
awaiting-other-campaign,
canceled,
failed,
done,
done-sent
​
chunksCount
number

Quantidade de chunks

​
leadsCount
number

Quantidade de leads

​
secondsBetweenMessages
number

Segundos entre as mensagens

​
secondsBetweenChunks
number

Segundos entre os chunks

​
trackAllChannels
boolean

Indica se deve rastrear todos os canais

​
trackMaxHours
number
default:96

Máximo de horas de rastreamento

​
chunkSize
number

Tamanho do chunk

​
template
object

Template da campanha

​
progress
number

Progresso da campanha

​
resultCounts
object

Contagem de resultados

​
messagesProcessed
number

Quantidade de mensagens processadas

​
lastMessageProcessedAt
string<date-time>

Data de processamento da última mensagem

​
healthCheckData
object

Dados do health check