Skip to content

Commit 26b362e

Browse files
committed
feat: update DTMF docs
1 parent 24d6701 commit 26b362e

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

fern/tools/default-tools.mdx

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ This function is provided when `sms` is included in the assistant's list of avai
9494
#### Dial Keypad (DTMF)
9595

9696
This function is provided when `dtmf` is included in the assistant's list of available tools (see configuration options [here](/api-reference/assistants/create#request.body.model.openai.tools.dtmf)). The assistant will be able to enter digits on the keypad.
97+
Useful for IVR navigation or data entry.
9798

9899
```json
99100
{
@@ -122,31 +123,10 @@ There are three methods for sending DTMF in a phone call:
122123
3. **Out-of-band via SIP INFO messages**: tones are sent as separate SIP INFO messages. While this can be more reliable than in-band DTMF, it's not as widely supported as the RFC 2833 method.
123124

124125
<Note>
125-
Vapi's DTMF tool uses in-band method. Please note that this method may not work with certain IVRs. If you are running into this issue, the recommended approach is to have your assistant say the options out loud if available. For example, when an IVR says "Press 1 or say Sales for the Sales department," prefer having the assistant say "Sales."
126+
Vapi's DTMF tool integrates with telephony provider APIs to send DTMF tones using the out-of-band RFC 2833 method. This approach is widely supported and more reliable for transmitting the signals, especially in VoIP environments.
127+
Note, the tool's effectiveness depends on the IVR system's configuration and their capturing method. If you are running into issues, try different telephony providers or have your assistant say the options out loud if available.
126128
</Note>
127129

128-
##### Tool Effectiveness
129-
130-
To evaluate this tool, we set up a Vapi assistant with the DTMF tool enabled and conducted calls to a range of IVR systems, including a Twilio IVR (configured via Studio Flows) and several third-party IVRs such as pharmacies and insurance companies.
131-
132-
**Testing Methodology**
133-
134-
We called and navigated through the IVRs using three different strategies:
135-
136-
1. **Direct Dialpad**: calling from a personal phone and dialing options using the dialpad.
137-
2. **Vapi DTMF Tool**: an assistant configured with the DTMF tool.
138-
3. **Manual DTMF Sound**: calling from a personal phone and playing DTMF tones generated by software. _(similar approach as the Vapi DTMF Tool)_
139-
140-
**Key Findings**
141-
142-
- The assistant successfully navigated some of the third-party IVRs.
143-
- The assistant encountered issues with Twilio IVRs, likely due to Twilio's preference for RFC 2833.
144-
- Observed occasional delays in DTMF tone transmission, which may affect effectiveness with IVRs that have short timeouts.
145-
146-
**Conclusion**
147-
148-
The tool's effectiveness depends on the IVR system's configuration and DTMF capturing method. We are working to improve compatibility and reduce transmission delays for broader and more reliable support.
149-
150130
#### API Request
151131

152132
This tool allows your assistant to make HTTP requests to any external API endpoint during conversations. This tool fills the gap between Vapi and your existing business logic, bringing your own endpoints into the conversation flow.

0 commit comments

Comments
 (0)