Function Call Request

Request to call a function by sending a Function Call Request message.

Voice Agent

What is The FunctionCallRequest Message

The FunctionCallRequest message is used to call a function from the server to the client.

Receiving FunctionCallRequest

If a function is client-side and no URL is provided for that function in the Settings Configuration then the server will request to call the function by sending the client a FunctionCallRequest message. Upon receiving this message, the client should perform the requested function call and reply with a Function Call Response containing the function’s output.

JSON
1{
2  "type": "FunctionCallRequest",
3  "function_name": "", // The `name` you gave in the function definition
4  "function_call_id": "", // ID to be passed back in the `FunctionCallResponse`
5  "input": {...} // A JSON value containing the `parameters` you defined for this function
6}

Conclusion

When a function is client-side and no URL is provided in the Settings Configuration, the server will trigger the function call by sending a FunctionCallRequest message. The client is then responsible for executing the function and responding with a Function Call Response containing the function’s result.

Built with