Nexmo (Preview)

Nexmo (Preview)

Nexmo, 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.nexmo.com/

Note:

  • This is a Premium connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

API Key
string
The API Key
API Secret
securestring
The API Secret

Actions

Create new application

This operation is used to create a new application in your account.

Required Parameters

Name
string
Type
string
Answer Url
string
Where your webhook delivers the Nexmo Call Control Object.
Events Url
string
Started, ringing or complete

Optional Parameters

Answer Method
string
HTTP method (Default GET).
Event Method
string
HTTP method (Default POST).

Returns

Delete an application

This operation is used to delete an existing application in your account.

Required Parameters

Application Id
string

Returns

Body
common

Get application by Id

This operation is used to retrieve information about a single application, given its id.

Required Parameters

Application Id
string

Returns

List applications

Retrieves a list of all applications associated with your account.

Optional Parameters

Result Count
number
Items returned on each call (Default 10).
Page Index
number
Offset from first page (Default 0).

Returns

applications
array of applicationResponse
Retrieves a list of all applications associated with your account.

List inbound numbers

This operation is used to retrieve all the inbound numbers that are avialble for a given country.

Required Parameters

Country
string
Code in ISO 3166-1 alpha-2 format.

Optional Parameters

Search Pattern
string
Pick a pattern.
Pattern
number
Number pattern to search for.
Available Features
string
SMS or VOICE
Result Count
number
Default 10.
Page Index
number
Index in the response.

Returns

List owned numbers

This operation retrieves all numbers associated with your account.

Optional Parameters

Search Pattern
string
Pick a pattern.
Page Index
number
Index in the response.
Result Count
number
Default 10 Max 100.
Pattern
number
Number pattern to search for.

Returns

Send a speech file

This operation is used to send a synthesized speech or recorded sound file to a phone number.

Required Parameters

To Phone Number
string
International format E.164.
Message
string
Speech text.

Optional Parameters

From Phone Number
string
Voice-enabled Nexmo number.
Language
string
To synthesize the message in.
Gender
string
Male or female.
Repeat Count
number
Up to 10 times.
Allow Machine Detection
string
True or hangup.
Machine Timeout
number
400ms to 10000ms.
Callback URL
url
Callback Method
string
GET or POST.

Returns

Send an SMS

This operation is used to send an SMS.

Required Parameters

Sender Id
string
An alphanumeric string.
To Phone Number
string
International format E.164.
Text
string
SMS body.

Optional Parameters

Type
string
Defaults to text.
Delivery Receipts
number
Set to 1 to enable.
Client Reference
string
For internal reporting.
Business Card
string
vCard format.
Calendar Event
string
vCal format.
Lifespan of SMS
number
In milliseconds.
Callback URL
url
Delivery receipt endpoint.
Message Class
number
Pick a class.
User Data Header
string
Hex encoded UDH.
Higher Level Protocol
string
Protocol id.
Body (If type is binary.)
string
Hex encoded binary data.
Title (If type is wappush.)
string
Url (If type is wappush.)
url
Website Url.
Availability (If type is wappush.)
string
In milliseconds.

Returns

Update an application

This operation is used to modify an existing application in your account.

Required Parameters

Application Id
string
Name
string
Type
string
Answer Url
string
Where your webhook delivers the Nexmo Call Control Object.
Events Url
string
Started, ringing or complete

Optional Parameters

Answer Method
string
HTTP method (Default GET).
Event Method
string
HTTP method (Default POST).

Returns

Definitions

smsResponse

Client Reference
string
The client-ref you set in the request.
Error Text
string
If an error occurred, this explains what happened.
Message Count
number
Number of parts the message was split into.
Message Id
string
Id of the SMS that was submitted (8 to 16 characters).
Message Price
string
Amount charged for your request. The value is in EUR.
Messages Array
array of object
Contains each message part.
Network
string
Mobile Country Code Mobile Network Code (MCCMNC) for the carrier that to is registered with.
Remaining Balance
string
Balance in your account. The value is in EUR.
Status
number
Shows how the SMS send is processing.
To Phone Number
string
Number your request was sent to.

ListNumbersResponse

Cost
string
Number cost.
Count
integer
Result count.
Country
string
ISO 3166-1 alpha-2 format.
Inbound Number
string
Inbound virtual number.
Numbers Array
array of object
List of all numbers.
Type
string
Type of number.

ttsResponse

Call Id
number
Unique alphanumeric 32 character ID for this call.
Error Text
string
If an error occurred, this explains what happened.
Status
number
Response code for this TTS or TTS prompt.
To Phone Number
number
Number of the user you sent the TTS or TTS Prompt to.

applicationResponse

Id
string
Nexmo application id.
Keys
string
The public key used to validate the jwt in a https://en.wikipedia.org/wiki/JSON_Web_Token.
Name
string
Application name.

common

Error Text
string
Title of error returned if failed.
Response
string
Human readable message.