Tool Overview
The Tool feature enables your AI receptionist to interact with third-party systems by calling external APIs during conversations (e.g., checking order status or booking appointments). You can define a set of custom tools and assign them to the AI receptionist. During a call, the AI receptionist will automatically trigger the appropriate tool based on the conversation, construct and send an HTTP request to the API endpoint pre-defined in the tool, so as to retrieve real-time data or perform a specified action on third-party systems.
Requirements
The firmware version of Yeastar P-Series Cloud Edition is 84.23.0.123 or later.
Limitations
- The PBX supports a maximum of 100 custom tools.
- For external API calls, custom tools only support statically configured
credentials (e.g., API Key, Basic Authentication, Static Bearer Token) or
public APIs with no authentication.Note: Dynamic authentication (e.g., OAuth 2.0) is not supported, as it requires dynamic token acquisition and cannot be pre-configured.
Methods to add tools
You can add custom tools using either of the following methods:
| Method | Description |
|---|---|
| Manual configuration | Manually fill in all tool settings, including basic
information, execution rules, and request parameters, on the PBX
web portal. This method is suitable for single tool setup or testing. For more information, see Add a Tool Manually. |
| JSON file upload | Upload one or multiple JSON files to quickly add tools, with
each file containing the complete configuration of a custom
tool. The system automatically parses the file and creates the
tool upon successful upload. This method is suitable for batch configuration or backup and restore of tools. For more information, see Add a Tool via File Upload. |