Inbuilt tool - check_availability

Back to Inbuilt tools The check_availability tool checks whether a human agent is available to take the conversation.

When to use

Use check_availability before transfer_to_agent to confirm that an agent with the right skills or queue is online. If none is available, offer a callback or keep the caller with the AI agent. 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_availability(
      agentId: string,
      contactId: string,
      tenantId: string,
      projectId: string,
      skills?: string[],
      queue?: string,
      language?: string
  ) -> boolean

Parameters

Parameter	Required	Description
`agentId`	Yes	The agent identifier.
`contactId`	Yes	The contact (caller or user) identifier.
`tenantId`	Yes	The tenant identifier.
`projectId`	Yes	The project identifier.
`skills`	No	Skills the human agent must have.
`queue`	No	Queue to check.
`language`	No	Language the human agent must support.

Returns

A boolean: true when a matching agent is available, false otherwise. Invalid input returns the error code INVALID_INPUT.

Get started

Build

Test and evaluate

Deploy

Analytics and insights

References

Inbuilt tool - check_availability

When to use

Declare the tool

Parameters

Returns

​When to use

​Declare the tool

​Parameters

​Returns

When to use

Declare the tool

Parameters

Returns