We're hiring
Nexmo.com
Support
Sign In
Get an API key
Documentation
Use Cases
API Reference
SDKs & Tools
Community
Extend
Concepts
Overview
Guides
Authentication
Signing messages
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
Troubleshooting
Sender identity
Concatenation and encoding
Country specific features
Delivery receipts
Inbound SMS
SMPP access
Code Snippets
Before you begin
Send an SMS
Send an SMS with Unicode
Delivery Receipts
Receive an SMS
Tutorials
How to Get an SMS Delivery Receipt in ASP .NET MVC
Receiving SMS Delivery Receipts with PHP
How to Send SMS Messages with ASP.NET MVC Framework
Receiving an SMS with PHP
How to Send SMS Messages with Python, Flask and Nexmo
How to Receive SMS Messages with Ruby on Rails
Anything-to-SMS with IFTTT and Nexmo
Show SMS Notifications in the Browser with Angular, Node.JS, and Ably
Serverless SMS Fortune Cookies with Nexmo and IBM
How to Send SMS Messages with Java
Sending SMS Messages with PHP
Receive an SMS Delivery Receipt from a Mobile Carrier with Ruby on Rails
Receive SMS Messages with ASP.NET MVC Framework
Receive SMS Messages with Java
How to Send SMS Messages with Ruby on Rails
Use Cases
Private SMS communication
Receiving Concatenated SMS
Two-way SMS for customer engagement
Mobile app invites
SMS Customer Support
API Reference
Conversion API
Overview
US Short Codes
Overview
Guides
Alerts
2FA
Campaign Subscription Management
Messages API
Beta
Overview
Concepts
External Accounts
Understanding Facebook messaging
Understanding Viber messaging
Understanding WhatsApp messaging
Code Snippets
Before you begin
Install Nexmo CLI
How to create a Nexmo Messages and Dispatch Application
Client library
Configure webhooks
Receive an inbound message
Receive message status callback
SMS
Send an SMS
Viber Service Messages
Send a Text Message
Send an Image Message
Facebook Messenger
Send a Text Message
Send a Video Message
Send an Audio Message
Send a File Message
Send an Image Message
WhatsApp
Send an MTM
Send a Media Message MTM
Send a Text Message
Send a Video Message
Send an Audio Message
Send a File Message
Send an Image Message
MMS
Send an MMS
Use Cases
Sending Viber Service messages with the Messages API
Sending WhatsApp messages with the Messages API
Receive product information automatically via Facebook Messenger
Real-time data feed into multiple channels using Messages API
Sending SMS messages with the Messages API
Sending Facebook Messenger messages with the Messages API
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
Client library
How to create a Nexmo Messages and Dispatch Application
Send a Viber message with failover
Send an MMS with failover
Send a WhatsApp message with failover
Send a Facebook 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
Nexmo Call Control Objects
Legs and Conversations
Text to Speech
Customizing Spoken Text
Recording
Endpoints
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 with inline NCCO
Transfer a call
Track NCCO progress
Use Cases
Call a Websocket
Private voice communication
Call tracking
Local Numbers
Broadcast Voice-based Critical Alerts
Transcribe a recorded call with Amazon Transcribe
Interactive Voice Response
Call a Websocket
Add a Call whisper to an inbound call
NCCO Reference
API Reference
Webhook Reference
SIP
Overview
Concepts
SIP Connect
Configure
Avaya SBCe
ShoreTel & InGate
NEC SV9100
Cisco CUCM/CUBE
FreePBX
MiTel MiVoice
Asterisk
FreeSWITCH
Skype for Business
Verify
Overview
Guides
Workflows and Events
Verify Languages
Change the event timings
Code Snippets
Before you begin
Search for Verify request
Send verification code
Send verification code with workflow
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
Two-factor authentication for security and spam prevention
Passwordless 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 Nexmo Number Insight APIs and ASP.NET
Use Cases
Validate a number
Number Insight Advanced API
Fraud Scoring and Phone Number Verification
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
Record a Conversation
Get a Conversation
Delete a Conversation
List Conversations
Update Conversation
Create a Conversation
User
Get a User
Create a User
Delete a User
List Users
List a User's Conversations
Update a User
Member
Update a Member
List Members
Create a Member
Delete a Member
Get a Member
Leg
Delete a Leg
List Legs
Event
Create an Event
Create a custom Event
Delete an Event
Get an Event
List Events
Use Cases
Retrieve Conversation details for an in-progress voice call
API Reference
Client SDK
Beta
Overview
Setup
Create your application
Configure your data center
Set up push notifications
Add Client SDK to your application
Custom Events
In-App Messaging
Overview
Guides
Simple Conversation
Inviting Members
Utilizing Events
How to Add In-App Messaging to your iOS App
In-App Voice
Overview
Getting Started
Make a phone call
Receive a phone call
App to App call
Concepts
Call Statuses
Guides
Enable Audio
Call Member Actions
Send and Receive DTMF
Start and Receive Calls
Tutorials
Creating a web-based chat app
Making a phone call from a web app
Handling an inbound PSTN call in your app
Use Cases
Order support system
Digital Marketplace Use Case
Click to Call
Contact Center Use Case
Troubleshooting
SDK Documentation
iOS
Release Notes
SDK Reference
JavaScript
Release Notes
SDK Reference
Android
Release Notes
SDK Reference
Numbers
Overview
Guides
Number Management
Manage Numbers with the Nexmo CLI
Enable 2FA with a Short Code
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
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
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
Redact
Dev Preview
Overview
Guides
Developer Field Usage Guidance
Code Snippets
Redact using an ID
API Reference
Reports
Beta
Overview
Tutorials
Create a report using a graphical tool
Create a report using the command line
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
Vonage Integration Suite
API Reference
Avaya SBCe
The document linked below describes how to set up Nexmo's SIP service with Avaya SBCe.
Download PDF
