Vonage (Preview)
The Vonage API Platform enables you to add communications within the context of your applications, including SMS, Voice and Chat. Sign up for a Nexmo account here - https://www.vonage.com/
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Vonage Support |
| URL | https://www.vonage.co.uk/support |
| support@vonage.com |
| Connector Metadata | |
|---|---|
| Publisher | Vonage |
| Website | https://vonage.com |
| Privacy Policy | https://www.vonage.com/legal/privacy-policy |
| Categories | Communication |
The Vonage API Platform enables you to add communications within the context of your applications, including SMS, Voice and Chat.
Prerequisites
You will need the following to proceed:
- A Vonage Account, sign up at https://dashboard.nexmo.com/sign-up
How to get credentials
To get credentials you can sign up for a free Vonage account at https://dashboard.nexmo.com/sign-up
Known issues and limitations
This connector currently does not expose all of the Vonage products and APIs
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Provides basic number insight information about a number |
Provides basic number insight information about a number |
| Provides standard number insight information about a number |
Provides standard number insight information about a number |
| Request a verification |
Use Verify request to generate and send a PIN to your user |
| Send a message to the given channel |
Send a Message |
| Verify check |
Confirms the PIN you received from your user matches the Verify request |
Provides basic number insight information about a number
Provides basic number insight information about a number
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The response format
|
format | True | string |
The response format |
|
Your API key
|
api_key | True | string |
Your API key |
|
Your API secret
|
api_secret | True | string |
Your API secret |
|
A phone number that you need insight about in national or international format
|
number | True | string |
A phone number that you need insight about in national or international format |
|
Two-character country code in ISO 3166-1 alpha-2 format eg. GB or US
|
country | True | string |
Two-character country code in ISO 3166-1 alpha-2 format eg. GB or US |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string |
Provides standard number insight information about a number
Provides standard number insight information about a number
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The response format
|
format | True | string |
The response format |
|
Your API key
|
api_key | True | string |
Your API key |
|
Your API secret
|
api_secret | True | string |
Your API secret |
|
A phone number that you need insight about in national or international format
|
number | True | string |
A phone number that you need insight about in national or international format |
|
Two-character country code in ISO 3166-1 alpha-2 format eg. GB or US
|
country | True | string |
Two-character country code in ISO 3166-1 alpha-2 format eg. GB or US |
|
Set to true to receive phone number owner name in the response
|
cnam | string |
Set to true to receive phone number owner name in the response |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string | |
|
request_price
|
request_price | string | |
|
refund_price
|
refund_price | string | |
|
remaining_balance
|
remaining_balance | string | |
|
network_code
|
current_carrier.network_code | string | |
|
name
|
current_carrier.name | string | |
|
country
|
current_carrier.country | string | |
|
network_type
|
current_carrier.network_type | string | |
|
network_code
|
original_carrier.network_code | string | |
|
name
|
original_carrier.name | string | |
|
country
|
original_carrier.country | string | |
|
network_type
|
original_carrier.network_type | string | |
|
ported
|
ported | string | |
|
caller_type
|
caller_identity.caller_type | string | |
|
caller_name
|
caller_identity.caller_name | string | |
|
first_name
|
caller_identity.first_name | string | |
|
last_name
|
caller_identity.last_name | string | |
|
caller_name
|
caller_name | string | |
|
last_name
|
last_name | string | |
|
first_name
|
first_name | string | |
|
caller_type
|
caller_type | string |
Request a verification
Use Verify request to generate and send a PIN to your user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The response format
|
format | True | string |
The response format |
|
You can find your API key in your account dashboard https://dashboard.nexmo.com
|
api_key | True | string |
You can find your API key in your account dashboard https://dashboard.nexmo.com |
|
You can find your API secret in your dashboard https://dashboard.nexmo.com
|
api_secret | True | string |
You can find your API secret in your dashboard https://dashboard.nexmo.com |
|
The mobile or landline phone number to verify. Number must be in E.164 format
|
number | True | string |
The mobile or landline phone number to verify. Number must be in E.164 format |
|
Specify the two-character country code, verify will then format the number
|
country | string |
Specify the two-character country code, verify will then format the number |
|
|
An 18-character alphanumeric string, use to personalize the request SMS body
|
brand | True | string |
An 18-character alphanumeric string, use to personalize the request SMS body |
|
An 11-character alphanumeric string that represents the identity of the sender
|
sender_id | string |
An 11-character alphanumeric string that represents the identity of the sender |
|
|
The length of the verification code
|
code_length | integer |
The length of the verification code |
|
|
Control the language used for the Verify request
|
lg | string |
Control the language used for the Verify request |
|
|
How long the generated verification code is valid for, in seconds
|
pin_expiry | integer |
How long the generated verification code is valid for, in seconds |
|
|
Wait time in seconds between attempts to deliver the verification code
|
next_event_wait | integer |
Wait time in seconds between attempts to deliver the verification code |
|
|
Predefined sequence of SMS and TTS actions to convey the PIN to your user
|
workflow_id | integer |
Predefined sequence of SMS and TTS actions to convey the PIN to your user |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | string | |
|
request_id
|
request_id | string |
Send a message to the given channel
Send a Message
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type for request
|
Content-Type | True | string |
Content-Type |
|
Accepted date type
|
Accept | True | string |
Accept |
|
The type of message to send. You must provide text in this field
|
message_type | string |
The type of message to send. You must provide text in this field |
|
|
The text of message to send; limited to 1000 characters
|
text | string |
The text of message to send; limited to 1000 characters |
|
|
The phone number of the message recipient in the E.164 format
|
to | string |
The phone number of the message recipient in the E.164 format |
|
|
The phone number of the message recipient in the E.164 format
|
from | string |
The phone number of the message recipient in the E.164 format |
|
|
The channel to send to. You must provide sms in this field
|
channel | string |
The channel to send to. You must provide sms in this field |
|
|
Client reference of up to 40 characters
|
client_ref | string |
Client reference of up to 40 characters |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
Verify check
Confirms the PIN you received from your user matches the Verify request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The response format
|
format | True | string |
The response format |
|
Your API Key
|
api_key | True | string |
Your API Key |
|
Your API Secret
|
api_secret | True | string |
Your API Secret |
|
This is the request_id you received in the response to the Verify request
|
request_id | True | string |
This is the request_id you received in the response to the Verify request |
|
The verification code entered by your user
|
code | True | string |
The verification code entered by your user |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
request_id
|
request_id | string | |
|
event_id
|
event_id | string | |
|
status
|
status | string | |
|
price
|
price | string | |
|
currency
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |