Create Scheduler

Notes

`label`

Name/Label for the scheduler.

`timezone`

A valid timezone string. Default timezone is EST5EDT.

`business_hours`

An object with business hours options.

business_hours_service_type - Routes call to a particular service type during business hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
business_hours_service_id - Service type id for the business hours service type
after_hours_service_type - Routes call to a particular service type during after hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
after_hours_service_id - Service type id for the after hours service type
lunch_hours_service_type - Routes call to a particular service type during lunch hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
lunch_hours_service_id - Service type id for the lunch hours service type
monday, tuesday, wednesday, thursday, friday, saturday, sunday - For weekdays it requires business open and close time. Lunch start and end times are optional.

`holiday_hours`

holiday_hours_service_type - Routes call to a particular service type during holiday hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
holiday_hours_service_id - Service type id for the holiday hours service type
holidays - Array of the holiday object.
- holiday_name - Name/Label for the holiday.
- holiday_type - A public holiday or a custom holiday. Custom holiday will require start and end time.
- custom_holiday_start - Custom holiday start time in MM-DD HH:mm format.
- custom_holiday_end - Custom holiday end time in MM-DD HH:mm format.

`override_mode`

Override mode option can be used to override all other settings. Available modes are Scheduler, OfficeHours, AfterHours, Lunch and Holiday.

`override_extension`

1 to 6 digit extension to change override mode.

Sample Response

{
  "scheduler": {
    "id": "TOD8364363011",
    "label": "Scheduler 1",
    "timezone": "EST5EDT",
    "business_hours": {
        "business_hours_service_type": "Hangup",
        "business_hours_service_id": "Hangup",
        "after_hours_service_type": "Hangup",
        "after_hours_service_id": "Hangup",
        "lunch_hours_service_type": "Hangup",
        "lunch_hours_service_id": "Hangup",
        "monday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "tuesday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "wednesday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "thursday": {
            "business_open": "09:00",
            "business_close": "17:00",
            "lunch_start": "13:00",
            "lunch_end": "14:00"
        },
        "friday": {
            "business_open": "09:00",
            "business_close": "13:00",
            "lunch_start": "11:00",
            "lunch_end": "12:00"
        },
        "saturday": {
            "business_open": "00:00",
            "business_close": "00:00",
            "lunch_start": "00:00",
            "lunch_end": "00:00"
        },
        "sunday": {
            "business_open": "00:00",
            "business_close": "00:00",
            "lunch_start": "00:00",
            "lunch_end": "00:00"
        }
    },
    "holiday_hours": {
        "holiday_hours_service_type": "Phonenumber",
        "holiday_hours_service_id": "3214991000",
        "holidays": [
            {
                "holiday_name": "Holiday1",
                "holiday_type": "New Years Day",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday2",
                "holiday_type": "Martin Luther King Birthday",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday3",
                "holiday_type": "Independence Day",
                "custom_holiday_start": "",
                "custom_holiday_end": ""
            },
            {
                "holiday_name": "Holiday4",
                "holiday_type": "Custom",
                "custom_holiday_start": "01-01 00:00",
                "custom_holiday_end": "01-02 00:00"
            }
        ]
    },
    "override_mode": "Scheduler",
    "override_extension": ""
	}
}

Response Properties

Property	Type	Description
id	string	Scheduler ID
label	string	Name/Label for Scheduler
timezone	string	Timezone for the Scheduler. Default is EST5EDT.
business_hours	object	Business hours setting object
holiday_hours	object	Holiday hours setting object
override_mode	string	Override mode can be Scheduler, OfficeHours, AfterHours, Lunch or Holiday. Default is Scheduler.
override_extension	string	Extension to call to change override mode

`business_hours` object

Property	Type	Description
business_hours_service_type	string	Business hours service type
business_hours_service_id	string	Business hours service id
after_hours_service_type	string	After hours service type
after_hours_service_id	string	After hours service id
lunch_hours_service_type	string	Lunch hours service type
lunch_hours_service_id	string	Lunch hours service id
monday	object	`weekday` object
tuesday	object	`weekday` object
wednesday	object	`weekday` object
thursday	object	`weekday` object
friday	object	`weekday` object
saturday	object	`weekday` object
sunday	object	`weekday` object

`holiday_hours` object

Property	Type	Description
holiday_hours_service_type	string	holiday hours service type
holiday_hours_service_id	string	holiday hours service id
holidays	array	Array of `holiday` object

`weekday` object

Property	Type	Description
business_open	string	Business open time in HH:mm format
business_close	string	Business close time in HH:mm format
lunch_start	string	Lunch start time in HH:mm format
lunch_end	string	Lunch close time in HH:mm format

`holiday` object

Property	Type	Description
holiday_name	string	Holiday label/name
holiday_type	string	Holiday type can be Custom or a Public Holiday supported by FracTEL
custom_holiday_start	string	Start date in MM-DD HH:mm format
custom_holiday_end	string	End date in MM-DD HH:mm format

Notes

label

timezone

business_hours

holiday_hours

override_mode

override_extension