Inbuilt tool - check_hours

Back to Inbuilt tools The check_hours tool checks whether the contact center is currently within business hours.

When to use

Use check_hours before you transfer to a human agent, so you can offer a callback or a message outside business hours instead of sending the caller to an unstaffed queue. The tool requires Kore SmartAssist agent transfer to be configured for the project. If it is not configured, the call fails.

Declare the tool

TOOLS:
  check_hours(agentId: string, hoursId: string) -> boolean

Parameters

Parameter	Required	Description
`agentId`	Yes	The agent identifier.
`hoursId`	Yes	The ID of the business-hours configuration to check.

Returns

A boolean: true when the contact center is open, false when it is closed. Invalid input returns the error code INVALID_INPUT.

Example

FLOW:
  check_open:
    CALL:
      check_hours(agentId: "support_bot", hoursId: "weekday_hours")
    ON_RESULT:
      open: hand_to_human
      closed: after_hours_message

The ON_RESULT shape above is illustrative. Use the result-handling form that your flow already uses for boolean results.

Get started

Build

Test and evaluate

Deploy

Analytics and insights

References

Inbuilt tool - check_hours

When to use

Declare the tool

Parameters

Returns

Example

​When to use

​Declare the tool

​Parameters

​Returns

​Example

When to use

Declare the tool

Parameters

Returns

Example