Function Calling

Vapi voice assistants are given three additional functions: transferCall,endCall, and dialKeypad. These functions can be used to transfer calls, hang up calls, and enter digits on the keypad.

Transfer Call

When a forwardingPhoneNumber is present on an assistant, the assistant will be given a transferCall function. This function can be used to transfer the call to the forwardingPhoneNumber.

1
{
2
  "model": {
3
    "provider": "openai",
4
    "model": "gpt-3.5-turbo",
5
    "messages": [
6
      {
7
        "role": "system",
8
        "content": "You are an assistant at a law firm. When the user asks to be transferred, use the transferCall function."
9
      }
10
    ]
11
  },
12
  "forwardingPhoneNumber": "+16054440129"
13
}

End Call

This function is provided when endCallFunctionEnabled is enabled on the assistant. The assistant can use this function to end the call.

1
{
2
  "model": {
3
    "provider": "openai",
4
    "model": "gpt-3.5-turbo",
5
    "messages": [
6
      {
7
        "role": "system",
8
        "content": "You are an assistant at a law firm. If the user is being mean, use the endCall function."
9
      }
10
    ]
11
  },
12
  "endCallFunctionEnabled": true
13
}

Dial Keypad

This function is provided when dialKeypadFunctionEnabled is enabled on the assistant. The assistant will be able to enter digits on the keypad.

1
{
2
  "model": {
3
    "provider": "openai",
4
    "model": "gpt-3.5-turbo",
5
    "messages": [
6
      {
7
        "role": "system",
8
        "content": "You are an assistant at a law firm. When you hit a menu, use the dialKeypad function to enter the digits."
9
      }
10
    ]
11
  },
12
  "dialKeypadFunctionEnabled": true
13
}

Custom Functions

In addition to the predefined functions, you can also define custom functions. These functions are similar to OpenAI functions and your chosen LLM will trigger them as needed based on your instructions.

The functions array in the assistant definition allows you to define custom functions that the assistant can call during a conversation. Each function is an object with the following properties:

• name: The name of the function. It must be a string containing a-z, A-Z, 0-9, underscores, or dashes, with a maximum length of 64.
• description: A brief description of what the function does. This is used by the AI to decide when and how to call the function.
• parameters: An object that describes the parameters the function accepts. The type property should be “object”, and the properties property should be an object where each key is a parameter name and each value is an object describing the type and purpose of the parameter.

Here’s an example of a function definition:

1
{
2
  "functions": [
3
    {
4
      "name": "bookAppointment",
5
      "description": "Used to book the appointment.",
6
      "parameters": {
7
        "type": "object",
8
        "properties": {
9
          "datetime": {
10
            "type": "string",
11
            "description": "The date and time of the appointment in ISO format."
12
          }
13
        }
14
      }
15
    }
16
  ]
17
}

In this example, the bookAppointment function accepts one parameter, datetime, which is a string representing the date and time of the appointment in ISO format.

In addition to defining custom functions, you can specify a serverUrl where Vapi will send the function call information. This URL can be configured at the account level or at the assistant level. At the account level, the serverUrl is set in the Vapi Dashboard. All assistants under the account will use this URL by default for function calls. At the assistant level, the serverUrl can be specified in the assistant configuration when creating or updating an assistant. This allows different assistants to use different URLs for function calls. If a serverUrl is specified at the assistant level, it will override the account-level Server URL.

If the serverUrl is not defined either at the account level or the assistant level, the function call will simply be added to the chat history. This can be particularly useful when you want a function call to trigger an action on the frontend.

For instance, the frontend can listen for specific function calls in the chat history and respond by updating the user interface or performing other actions. This allows for a dynamic and interactive user experience, where the frontend can react to changes in the conversation in real time.