Vonage

Voice and messaging: calls, conversations, number lookups, verification, and numbers

Signs in with: Connection fields
Runs on: Cloud or On-Prem Worker
Operations: 103
Ready-made triggers: 4

Connect Vonage

In Neblex open Connect › Connections and click New Connection.
Search for Vonage and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
API keyOptionalSecret	The account's API key from the Vonage dashboard. With the API secret it authenticates the account-level routes.
API secretOptionalSecret
Application idOptional	The Vonage application whose private key signs the tokens for Voice, Conversation, users and Identity Insights, and for Messages and Verify when present.
Application private keyOptionalSecret	The private key (PEM) downloaded when the application's keys were generated.
Identity Insights regionOptional	Where Identity Insights requests are served.

Triggers

For events that arrive as a webhook, add a Webhook trigger and enter its Webhook URL in Vonage's webhook settings.

Event	What it does	How
Call event	Fires when Vonage posts a call's status change or input to the call's event URL.	Receives a webhook
Message received	Fires when Vonage posts a message received on the application's inbound URL.	Receives a webhook
Message status changed	Fires when Vonage posts a sent message's status (submitted, delivered, read, rejected, undeliverable) to the application's status URL.	Receives a webhook
Verification status changed	Fires when Verify v2 posts a verification's status or a workflow event.	Receives a webhook

Use it in a flow

Open a flow, open the node library and search for Vonage.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

Operations

103 operations in 20 groups. Each one is a step you can add to a flow.

Account7

Create an API secret`createApiSecret`	POST	Add an API secret (an account holds at most two).
Get an API secret`getApiSecret`	GET	One API secret's id and creation time.
Get the balance`getBalance`	GET	The account's balance and whether automatic reload is on.
List API secrets`listApiSecrets`	GET	The API secrets of the account or of a subaccount.
Revoke an API secret`revokeApiSecret`	DELETE	Revoke an API secret.
Top up the balance`topUpBalance`	POST	Top up an account with automatic reload enabled, using the reload transaction.
Update account settings`updateAccountSettings`	POST	Set the account's inbound SMS and delivery receipt URLs and how they are called.

Application5

Create an application`createApplication`	POST	Create an application with its capabilities; Vonage returns its private key once.
Delete an application`deleteApplication`	DELETE	Delete an application.
Get an application`getApplication`	GET	One application.
List applications`listApplications`	GET	The account's Vonage applications.
Update an application`updateApplication`	PUT	Replace an application's name, keys and capabilities.

Audit2

Get an audit event`getAuditEvent`	GET	One audit event.
List audit events`listAuditEvents`	GET	Account events (users, numbers, applications, settings) by type, time or text.

Call11

Control a call`updateCall`	PUT	Hang up, mute, unmute, earmuff, unearmuff or transfer an active call.
Get a call`getCall`	GET	One call leg with its status, timing and price.
List calls`listCalls`	GET	Calls of the account, filtered by status, time range or conversation.
Make a call`createCall`	POST	Place an outbound call controlled by an NCCO or by an answer URL.
Play audio into a call`playAudioStream`	PUT	Stream an audio file into an active call.
Receive DTMF input`subscribeDtmf`	PUT	Send the digits the caller presses to an event URL as they happen.
Send DTMF tones`playDtmf`	PUT	Play DTMF digits into an active call.
Speak into a call`playTextToSpeech`	PUT	Read text into an active call with text to speech.
Stop audio in a call`stopAudioStream`	DELETE	Stop the audio streaming into a call.
Stop receiving DTMF input`unsubscribeDtmf`	DELETE	Stop sending the caller's digits to the event URL.
Stop speaking in a call`stopTextToSpeech`	DELETE	Stop text to speech in a call.

Channel account9

Add a Messenger account`createMessengerAccount`	POST	Connect a Facebook page to Vonage for Messenger.
Get a Messenger account`getMessengerAccount`	GET	One Messenger account.
Get a Viber account`getViberAccount`	GET	One Viber Service Message account.
Get a WhatsApp account`getWhatsAppAccount`	GET	One WhatsApp Business account.
Link an application`linkApplication`	POST	Link a Vonage application to a channel account so its messages reach the application.
List channel accounts`listChannelAccounts`	GET	The WhatsApp, Messenger, Viber and RCS accounts the account owns.
Remove a Messenger account`deleteMessengerAccount`	DELETE	Disconnect a Messenger account.
Unlink an application`unlinkApplication`	DELETE	Unlink a Vonage application from a channel account.
Update a Messenger account`updateMessengerAccount`	PATCH	Change a Messenger account's name, token or linked applications.

Conversation11

Create a conversation`createConversation`	POST	Create a conversation that users, calls and messages can join.
Delete a conversation`deleteConversation`	DELETE	Delete a conversation.
Get a conversation`getConversation`	GET	One conversation.
List a user's conversations`listUserConversations`	GET	The conversations a user is invited to, has joined or has left.
List conversations`listConversations`	GET	Conversations of the application, optionally in a time range.
Play audio into a conversation`playConversationAudioStream`	PUT	Stream an audio file into a conversation.
Record a conversation`recordConversation`	PUT	Start or stop recording a conversation, optionally transcribed.
Speak into a conversation`playConversationTextToSpeech`	PUT	Read text into a conversation's audio with text to speech.
Stop audio in a conversation`stopConversationAudioStream`	DELETE	Stop the audio streaming into a conversation.
Stop speaking in a conversation`stopConversationTextToSpeech`	DELETE	Stop text to speech in a conversation.
Update a conversation`updateConversation`	PUT	Replace a conversation's settings.

Conversation event4

Create an event`createEvent`	POST	Send a message or custom event into a conversation.
Delete an event`deleteEvent`	DELETE	Delete an event from a conversation.
Get an event`getEvent`	GET	One event of a conversation.
List events`listEvents`	GET	The events of a conversation: messages, member changes, calls and media.

Conversation member4

Add a member`createMember`	POST	Invite a user to a conversation or join them to it.
Get a member`getMember`	GET	One member of a conversation.
List members`listMembers`	GET	The members of a conversation.
Update a member`updateMember`	PATCH	Join an invited member to a conversation or make a member leave it.

Identity insight1

Get identity insightsgetIdentityInsights POST Format, carrier, SIM swap, device swap, roaming, reachability, location and subscriber match insights for a phone number, as requested.

Message2

Send a message`sendMessage`	POST	Send a text, media, template, card or custom message over SMS, MMS, RCS, WhatsApp, Messenger, Viber or email.
Update a message`updateMessage`	PATCH	Mark a received WhatsApp or RCS message as read, or revoke a sent RCS message.

Number5

Buy a number`buyNumber`	POST	Buy a number for the account or a subaccount.
Cancel a number`cancelNumber`	POST	Give up a number the account owns.
List your numbers`listOwnedNumbers`	GET	The numbers the account owns, filtered by application, country or pattern, one page at a time (page and size; count is the total).
Search numbers to buy`searchAvailableNumbers`	GET	Numbers available in a country, by type, features and pattern, one page at a time (page and size; count is the total).
Update a number`updateNumber`	POST	Link a number to an application or set its inbound message and call handling.

Number insight4

Look up a number (advanced)`advancedNumberInsight`	GET	Standard insight plus reachability, roaming and validity, answered right away.
Look up a number (advanced, to a callback)`advancedNumberInsightAsync`	GET	Advanced insight delivered to a callback URL once ready.
Look up a number (basic)`basicNumberInsight`	GET	A number's international and national format and its country.
Look up a number (standard)`standardNumberInsight`	GET	Basic insight plus the number's type, current and original carrier, porting and optionally the caller name (US).

Pricing3

Get pricing for a country`getCountryPricing`	GET	Outbound prices of a service in one country, per network.
Get pricing for a prefix`getPrefixPricing`	GET	Outbound prices of a service for a dialing prefix.
Get pricing for all countries`getAllPricing`	GET	Outbound prices of a service in every country.

Redact1

Redact a transactionredactTransaction POST Remove personal data from Vonage's records of a message, call or lookup.

Report5

Cancel a report`cancelReport`	DELETE	Stop an asynchronous report that is still running.
Create a report`createReport`	POST	Start an asynchronous CSV report of one product over a time range; Vonage calls the callback URL when it is ready to download.
Download a report`downloadReport`	GET	The finished report file (a zipped CSV).
Get a report`getReport`	GET	An asynchronous report's status and download link.
List records`listReportRecords`	GET	Message, call, verification and other usage records of one product, found by id or by time range with filters, read page by page.

SMS1

Send an SMSsendSms POST Send an SMS through the SMS API, with delivery receipts to the given callback.

Subaccount9

Create a subaccount`createSubaccount`	POST	Create a subaccount, sharing the primary balance or with its own.
Get a subaccount`getSubaccount`	GET	One subaccount.
List balance transfers`listBalanceTransfers`	GET	Balance transfers between the primary account and subaccounts in a time range.
List credit transfers`listCreditTransfers`	GET	Credit transfers between the primary account and subaccounts in a time range.
List subaccounts`listSubaccounts`	GET	The primary account and its subaccounts.
Transfer a number`transferNumber`	POST	Move a number between the primary account and a subaccount.
Transfer balance`transferBalance`	POST	Move balance between the primary account and a subaccount.
Transfer credit`transferCredit`	POST	Move credit limit between the primary account and a subaccount.
Update a subaccount`updateSubaccount`	PATCH	Rename, suspend or reactivate a subaccount, or change its balance sharing.

User5

Create a user`createUser`	POST	Create a user who can join conversations and calls.
Delete a user`deleteUser`	DELETE	Delete a user.
Get a user`getUser`	GET	One user by id.
List users`listUsers`	GET	The users of the application, optionally by name.
Update a user`updateUser`	PATCH	Change a user's name, image or channels.

Verification4

Cancel a verification`cancelVerification`	DELETE	Stop a verification before it completes.
Check a verification code`checkVerificationCode`	POST	Check the code the user entered against a verification.
Move to the next channel`nextVerificationWorkflow`	POST	Skip to the next channel of a verification's workflow.
Start a verification`startVerification`	POST	Send a one-time code (or a silent authentication) to a user through the channels of the workflow, in order.

Verify template10

Create a template`createVerifyTemplate`	POST	Create a verification message template.
Create a template fragment`createTemplateFragment`	POST	Add the text of a template for one channel and locale.
Delete a template`deleteVerifyTemplate`	DELETE	Delete a verification message template.
Delete a template fragment`deleteTemplateFragment`	DELETE	Delete a template fragment.
Get a template`getVerifyTemplate`	GET	One verification message template.
Get a template fragment`getTemplateFragment`	GET	One template fragment.
List template fragments`listTemplateFragments`	GET	The per-channel, per-locale texts of a template.
List templates`listVerifyTemplates`	GET	The verification message templates.
Update a template`updateVerifyTemplate`	PATCH	Rename a template or make it the default.
Update a template fragment`updateTemplateFragment`	PATCH	Change a template fragment's text.