Compartilhar via


Nexmo

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/

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)
Connector Metadata
Publisher Microsoft

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key string The API Key True
API Secret securestring The API Secret True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create new application

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

Delete an application

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

Get application by Id

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

List applications

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.

List owned numbers

This operation retrieves all numbers associated with your account.

Send a speech file

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

Send an SMS

This operation is used to send an SMS.

Update an application

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

Create new application

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

Parameters

Name Key Required Type Description
Name
name True string

Name of the application.

Type
type True string

Type of application.

Answer Url
answer_url True string

Where your webhook delivers the Nexmo Call Control Object.

Events Url
event_url True string

Started, ringing or complete

Answer Method
answer_method string

HTTP method (Default GET).

Event Method
event_method string

HTTP method (Default POST).

Returns

Delete an application

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

Parameters

Name Key Required Type Description
Application Id
application_id True string

Unique identifier of the application.

Returns

Body
common

Get application by Id

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

Parameters

Name Key Required Type Description
Application Id
application_id True string

Unique identifier of the application.

Returns

List applications

Retrieves a list of all applications associated with your account.

Parameters

Name Key Required Type Description
Result Count
page_size number

Items returned on each call (Default 10).

Page Index
page_index number

Offset from first page (Default 0).

Returns

Name Path Type Description
applications
_embedded.applications array of applicationResponse

List inbound numbers

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

Parameters

Name Key Required Type Description
Country
country True string

Code in ISO 3166-1 alpha-2 format.

Search Pattern
Search Pattern string

Pick a pattern.

Pattern
pattern number

Number pattern to search for.

Available Features
features string

SMS or VOICE

Result Count
size number

Default 10.

Page Index
index number

Index in the response.

Returns

List owned numbers

This operation retrieves all numbers associated with your account.

Parameters

Name Key Required Type Description
Search Pattern
Search Pattern string

Pick a pattern.

Page Index
index number

Index in the response.

Result Count
size number

Default 10 Max 100.

Pattern
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.

Parameters

Name Key Required Type Description
To Phone Number
to True string

International format E.164.

From Phone Number
from string

Voice-enabled Nexmo number.

Message
text True string

Speech text.

Language
lg string

To synthesize the message in.

Gender
voice string

Male or female.

Repeat Count
repeat number

Up to 10 times.

Allow Machine Detection
machine_detection string

True or hangup.

Machine Timeout
machine_timeout number

400ms to 10000ms.

Callback URL
callback url

Url for callback.

Callback Method
callback_method string

GET or POST.

Returns

Send an SMS

This operation is used to send an SMS.

Parameters

Name Key Required Type Description
Sender Id
from True string

An alphanumeric string.

To Phone Number
to True string

International format E.164.

Text
text True string

SMS body.

Type
type string

Defaults to text.

Delivery Receipts
status-report-req number

Set to 1 to enable.

Client Reference
client-ref string

For internal reporting.

Business Card
vcard string

vCard format.

Calendar Event
vcal string

vCal format.

Lifespan of SMS
ttl number

In milliseconds.

Callback URL
callback url

Delivery receipt endpoint.

Message Class
message-class number

Pick a class.

User Data Header
udh string

Hex encoded UDH.

Higher Level Protocol
protocol-id string

Protocol id.

Body (If type is binary.)
body string

Hex encoded binary data.

Title
title string

If type is wappush.

Url
url url

Website Url (If type is wappush.).

Availability (If type is wappush.)
validity string

In milliseconds.

Returns

Update an application

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

Parameters

Name Key Required Type Description
Application Id
application_id True string

Unique identifier of the application.

Name
name True string

Name of the application.

Type
type True string

Type of application.

Answer Url
answer_url True string

Where your webhook delivers the Nexmo Call Control Object.

Events Url
event_url True string

Started, ringing or complete

Answer Method
answer_method string

HTTP method (Default GET).

Event Method
event_method string

HTTP method (Default POST).

Returns

Definitions

smsResponse

Name Path Type Description
Message Count
message-count string

Number of parts the message was split into.

Messages Array
messages array of object

Contains each message part.

Status
messages.status string

Shows how the SMS send is processing.

Message Id
messages.message-id string

Id of the SMS that was submitted (8 to 16 characters).

To Phone Number
messages.to string

Number your request was sent to.

Client Reference
messages.client-ref string

The client-ref you set in the request.

Remaining Balance
messages.remaining-balance string

Balance in your account. The value is in EUR.

Message Price
messages.message-price string

Amount charged for your request. The value is in EUR.

Network
messages.network string

Mobile Country Code Mobile Network Code (MCCMNC) for the carrier that to is registered with.

Error Text
messages.error-text string

If an error occurred, this explains what happened.

ListNumbersResponse

Name Path Type Description
Count
count integer

Result count.

Numbers Array
numbers array of object

List of all numbers.

Cost
numbers.cost string

Number cost.

Country
numbers.country string

ISO 3166-1 alpha-2 format.

Inbound Number
numbers.msisdn string

Inbound virtual number.

Type
numbers.type string

Type of number.

ttsResponse

Name Path Type Description
Call Id
call_id string

Unique alphanumeric 32 character ID for this call.

To Phone Number
to string

Number of the user you sent the TTS or TTS Prompt to.

Status
status string

Response code for this TTS or TTS prompt.

Error Text
error_text string

If an error occurred, this explains what happened.

applicationResponse

Name Path Type Description
Id
id string

Nexmo application id.

Name
name string

Application name.

Keys
keys.public_key string

The public key used to validate the jwt in a https://en.wikipedia.org/wiki/JSON_Web_Token.

common

Name Path Type Description
Response
type string

Human readable message.

Error Text
error_title string

Title of error returned if failed.