|
| 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` |
0 commit comments