Call Scheduling

Control when calls are made using scheduling options and calling hours

Introduction

Kejue automatically determines the timezone for each lead based on their phone number, ensuring calls are made at appropriate times according to the lead's local time.

Scheduling Individual Calls

Use the schedule_at field to schedule a call for future execution:

{
  "call": {
    "schedule_at": "2024-01-15T14:30:00Z"
  }
}

The schedule_at value should be in ISO 8601 format (UTC). The system will convert this to the lead's local timezone automatically.

If schedule_at is not provided, the call will be made immediately (subject to calling hours and day selection restrictions).

Scheduling Campaigns

For campaigns, use start_at_iso to specify when campaign execution begins:

{
  "schedule": {
    "start_at_iso": "2024-01-15T09:00:00Z"
  }
}

If start_at_iso is not provided, the campaign starts immediately (subject to calling hours and day selection restrictions).

Calling Hours

Control when calls can be made using call_start_hour and call_end_hour. These values are interpreted in the lead's local timezone, which is automatically derived from their phone number.

FieldTypeRangeDescription
call_start_hourinteger0-24Start hour for calling in lead's local timezone
call_end_hourinteger0-24End hour for calling in lead's local timezone

The timezone is automatically determined from the lead's phone number. You don't need to specify it manually - Kejue handles timezone conversion for you.

Example: If you set call_start_hour: 9 and call_end_hour: 17, calls will only be made between 9 AM and 5 PM in each lead's local timezone. A lead in New York (EST) will be called during EST business hours, while a lead in London (GMT) will be called during GMT business hours.

Default Settings

If call_start_hour and call_end_hour are not specified, Kejue uses the default calling hours configured in the Calls page in your Settings. You can set these defaults once and they'll apply to all calls unless overridden.

Examples

Schedule a Call for Later Today

{
  "lead_id": 123,
  "call": {
    "schedule_at": "2024-01-15T14:30:00Z",
    "call_start_hour": 9,
    "call_end_hour": 17
  }
}

Campaign Starting Tomorrow Morning

{
  "schedule": {
    "name": "Morning Campaign",
    "start_at_iso": "2024-01-16T09:00:00Z",
    "call_start_hour": 9,
    "call_end_hour": 12
  }
}

Use Default Calling Hours

{
  "call": {
    "schedule_at": "2024-01-15T14:30:00Z"
  }
}

In this example, the default calling hours from Settings will be used.

  • Day Selection - Control which days calls can be made
  • Calls - Learn about creating individual calls
  • Campaigns - Learn about batch campaigns

API Reference

Last updated on