Skip to navigation
Skip to content
Vonage API Developer
Nexmo is now Vonage
We're hiring
Vonage.com
English
日本語
简体中文
English
< Get an API key />
Documentation
Use Cases
API Reference
SDKs & Tools
Community
Extend
Voyagers
Vonage Dev TV
Hacktoberfest 2020
Getting Started
Read this first!
Concepts
Overview
Guides
Authentication
Signing messages
OpenAPI
Webhooks
Glossary
Application
Overview
Code Snippets
Create an Application
List Applications
Get an Application
Update Application
Delete an Application
API Reference
Nexmo CLI
Messaging
SMS
Overview
Guides
Sender identity
Concatenation and encoding
Country specific features
Delivery receipts
Inbound SMS
Troubleshooting
SMPP access
Code Snippets
Before you begin
Send an SMS
Send an SMS with Unicode
Delivery Receipts
Receive an SMS
Tutorials
Serverless SMS Fortune Cookies with Nexmo and IBM
How to Send an SMS With ASP.NET Core MVC
Receive an SMS Delivery Receipt from a Mobile Carrier with Ruby on Rails
Anything-to-SMS with IFTTT and Nexmo
How to Send SMS Messages with Ruby on Rails
Show SMS Notifications in the Browser with Angular, Node.JS, and Ably
Receiving an SMS with PHP
Sending SMS Messages with PHP
How to Send SMS Messages with Python, Flask and Nexmo
How to Receive SMS Delivery Receipts with ASP.NET Core MVC
How to Receive an SMS Message with ASP.NET Core MVC
How to Receive SMS Messages with Ruby on Rails
Receive SMS Messages with Java
Receiving SMS Delivery Receipts with PHP
How to Send SMS Messages with Java
Use Cases
Two-way SMS for customer engagement
Private SMS communication
Receiving Concatenated SMS
SMS Customer Support
Mobile app invites
API Reference
Message Privacy
Message Search
API Reference
US Short Codes
Overview
Guides
2FA
Campaign Subscription Management
Alerts
Two-factor Authentication API Reference
Alerts - Sending API Reference
Alerts - Subscribing API Reference
Conversion API
Overview
API Reference
Beta
Messages API
Overview
Concepts
External Accounts
Understanding Facebook messaging
Understanding Viber messaging
Understanding WhatsApp messaging
Signed webhooks
Custom objects
Messages API Sandbox
Code Snippets
Before you Begin
Install Nexmo CLI
Create a Vonage Application
Install Server SDK
Configure Webhooks
Inbound Message Webhook
Message Status Webhook
MMS
Send an MMS
Viber Service Messages
Send a Text Message
Send an Image Message
WhatsApp
Send a Message Template (MTM)
Send a Media Message Template
Send a Quick Reply Button
Send a Link Button
Send a Location
Send a Video Message
Send an Audio Message
Send a File Message
Send a Text Message
Send an Image Message
Send a Contact
SMS
Send an SMS
Facebook Messenger
Send a Video Message
Send an Audio Message
Send a File Message
Send a Message Template
Send a Text Message
Send an Image Message
Tutorials
Sending an SMS message
Sending a Viber message
Sending a Facebook Messenger message
Sending a WhatsApp message
Use Cases
Receive product information automatically via Facebook Messenger
Real-time data feed into multiple channels using Messages API
API Reference
External Accounts API
Overview
API Reference
Beta
Dispatch API
Overview
Concepts
What is a Dispatch workflow?
Code Snippets
Before you begin
Install Nexmo CLI
Server SDK
How to create a Vonage Messages and Dispatch Application
Send an MMS with failover
Send a Viber message with failover
Send a WhatsApp message with failover
Send a Facebook message with failover
Send an SMS with failover
Tutorials
Sending a Facebook message with failover
Use Cases
Multi-user, multi-channel failover using Dispatch API
API Reference
External Accounts API
Overview
API Reference
Voice
Voice API
Overview
Guides
Troubleshooting
Numbers
Call Flow
Nexmo Call Control Objects
Legs and Conversations
Text to Speech
Customizing Spoken Text
Recording
Endpoints
DTMF
Speech Recognition
WebSockets
Signed Webhooks
Dev Preview
Contact Center Intelligence
Code Snippets
Before you begin
Make an outbound call with an NCCO
Connect an inbound call
Download a recording
Earmuff a call
Handle user input with ASR
Handle user input with DTMF
Connect callers into a conference
Make an outbound call
Mute a call
Play an audio stream into a call
Play DTMF into a call
Play text-to-speech into a call
Receive an inbound call
Record a call with split audio
Record a call
Record a conversation
Record a message
Retrieve information for a call
Retrieve information for all calls
Transfer a call with inline NCCO
Transfer a call
Track NCCO progress
Tutorials
How to Play Audio into a Call with .NET
How to Build a Voicemail with .NET
Use Cases
Transcribe a recorded call with Amazon Transcribe
Call a Websocket with Node.js
Interactive Voice Response
Local Numbers
Voice Bot
Call tracking
Broadcast Voice-based Critical Alerts
Add a Call whisper to an inbound call
Call a Websocket with Python
Private voice communication
API Reference
Webhook Reference
NCCO Reference
SIP
Overview
Concepts
Programmable SIP
Dev Preview
Configure
NEC SV9100
FreePBX
Skype for Business
Asterisk
Avaya SBCe
MiTel MiVoice
ShoreTel & InGate
Cisco CUCM/CUBE
FreeSWITCH
Verify
Overview
Guides
Verify Languages
Workflows and Events
Change the event timings
Verify Velocity Rules
Code Snippets
Before you begin
Send verification code
Search for Verify request
Send verification code with workflow
Send payment auth code with workflow (PSD2)
Send payment auth code (PSD2)
Check verification code
Cancel verification request
Trigger next verification process
Tutorials
Two-factor authentication for security and spam prevention
Step-up Authentication
API Reference
Number Insight
Overview
Guides
Retrieving CNAM Owner Details
Using Number Insight via the Nexmo CLI
Code Snippets
Before you begin
Number Insight Basic
Number Insight Standard
Number Insight Advanced
Number Insight Advanced Webhook
Number Insight Advanced (Sync)
Tutorials
Getting Started with the Number Insight APIs and ASP.NET
Use Cases
Number Insight Advanced API
Validate a number
API Reference
Beta
Conversation
Overview
Concepts
Application
Conversation
User
Member
Call
Channel
Leg
Media
Event
Session
Guides
How to set up your application
How to authenticate users
How to generate JWTs
Event flow
Code Snippets
Conversation
Create a Conversation
Delete a Conversation
Get a Conversation
Record a Conversation
Update Conversation
List Conversations
List Next Conversations
List Previous Conversations
User
Create a User
Delete a User
Get a User
Update a User
List Users
List Next Users
List Previous Users
List a User's Conversations
List Next Page of a User's Conversations
List Previous Page of a User's Conversations
Event
Create an Event
Create a custom Event
Delete an Event
Get an Event
List Events
List Next Events
List Previous Events
Member
Create a Member
Delete a Member
Get a Member
Update a Member
List Members
List Next Members
List Previous Members
Leg
Delete a Leg
List Legs
Use Cases
Retrieve Conversation details for an in-progress voice call
API Reference
Beta
Client SDK
Overview
Setup
Create your application
Set up push notifications
Add Client SDK to your application
Configuration
Configure your data center
Configure ICE server URL
Custom Events
In-App Messaging
Overview
Guides
Inviting Members
Send and Receive Text Messages
Send and Receive Images
Seen Receipt
Typing Indicators
Leave Conversation
Utilizing Events
Handling pagination
In-App Voice
Overview
Concepts
Call Statuses
Guides
Enable Audio
Send and Receive DTMF
Make a Call
Receive a Call
Mute a Call Member
Earmuff a Call Member
Tutorials
Making an in-app voice call
Creating a chat app
Making an app to app voice call
Receiving an in-app voice call
Use Cases
Contact Center
Order support system
Digital Marketplace
Click to Call
Troubleshooting
SDK Documentation
iOS
Release Notes
SDK Reference
JavaScript
Release Notes
SDK Reference
Android
Release Notes
SDK Reference
Numbers
Overview
Guides
Number Management
Enable 2FA with a Short Code
Manage Numbers with the Nexmo CLI
Setup Event Alerts
Payments
Code Snippets
List Your Numbers
Search Available Numbers
Buy a Number
Update a Number
Cancel a Number
API Reference
Account
Overview
Guides
Vonage Account Dashboard
Code Snippets
Get account balance
Create a secret
Configure account
Revoke a secret
List all secrets
Fetch a secret
Secret Management
API Reference
Subaccounts (Beta)
Overview
Code Snippets
Create a Subaccount
Get Subaccount
Get Subaccounts
Transfer Balance
Get Balance Transfers
Transfer Credit
Get Credit Transfers
Suspend a Subaccount
Reactivate a Subaccount
Use Cases
Using the Subaccounts API
API Reference
Beta
Audit
Overview
Concepts
Audit Events
Code Snippets
Get audit events
Get audit event
Get audit events with filtering
Get audit event types
Use Cases
Retrieve audit events
API Reference
Dev Preview
Redact
Overview
Guides
Developer Field Usage Guidance
Code Snippets
Redact using an ID
API Reference
Beta
Reports
Overview
Guides
Migrating from the SMS Message Search API
Code Snippets
Before you Begin
Get a record by UUID
Get records by dates
Create report
List reports
Get report status
Download report file
Cancel report
Tutorials
Create a CSV report using a graphical tool
Get JSON records using the command line
Create a CSV report using the command line
API Reference
Vonage Business Cloud
Overview
Tools
JWT generator
Postman
Ngrok
Prism
Online JWT generator tool
You can generate JWTs for authentication using our
online tool
.
Improve this page
Feedback
