Demo Tools

This topic provides three ready-to-use demo tools to help you quickly test the Tool feature.

Important: The provided tools are for testing purposes only. They call a public mock API (jsonplaceholder.typicode.com) and do not interact with real business data. Do NOT use them in production environments.

Note: You can add these tools to your PBX via either of the following methods:

Copy the JSON configuration and past it into the JSON editor of a tool. For more information, see Add a Tool Manually.
Download the JSON file, then directly import it to the PBX. For more information, see Add a Tool via File Upload.

Tool 1: Query order

Use case: Use this tool when a caller wants to check the status of a specific order.
Example request: Caller asks the AI receptionist "Can you check the status of order 5?"

JSON configuration (Download the JSON file for test)

{
    "basic": {
        "name": "query_order",
        "description": "Use this tool when customer asks to 'query order', 'check order status', or 'get order details'. Extract the numeric order_id from conversation (e.g., 'order 3' → order_id=3).",
        "method": "GET",
        "url": "https://jsonplaceholder.typicode.com/posts/{order_id}",
        "remark": "Demo - Query order by ID"
    },
    "response_settings": {
        "disable_interruptions": false,
        "force_pre_tool_speech": true,
        "execution_mode": "immediate",
        "tool_call_sound": "Typing",
        "sound_behavior": "always_play",
        "response_timeout": 20
    },
    "path_params": [
        {
            "parameter": "order_id",
            "data_type": "Integer",
            "value_logic": "llm",
            "description": "Extract order ID from customer request, e.g., 'order 3' → 3"
        }
    ],
    "headers": [
        {
            "parameter": "Accept",
            "value": "application/json"
        }
    ],
    "query_params": [],
    "body_description": "",
    "body_params": []
}

Tool 2: Get orders by user

Use case: Use this tool when a caller wants to see all his/her orders.
Example request: Caller asks the AI receptionist "Show me all my recent orders. My account ID is 1."

JSON configuration (Download the JSON file for test)

{
    "basic": {
        "name": "get_orders_by_user",
        "description": "Use this tool when customer asks to 'list my orders', 'show my posts', or 'what are my recent requests'. Extract userId from conversation.",
        "method": "GET",
        "url": "https://jsonplaceholder.typicode.com/posts",
        "remark": "Demo - Query orders by user ID"
    },
    "response_settings": {
        "disable_interruptions": false,
        "force_pre_tool_speech": true,
        "execution_mode": "immediate",
        "tool_call_sound": "Typing",
        "sound_behavior": "always_play",
        "response_timeout": 20
    },
    "path_params": [],
     "headers": [
        {
            "parameter": "Accept",
            "value": "application/json"
        }
    ],
    "query_params": [
        {
            "parameter": "userId",
            "required": true,
            "data_type": "Integer",
            "value_logic": "llm",
            "description": "Extract user ID from conversation, e.g., 'my user ID is 1' → 1"
        }
    ],
    "body_description": "",
    "body_params": []
}

Tool 3: Create order

Use case: Use this tool when a caller wants to report an issue or create a support ticket.
Example request: Caller asks the AI receptionist "I need to report an issue. My package arrived damaged and I'd like a refund."

JSON configuration (Download the JSON file for test)

{
    "basic": {
        "name": "create_order",
        "description": "Use this tool when customer wants to create a ticket, submit a request, or report an issue. Extract the title (short summary) and body (detailed description) from the conversation.",
        "method": "POST",
        "url": "https://jsonplaceholder.typicode.com/posts",
        "remark": "Demo - Create an order/ticket"
    },
    "response_settings": {
        "disable_interruptions": false,
        "force_pre_tool_speech": false,
        "execution_mode": "immediate",
        "tool_call_sound": "Typing",
        "sound_behavior": "always_play",
        "response_timeout": 20
    },
    "path_params": [],
    "headers": [
        {
            "parameter": "Content-Type",
            "value": "application/json"
        }
    ],
    "query_params": [],
    "body_description": "Extract request information from customer conversation.",
    "body_params": [
        {
            "parameter": "title",
            "required": true,
            "data_type": "String",
            "value_logic": "llm",
            "description": "Extract a short title/summary of the issue from conversation. Keep it under 10 words.",
            "optional_values": []
        },
        {
            "parameter": "body",
            "required": true,
            "data_type": "String",
            "value_logic": "llm",
            "description": "Extract the full description of the issue from conversation, including all details mentioned by customer.",
            "optional_values": []
        },
        {
            "parameter": "userId",
            "required": true,
            "data_type": "Integer",
            "value_logic": "constant",
            "constant_value": "1"
        }
    ]
}