TRtrytoku
Campaigns

Crear Campaign programada

Changed on

Crea una campaña y agenda un envío por cada fecha indicada en outbound_dates.

Se usa para programar el contacto masivo de una cobranza. La campaña queda vacía: las deudas (Invoices) a contactar se asocian después con POST /campaigns/invoices.

De cada fecha solo se toma el día; la hora de envío la fija Toku según el país de la organización, y las fechas que quedan repetidas tras ese ajuste se descartan. Si una fecha es hoy y su hora de envío ya pasó o queda dentro de todays_outbound_delay_in_minutes, el envío se agenda ese margen de minutos más adelante, o al día siguiente si con eso se alcanza la hora de corte del país. Cuando una fecha pedida para hoy termina agendada para otro día, la respuesta trae is_scheduled_for_tomorrow en true.

La campaña se rechaza si alguna fecha ajustada cae en un feriado del país.

post/campaigns

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/campaigns
  • Auth
    API key in header x-api-key

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

intentionstring

Identificador público de la Intention que define el mensaje a enviar. Se entrega intention o sequence, nunca ambos.

is_weeklyboolean

Cuando es true se omite el aviso de carga de pagos; en caso contrario se intenta agendar 25 horas antes de cada envío, si ese momento no pasó aún.

namestring required

Nombre con el que se identifica la campaña dentro de la aplicación.

outbound_datesstring[]

Fechas en las que se envía el contacto masivo. Se aceptan hasta 28 fechas, y cada una debe estar en el futuro y dentro de los próximos 56 días.

sequencestring

Identificador público de la Sequence que define los recordatorios a enviar. Se entrega intention o sequence, nunca ambos.

todays_outbound_delay_in_minutesinteger

Minutos de espera antes de enviar cuando una de las fechas es hoy y su hora de envío ya pasó o queda dentro de este margen. Si al sumarlos se alcanza la hora de corte del país, el envío se agenda para el día siguiente.

Example request

{
  "intention": "cin_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "name": "Campaña Nov. Recordatorio",
  "outbound_dates": [
    "2021-08-16T19:20:30-04:00",
    "2021-08-25T19:20:30-04:00"
  ],
  "sequence": "seq_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T"
}

Response

La campaña fue creada y sus envíos quedaron agendados.

id_campaignstring required

Identificador público de la campaña creada. Se necesita para asociarle deudas o Customers, y para editarla o archivarla más adelante.

is_scheduled_for_tomorrowboolean required

true cuando alguna de las fechas pedidas era hoy y, tras aplicar la hora de envío y la hora de corte del país, ninguna quedó agendada para hoy.

messagestring required

Descripción legible del resultado de la operación.

Example response

{
  "id_campaign": "cam_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "message": "Associations made succesfully"
}

Changes