CallRetryConfig

Fields

• timezonestringnullable

  IANA timezone in which the calling windows and allowed days are evaluated, for every callee. Examples: 'Europe/Paris', 'America/New_York'. Null or omitted (the default): each callee's own timezone, derived from the country of their phone number (a French number → Europe/Paris, a UK number → Europe/London, a US number → America/Chicago). One timezone per country, so all US numbers share that one: set a timezone to call them on another. The agent also uses this timezone for the dates and times it talks about during the call.

• calling_windowsarray of objectrequired
  Show 3 fieldsHide 3 fields

  • calling_window_start_timestringrequired

    Start time of the calling window, in timezone (each callee's own timezone when it is null). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

  • calling_window_end_timestringrequired

    End time of the calling window, in timezone (each callee's own timezone when it is null). Must be after the start time: a window cannot span midnight. Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

  • retry_delay_secondsanyrequired

    Delay between retry attempts in seconds. Values below the 15-minute minimum are raised to it: a shorter delay means calling someone again minutes after they declined. For one deliberate immediate second dial, use call_twice_in_a_row. Default: 7200 (2 hours).

• max_retry_attemptsintegerrequired

  Maximum number of call attempts, first call included. Default: 5. Capped by the organization's plan: 5 on Starter, 8 on Business. A contact nobody picks up is billed once all its attempts were placed.

  max 9007199254740991 · > 0Default 5

• allowed_daysarray of enum (string)required

  Days of the week when calls are allowed, in the same timezone as the calling windows. Default: Monday through Friday.

  Default ["monday","tuesday","wednesday","thursday","friday"]

• call_twice_in_a_rowbooleanrequired

  Double call. If true and max_retry_attempts >= 2, when the first attempt reaches nobody (no answer, declined, voicemail, call screening nobody took), the second attempt is dialed within seconds instead of after retry_delay_seconds, from the same caller number. Two calls in a row from one number raise the pickup rate. Each call is an attempt: the double call counts as 2 when both calls happen, 1 when the first is picked up. Busy or unreachable phones are retried after the normal delay. Calling days and hours still apply. Only the first attempt is doubled; later ones follow retry_delay_seconds. A voicemail_message is left on the second dial only. Default: false.

  Default false