Skip to content
Assistants · Object

The CallRetryConfig object

When and how often a call is dialed: the calling windows and allowed days, the delay between two attempts and the maximum number of attempts. Omitted in a request: the default of each field.

Fields

  • calling_windowsarray of object

    Daily time windows in which calls may be placed, on the allowed_days. A call due outside every window waits for the next one to open. Request bodies need at least one window.

  • max_retry_attemptsinteger

    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.

    Default 5> 0

  • allowed_daysarray of enum (7 values)

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

    Possible values"monday""tuesday""wednesday""thursday""friday""saturday""sunday"

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

  • excluded_datesarray of string (date)optional

    Calendar dates on which no call goes out, such as public holidays or days the office is closed, as 'YYYY-MM-DD' (e.g. ['2026-12-25', '2027-01-01']). Read in the same timezone as the calling windows: each callee's local date when timezone is null. A call or retry that would land on an excluded date waits for the next open window after it. Up to 366 dates; duplicates are removed and the list is sorted. A call placed with skip_calling_window ignores them for its first dial only. Default: none.

    at most 366 items

  • call_twice_in_a_rowboolean

    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