Skip to content

Commit c8b18cf

Browse files
fern-api[bot]fern-api[bot]
committed
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
2 parents f2a71af + 3086178 commit c8b18cf

File tree

3 files changed

+92
-1
lines changed

3 files changed

+92
-1
lines changed

‎fern/changelog/2025-02-27.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Phone Keypad Input Support, OAuth2 and Analytics Improvements
2+
3+
1. **Keypad Input Support for Phone Calls:** A new [`keypadInputPlan`](https://api.vapi.ai/api#:~:text=KeypadInputPlan) feature has been added to enable handling of DTMF (touch-tone) keypad inputs during phone calls. This allows your voice assistant to collect numeric input from callers, like account numbers, menu selections, or confirmation codes.
4+
5+
Configuration options:
6+
```json
7+
{
8+
"keypadInputPlan": {
9+
"enabled": true, // Default: false
10+
"delimiters": "#", // Options: "#", "*", or "" (empty string)
11+
"timeoutSeconds": 2 // Range: 0.5-10 seconds, Default: 2
12+
}
13+
}
14+
```
15+
16+
The feature can be configured in:
17+
- `assistant.keypadInputPlan`
18+
- `call.squad.members.assistant.keypadInputPlan`
19+
- `call.squad.members.assistantOverrides.keypadInputPlan`
20+
21+
2. **OAuth2 Authentication Enhancement:** The [`OAuth2AuthenticationPlan`](https://api.vapi.ai/api#:~:text=OAuth2AuthenticationPlan) now includes a `scope` property to specify access scopes when authenticating. This allows more granular control over permissions when integrating with OAuth2-based services.
22+
23+
```json
24+
{
25+
"credentials": [
26+
{
27+
"authenticationPlan": {
28+
"type": "oauth2",
29+
"url": "https://example.com/oauth2/token",
30+
"clientId": "your-client-id",
31+
"clientSecret": "your-client-secret",
32+
"scope": "read:data" // New property, max length: 1000 characters
33+
}
34+
}
35+
]
36+
}
37+
```
38+
39+
The scope property can be configured at:
40+
- `assistant.credentials.authenticationPlan`
41+
- `call.squad.members.assistant.credentials.authenticationPlan`
42+
43+
3. **New Analytics Metric: Minutes Used** The [`AnalyticsOperation`](https://api.vapi.ai/api#:~:text=AnalyticsOperation) schema now includes a new column option: `minutesUsed`. This metric allows you to track and analyze the duration of calls in your usage reports and analytics dashboards.
44+
45+
46+
4. **Removed TrieveKnowledgeBaseCreate Schema:** Removed `TrieveKnowledgeBaseCreate` schema from
47+
- `TrieveKnowledgeBase.createPlan`
48+
- `CreateTrieveKnowledgeBaseDTO.createPlan`
49+
- `UpdateTrieveKnowledgeBaseDTO.createPlan`

‎fern/docs.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,8 +423,10 @@ navigation:
423423
path: providers/observability/langfuse.mdx
424424
- page: Voiceflow
425425
path: providers/voiceflow.mdx
426-
- section: Privacy & Terms of Service
426+
- section: Legal
427427
contents:
428+
- page: TCPA Consent Guidelines
429+
path: tcpa-consent.mdx
428430
- link: Privacy Policy
429431
href: https://vapi.ai/privacy
430432
- link: Terms of Service

‎fern/tcpa-consent.mdx‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: TCPA Consent Guide
3+
subtitle: Understanding consent requirements for outbound calls using Vapi's voice agent service.
4+
slug: tcpa-consent
5+
---
6+
7+
This guide details the consent requirements under the Telephone Consumer Protection Act (TCPA) for callers using Vapi's voice agent service to make outbound telephone calls.
8+
9+
<Note>
10+
The TCPA does **not** apply to **inbound** telephone calls.
11+
</Note>
12+
13+
### Types of Consent Required
14+
15+
The type of consent required depends on whether the call is **marketing** or **non-marketing**:
16+
17+
| **Message Type** | **Consent Required** | **Consent Requirements** | **Sample Consent Disclosure Language** |
18+
|--------------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19+
| **Marketing** | **Prior Express Written Consent (PEWC)** | 1. **Signed *written* agreement** from the recipient; **AND**<br /><br />2. **Clear and conspicuous disclosure** that:<br />&nbsp;&nbsp;&nbsp;&nbsp;(A) The consumer agrees to receive calls using artificial or prerecorded voice from the caller at the number(s) provided; **AND**<br />&nbsp;&nbsp;&nbsp;&nbsp;(B) The consumer’s consent is **not** a condition for purchasing goods or services from [Company]. | By [signing below/checking this box/clicking "I Accept"], I consent to receive **marketing** calls from and on behalf of [Company] and its affiliates, including calls made using an artificial or prerecorded voice, an automated telephone dialing system, or automated texting system. Calls and texts may be generated from computers or from persons. [Company]. |
20+
| **Non-Marketing** | **Prior Express Consent (PEC)** | The TCPA does not define PEC. However, the FCC has stated that non-marketing calls can form PEC for any phone number that is related to the transaction between the caller and consumer.<br /><br />Therefore, an express and obvious consent is sufficient. | By [signing below/checking this box/clicking "I Accept"], I consent to receive **non-marketing** calls from and on behalf of [Company] and its affiliates, including calls made using an artificial or prerecorded voice or an automated telephone dialing system (note that I have provided the phone number(s) that I would like to receive these calls). |
21+
22+
<Note>
23+
\*The signature may comply with the E-SIGN Act (*e.g.*, email, website form, telephone keypress, text message, voice recording).
24+
</Note>
25+
26+
### Understanding "Marketing"
27+
28+
**"Marketing"** is interpreted broadly to include calls that:
29+
* Encourage the purchase or rental of (or investment in) property, goods, or services
30+
* Advertise the commercial availability or quality of any property, goods, or services
31+
32+
### Important Consent Guidelines
33+
34+
When providing consent, a consumer **must affirmatively opt in**. A pre-checked box next to consent disclosure language does **not** qualify as providing consent.
35+
36+
**A consumer may revoke consent at any time through any reasonable means** (*e.g.*, using a telephone keypress, speaking with a representative, selecting preferences via an online portal), so callers should provide a clear procedure for consumers to opt-out and honor their opt-out requests.
37+
38+
<Warning>
39+
**Remaining Questions?** This consent guide does not constitute legal advice and does not cover other telemarketing laws that may apply (*e.g.*, federal Do-Not-Call (DNC) rules, state law). If you have further questions, please speak with an attorney who specializes in telemarketing compliance.
40+
</Warning>

0 commit comments

Comments
 (0)