API Developer
Nexmo is now Vonage
We're hiring
English
English
简体中文
Vonage.com
< Get an API key />
Documentation
Use Cases
API Reference
SDKs & Tools
Community
Extend
Concepts
Overview
Guides
Authentication
Signing messages
Webhooks
OpenAPI
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
How to Send SMS Messages with Ruby on Rails
Receiving an SMS with PHP
Receive SMS Messages with ASP.NET MVC Framework
Sending SMS Messages with PHP
Receive SMS Messages with Java
Receive an SMS Delivery Receipt from a Mobile Carrier with Ruby on Rails
How to Send SMS Messages with Python, Flask and Nexmo
How to Get an SMS Delivery Receipt in ASP .NET MVC
How to Receive SMS Messages with Ruby on Rails
Serverless SMS Fortune Cookies with Nexmo and IBM
Anything-to-SMS with IFTTT and Nexmo
Show SMS Notifications in the Browser with Angular, Node.JS, and Ably
How to Send SMS Messages with ASP.NET MVC Framework
Receiving SMS Delivery Receipts with PHP
How to Send SMS Messages with Java
Use Cases
Receiving Concatenated SMS
Mobile app invites
SMS Customer Support
Private SMS communication
Two-way SMS for customer engagement
API Reference
Message Search
API Reference
US Short Codes
Overview
Guides
2FA
Campaign Subscription Management
Alerts
Two-factor Authentication API Reference
Alerts - Subscribing API Reference
Alerts - Sending API Reference
Conversion API
Overview
API Reference
Messages API
Beta
Overview
Concepts
External Accounts
Understanding Facebook messaging
Understanding Viber messaging
Understanding WhatsApp messaging
Custom objects
Messages API Sandbox
Code Snippets
Before you Begin
Install Nexmo CLI
Create a Nexmo Application
Install Server SDK
Configure Webhooks
Inbound Message Webhook
Message Status Webhook
Viber Service Messages
Send a Text Message
Send an Image Message
MMS
Send an MMS
Facebook Messenger
Send a Text Message
Send an Image Message
Send a File Message
Send a Video Message
Send an Audio Message
Send a Message Template
WhatsApp
Send a Message Template (MTM)
Send a Media Message Template
Send a Link Button
Send a Text Message
Send a Quick Reply Button
Send an Image Message
Send a File Message
Send a Location
Send a Video Message
Send an Audio Message
Send a Contact
SMS
Send an SMS
Use Cases
Sending Viber Service messages with the Messages API
Real-time data feed into multiple channels using Messages API
Sending WhatsApp messages with the Messages API
Sending Facebook Messenger messages with the Messages API
Sending SMS messages with the Messages API
Receive product information automatically via Facebook Messenger
API Reference
External Accounts API
Overview
API Reference
Dispatch API
Beta
Overview
Concepts
What is a Dispatch workflow?
Code Snippets
Before you begin
Install Nexmo CLI
Server SDK
How to create a Nexmo Messages and Dispatch Application
Send a Viber message with failover
Send an MMS with failover
Send a Facebook message with failover
Send a WhatsApp message 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
Legs and Conversations
Nexmo Call Control Objects
Text to Speech
Customizing Spoken Text
Endpoints
Recording
DTMF
WebSockets
Beta
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 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
Transfer a call with inline NCCO
Track NCCO progress
Use Cases
Add a Call whisper to an inbound call
Call a Websocket with Node.js
Local Numbers
Broadcast Voice-based Critical Alerts
Call a Websocket with Python
Call tracking
Transcribe a recorded call with Amazon Transcribe
Interactive Voice Response
Private voice communication
API Reference
NCCO Reference
Webhook Reference
SIP
Overview
Concepts
Programmable SIP
Configure
Cisco CUCM/CUBE
Asterisk
ShoreTel & InGate
FreePBX
Skype for Business
NEC SV9100
FreeSWITCH
Avaya SBCe
MiTel MiVoice
Verify
Overview
Guides
Workflows and Events
Verify Languages
Change the event timings
Verify Velocity Rules
Code Snippets
Before you begin
Send verification code
Send verification code with workflow
Search for Verify request
Check verification code
Cancel verification request
Trigger next verification process
Tutorials
Add two factor authentication to a Microsoft bot with Nexmo’s Verify API
Use Cases
Passwordless authentication
Two-factor authentication for security and spam prevention
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 Nexmo Number Insight APIs and ASP.NET
Use Cases
Number Insight Advanced API
Fraud Scoring and Phone Number Verification
Validate a number
API Reference
Conversation
Beta
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
Member
Create a Member
Delete a Member
Get a Member
Update a Member
List Members
List Next Members
List Previous Members
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
Leg
List Legs
Delete a Leg
Use Cases
Retrieve Conversation details for an in-progress voice call
API Reference
Client SDK
Beta
Overview
Setup
Create your application
Add Client SDK to your application
Set up push notifications
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
In-App Voice
Overview
Getting Started
Make a phone call
Receive a phone call
App to App call
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
Creating an iOS chat app
Receiving an in-app voice call
Making an app to app voice call
Making an in-app voice call
Creating a web-based chat app
Use Cases
Click to Call
Order support system
Contact Center
Digital Marketplace
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
Nexmo Account Dashboard
Code Snippets
Create a secret
Configure account
Get account balance
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
Redact
Dev Preview
Overview
Guides
Developer Field Usage Guidance
Code Snippets
Redact using an ID
API Reference
Audit
Beta
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
Reports
Beta
Overview
Tutorials
Create a report using the command line
Create a report using a graphical tool
API Reference
Vonage Business Cloud
Smart Numbers
Overview
Guides
Enable Smart Numbers
Create a Nexmo Voice application
Provision the Service
Billing
Resources
Code Snippets
Receive an inbound call
Route to a VBC Extension
VBC APIs
Overview
Getting Started
Create an Application
Configure Authentication
Subscribe to the APIs
Account API
Overview
Code Snippets
Retrieve an account
Retrieve a location
Retrieve a list of locations
API Reference
Extension API
Overview
Code Snippets
Retrieve an extension
Retrieve a list of extensions
API Reference
Reports API
API Reference
User API
Overview
Code Snippets
Retrieve a user
Retrieve a list of users
API Reference
Call Recording API
API Reference
Vonage Integration Suite
API Reference
Tools
Postman
Prism
Ngrok
Avaya SBCe
The document linked below describes how to set up Nexmo's SIP service with Avaya SBCe.
Download PDF
