v1Campaigns

Create a campaign

post/v1/campaigns

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v1/campaigns
  • Auth: none declared

Request body

namestring required

Nome da campanha

channelIdstring

ID do canal

channelIdsstring[]

IDs dos canais

operatorNamestring

Nome do operador

businessHoursIdstring

ID do horário de atendimento

channelType'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Tipo do canal

leadType'lead' | 'file'

Tipo dos leads

normalizeBrazilPhoneNumbersboolean

Normaliza números brasileiros adicionando DDI 55 quando aplicável

scheduledTostring

Data de agendamento

originalScheduledTostring

Data de agendamento original

finishedAtPredictionstring

Previsão de término

leadsAssetUrlstring

URL do arquivo de leads

messagestring

Mensagem da campanha

textRawstring

Texto bruto da mensagem

assetsUrlsstring[]

URLs dos anexos/arquivos

chunksCountnumber

Quantidade de chunks

secondsBetweenMessagesnumber

Segundos entre as mensagens

secondsBetweenChunksnumber

Segundos entre os chunks

chunkSizenumber

Tamanho do chunk

templateobject

Template da campanha

Response

idstring required
namestring required

Nome da campanha

channelIdstring

ID do canal

channelIdsstring[]

IDs dos canais

operatorIdstring

ID do operador

operatorNamestring

Nome do operador

businessHoursIdstring

ID do horário de atendimento

channelType'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Tipo do canal

leadType'lead' | 'file'

Tipo dos leads

normalizeBrazilPhoneNumbersboolean

Normaliza números brasileiros adicionando DDI 55 quando aplicável

scheduledTostring

Data de agendamento

nextScheduledTostring

Próxima data de agendamento

originalScheduledTostring

Data de agendamento original

finishedAtPredictionstring

Previsão de término

leadsAssetUrlstring

URL do arquivo de leads

messagestring

Mensagem da campanha

textRawstring

Texto bruto da mensagem

assetsUrlsstring[]

URLs dos anexos/arquivos

activeboolean

Indica se a campanha está ativa

shouldCreateConversationboolean

Indica se deve criar conversa

status'processing' | 'scheduled' | 'executing' | 'paused' | 'awaiting-chunk' | 'awaiting-business-hours' | 'awaiting-other-campaign' | 'canceled' | 'failed' | 'done' | 'done-sent'

Status da campanha

chunksCountnumber

Quantidade de chunks

leadsCountnumber

Quantidade de leads

secondsBetweenMessagesnumber

Segundos entre as mensagens

secondsBetweenChunksnumber

Segundos entre os chunks

trackAllChannelsboolean

Indica se deve rastrear todos os canais

trackMaxHoursnumber

Máximo de horas de rastreamento

chunkSizenumber

Tamanho do chunk

templateobject

Template da campanha

progressnumber

Progresso da campanha

messagesProcessednumber

Quantidade de mensagens processadas

lastMessageProcessedAtstring date-time

Data de processamento da última mensagem

Changes

No recorded changes to this operation across all 21 revisions of this API.