Skip to content

Prerequisites

Vonage Client SDK provides programmable voice calling across Android, iOS, and Web. This section gets you from a new account to the minimum setup required for your first call flow.

Platform requirements

Before starting, verify your target platform meets the minimum requirements:

PlatformMinimum VersionKey Permission
AndroidSDK 23 (Android 6.0)INTERNET, RECORD_AUDIO (runtime)
iOSiOS 15.0Microphone (NSMicrophoneUsageDescription)
WebChrome 70+, Firefox 60+, Safari 14.1+, Edge 79+Microphone (browser-prompted)

All platforms require WebRTC support. The SDK will not function on older OS versions or browsers that lack WebRTC APIs.

WARNING

On Android, RECORD_AUDIO is a dangerous permission requiring runtime consent before any call. On iOS, you must include the NSMicrophoneUsageDescription key in your Info.plist or the app will crash when requesting microphone access. On Web, the browser prompts the user automatically — no manifest entry is needed, but the call will have no audio if the user denies access.

Account setup

  1. Sign up at developer.vonage.com.
  2. Create a new Vonage application.
  3. Download and store your generated private key securely.
  4. Copy and save your API key & Application ID.
  5. Optionally buy a virtual number if you want to test PSTN inbound scenarios.

Voice backend requirement

To place or receive calls, your application needs a backend that can:

  • mint user JWTs for authenticated sessions
  • expose a public answer webhook that returns valid NCCO

This guide includes placeholder server pseudocode to explain required request and response shapes.

Examples

For working examples, see the Sample Apps section.

Built with VitePress.