diff --git a/fern/assistants/call-recording.mdx b/fern/assistants/call-recording.mdx index 897ff87f..16c21536 100644 --- a/fern/assistants/call-recording.mdx +++ b/fern/assistants/call-recording.mdx @@ -1,50 +1,200 @@ --- title: Call recording -subtitle: Record and store calls in Vapi or your own storage -slug: call-recording +subtitle: Record and store calls for analysis and training +slug: assistants/call-recording +description: Learn how to record calls and store them for quality assurance and analysis --- -The Call Recording feature allows you to capture and store full recordings of phone calls for analysis. By default, Vapi stores a complete recording of every call, providing both mono and stereo audio. The stereo option separates human and assistant audio into two distinct channels, offering a clearer analysis of the conversation. - -You can customize this behavior in the assistant's [`assistant.artifactPlan`](/api-reference/assistants/create#request.body.artifactPlan). - -## Recording Formats - -Vapi supports multiple recording formats to fit your storage and playback needs. - -You can specify your preferred format using the [`assistant.artifactPlan.recordingFormat`](/api-reference/assistants/create#request.body.artifactPlan.recordingFormat) property. If not specified, recordings will default to `wav;l16`. - -**Supported formats:** -- `wav;l16` (default) - High quality linear PCM -- `mp3` - Compressed format for smaller file sizes -- `flac` - Lossless compression for archival +## Overview + +Vapi provides comprehensive call recording capabilities that allow you to capture, store, and analyze voice conversations for quality assurance, training, and compliance purposes. + +**Call recording enables you to:** +- Monitor conversation quality and assistant performance +- Train and improve your voice AI models +- Ensure compliance with regulatory requirements +- Analyze customer interactions for insights + +## Recording Configuration + +### Enable Recording + +You can enable call recording at the assistant level or per individual call: + + +```json title="Assistant Configuration" +{ + "name": "Customer Support Assistant", + "recordingEnabled": true, + "model": { + "provider": "openai", + "model": "gpt-4" + }, + "voice": { + "provider": "11labs", + "voiceId": "harry" + } +} +``` + +```json title="Per-Call Configuration" +{ + "assistant": { + "name": "Support Agent" + }, + "recordingEnabled": true, + "phoneNumberId": "your-phone-number-id" +} +``` + + +### Recording Options + +Configure recording behavior with these options: + +- **`recordingEnabled`**: Enable or disable recording for this assistant/call +- **`recordingChannelCount`**: Number of audio channels to record (1 for mono, 2 for stereo) +- **`recordingFormat`**: Audio format for recordings (mp3, wav, etc.) ## Storage Options -Vapi supports uploading recordings to your own storage buckets. See [Integrations -> Cloud](/providers/cloud/s3) for more information on available storage options. - -**Supported cloud storage providers:** -- AWS S3 -- Google Cloud Storage -- Cloudflare R2 -- Supabase - -## Configuration Options +### Default Storage -### Enable/Disable Recording +By default, Vapi stores recordings securely in the cloud: -You can turn on/off call recording by setting the [`assistant.artifactPlan.recordingEnabled`](/api-reference/assistants/create#request.body.artifactPlan.recordingEnabled) property to `true` or `false`. If not specified, recordings will default to `true`. +- Recordings are encrypted at rest and in transit +- Access is controlled through your API credentials +- Recordings are automatically cleaned up based on your retention policy -**HIPAA Compliance:** If [HIPAA](/security-and-privacy/hipaa) mode is enabled, Vapi will only store recordings if you have defined a custom storage bucket. Make sure to set credentials in the Provider Credentials section of your dashboard. +### Custom Storage -### Video Recording +For advanced use cases, you can configure custom storage: -You can turn on/off video recording by setting the [`assistant.artifactPlan.videoRecordingEnabled`](/api-reference/assistants/create#request.body.artifactPlan.videoRecordingEnabled) property to `true` or `false`. If not specified, video recording will default to `false`. + +```json title="S3 Storage Configuration" +{ + "recordingEnabled": true, + "recordingPath": "https://your-bucket.s3.amazonaws.com/recordings/", + "recordingCredentials": { + "provider": "aws", + "region": "us-east-1", + "accessKeyId": "your-access-key", + "secretAccessKey": "your-secret-key" + } +} +``` -## Upload Path +```json title="Google Cloud Storage" +{ + "recordingEnabled": true, + "recordingPath": "gs://your-bucket/recordings/", + "recordingCredentials": { + "provider": "gcp", + "serviceAccountKey": "your-service-account-json" + } +} +``` + + +## Accessing Recordings + +### Via Dashboard + +1. Navigate to **Calls** in your Vapi dashboard +2. Select a specific call from the list +3. Click on the **Recording** tab to play or download the audio + +### Via API + +Retrieve recording URLs programmatically: + +```typescript +import { VapiClient } from "@vapi-ai/server-sdk"; + +const client = new VapiClient({ token: "your-api-key" }); + +// Get call details including recording URL +const call = await client.calls.get("call-id"); +console.log("Recording URL:", call.recordingUrl); +``` + +## Privacy and Compliance + +### Legal Considerations + +**Important**: Call recording laws vary by jurisdiction. Ensure compliance with: + +- **Consent requirements** - Inform participants about recording +- **Data protection** regulations (GDPR, CCPA, etc.) +- **Industry standards** (PCI DSS, HIPAA, etc.) + +### Best Practices + +- **Inform callers** about recording at the start of conversations +- **Secure storage** with encryption and access controls +- **Retention policies** to automatically delete old recordings +- **Access logs** to track who accesses recordings + + + Always comply with local laws regarding call recording. Some jurisdictions require explicit consent from all parties before recording. + + +## Recording Analysis + +### Transcription + +Recorded calls are automatically transcribed for analysis: + +```json +{ + "callId": "call-123", + "transcript": [ + { + "role": "assistant", + "message": "Hello! How can I help you today?", + "time": 0.5 + }, + { + "role": "user", + "message": "I need help with my account", + "time": 3.2 + } + ], + "recordingUrl": "https://api.vapi.ai/recordings/call-123.mp3" +} +``` + +### Call Analysis + +Use recorded data for insights: + +- **Conversation flow** analysis +- **Response quality** evaluation +- **Customer satisfaction** metrics +- **Assistant performance** tracking + +## FAQ + + + + Yes, all recordings are automatically transcribed and available through the API and dashboard. + + + + Default retention is 30 days. You can configure custom retention policies for your account. + + + + Yes, you can enable/disable recording at both the assistant level and per individual call. + + + + Call recording is available in all supported Vapi regions with local data residency options. + + -When uploading recordings to your custom storage bucket, you can specify the upload path using the `assistant.artifactPlan.recordingPath` property. If not specified, recordings will default to the root of the bucket. +## Next Steps -Usage: -- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`. -- If you want to upload the recording to the root of the bucket, set this to `/`. +- **[Call Analysis](/assistants/call-analysis)** - Analyze recorded conversations for insights +- **[Privacy Compliance](/security-and-privacy/GDPR)** - Ensure GDPR and privacy compliance +- **[API Reference](/api-reference/calls/create)** - Explore recording configuration options diff --git a/fern/docs.yml b/fern/docs.yml index d0846bb9..1cfb4f0c 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -286,8 +286,8 @@ navigation: - section: Telephony integrations icon: fa-light fa-link contents: - - page: Twillio - path: phone-numbers/import-twillio.mdx + - page: Twilio + path: phone-numbers/import-twilio.mdx - page: Telnyx path: phone-numbers/telnyx.mdx - section: SIP integration @@ -837,7 +837,7 @@ redirects: - source: /introduction destination: /quickstart - source: /welcome - destination: /quickstart + destination: /quickstart/introduction - source: /sdks destination: /sdk/web - source: /server-sdks @@ -866,3 +866,50 @@ redirects: destination: /assistants/examples/inbound-support - source: /examples destination: /guides + - source: /quickstart/web-integration + destination: /quickstart/web + - source: /assistants/speech-configuration + destination: /customization/speech-configuration + - source: /assistants/tools + destination: /tools + - source: /assistants/knowledge-base + destination: /knowledge-base/knowledge-base + - source: /assistants/tools/google-calendar + destination: /tools/google-calendar + - source: /assistants/tools/slack + destination: /tools/slack + - source: /assistants/tools/google-sheets + destination: /tools/google-sheets + - source: /assistants/workflows + destination: /workflows/quickstart + - source: /assistants/call-recording + destination: /assistants/call-recording + - source: /tools/GHL + destination: /tools/go-high-level + - source: /challenges-of-realtime-conversation + destination: /quickstart/introduction + - source: /advanced/sip-trunk.mdx + destination: /advanced/sip + - source: /quickstart/import-twillio + destination: /phone-numbers/import-twilio + - source: /phone-numbers/import-twillio + destination: /phone-numbers/import-twilio + # Additional 404 redirects to relevant content + - source: /phone-calling/outbound-calls + destination: /calls/outbound-calling + - source: /docs/api/workflows + destination: /workflows/quickstart + - source: /docs/workflows + destination: /workflows/quickstart + - source: /docs/transcription + destination: /customization/custom-transcriber + - source: /docs/assistants + destination: /quickstart/introduction + - source: /docs/tools + destination: /tools + - source: /docs/squads + destination: /squads + - source: /assets/batch-sample.csv + destination: /workflows/examples/lead-qualification + - source: /fern/api-reference + destination: /api-reference/calls/list diff --git a/fern/phone-numbers/import-twillio.mdx b/fern/phone-numbers/import-twilio.mdx similarity index 85% rename from fern/phone-numbers/import-twillio.mdx rename to fern/phone-numbers/import-twilio.mdx index c1110cb6..bcf9404f 100644 --- a/fern/phone-numbers/import-twillio.mdx +++ b/fern/phone-numbers/import-twilio.mdx @@ -1,16 +1,16 @@ --- -title: Import number from Twillio -subtitle: Import a new or existing number from Twillio -slug: quickstart/import-twillio +title: Import number from Twilio +subtitle: Import a new or existing number from Twilio +slug: phone-numbers/import-twilio --- ## Overview -As you scale your agents, you may want to use other telephony providers, like Twillio. In this guide, you'll learn how to add a new or existing Twillio number to Vapi. +As you scale your agents, you may want to use other telephony providers, like Twilio. In this guide, you'll learn how to add a new or existing Twilio number to Vapi. ## Prerequisites -- [A Twillio account](https://console.twilio.com/) +- [A Twilio account](https://console.twilio.com/) ## Get started @@ -46,4 +46,4 @@ As you scale your agents, you may want to use other telephony providers, like Tw - + \ No newline at end of file diff --git a/fern/pricing.mdx b/fern/pricing.mdx index fb1b5d2b..adc40d25 100644 --- a/fern/pricing.mdx +++ b/fern/pricing.mdx @@ -1,9 +1,88 @@ --- -title: Startup Pricing -subtitle: This is an overview of our pricing for developers and startups. For Enterprise pricing, please contact sales. +title: Pricing +subtitle: Simple, transparent pricing for voice AI slug: pricing +description: Learn about Vapi's pricing plans and find the right plan for your voice AI needs --- +## Overview + +Vapi offers flexible pricing to scale with your voice AI needs, from development to enterprise deployments. + +**All plans include:** +- Unlimited assistants and workflows +- Real-time call control +- Advanced analytics and insights +- 24/7 support + +## Pricing Plans + + + + **Pay-as-you-go** + + Perfect for developers and small projects + + - No monthly fees + - Pay only for usage + - Full API access + - Community support + + + + **Custom pricing** + + For production applications and growing businesses + + - Volume discounts + - Priority support + - Custom integrations + - SLA guarantees + + + +## Usage-Based Pricing + +Vapi charges based on actual usage: + +- **Voice minutes**: Per minute of conversation +- **API calls**: Per request to Vapi endpoints +- **Storage**: For call recordings and files + +View detailed pricing in your [Vapi Dashboard](https://dashboard.vapi.ai/settings/billing). + +## Enterprise + +For large-scale deployments, we offer: + +- **Custom pricing** based on volume +- **On-premise deployment** options +- **Dedicated support** teams +- **Custom SLAs** and uptime guarantees + +[Contact our sales team](https://form.typeform.com/to/iOcCsqVP?typeform-source=vapi.ai) for enterprise pricing. + +## FAQ + + + + Yes! New accounts receive free credits to get started. No credit card required to begin building. + + + + Billing is calculated based on actual usage - voice minutes, API calls, and storage used. You can monitor usage in real-time in your dashboard. + + + + Yes, you can upgrade or adjust your plan at any time. Changes take effect immediately. + + + +## Next Steps + +- [Sign up for free](https://dashboard.vapi.ai/) to get started +- [View detailed usage](https://dashboard.vapi.ai/settings/billing) in your dashboard +- [Contact sales](https://form.typeform.com/to/iOcCsqVP?typeform-source=vapi.ai) for enterprise needs