Plivo (Preview)

Plivo enables sending and receiving SMS & voice calls globally for businesses of all sizes.

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
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

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

Name Type Description
Auth Id string

The username for this api.

Auth Token securestring

The password for this api.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Get message

This operation is used to fetch the details of a message, given the message ID.

List all messages

This operation returns a list of all messages associated with your Plivo account.

Make a call

This operation is used to make a call.

Send SMS

This operation is used to send a text message.

Get message

This operation is used to fetch the details of a message, given the message ID.

Parameters

Name Key Required Type Description
Message UUID
message_uuid True string

UUID of the message for which the details need to be fetched.

Returns

Name Path Type Description
API ID
api_id string

Unique ID of the API request.

Error Code
error_code string

Delivery error code if the message isn't delivered.

From
from_number string

Number from which the message was sent.

Message Direction
message_direction string

Direction of the message (inbound/outbound).

Message Delivery Status
message_state string

Status of the message (queued/sent/delivered/failed).

Timestamp
message_time string

Timestamp at which the message was sent or received (yyyy-MM-dd HH:mm:ss UTC).

Message Type
message_type string

Type of the message.

Message UUID
message_uuid string

Unique ID of the message.

Message URI
resource_uri string

URI to get details of this single message.

To
to_number string

Number to which the message was sent.

Total Amount
total_amount string

Amount charged for the message.

Rate
total_rate string

Rate per unit of the message.

Units
units integer

Number of units the message was split into.

List all messages

This operation returns a list of all messages associated with your Plivo account.

Returns

Name Path Type Description
API ID
api_id string

Unique ID of the API request.

Limit
meta.limit integer

Maximum number of messages in a single page.

Next
meta.next string

URI of next page of messages if exists.

Offset
meta.offset integer

Number of messages before this page.

Previous
meta.previous string

URI of the previous page.

Total Count
meta.total_count integer

Total number of messages.

Message List
objects array of object

Details of all messages.

Error Code
objects.error_code string

Delivery error code if the message isn't delivered.

From
objects.from_number string

Number from which the message was sent.

Message Direction
objects.message_direction string

Direction of the message (inbound/outbound).

Message Delivery Status
objects.message_state string

Status of the message (queued/sent/delivered/failed).

Timestamp
objects.message_time string

Timestamp at which the message was sent or received (yyyy-MM-dd HH:mm:ss UTC).

Message Type
objects.message_type string

Type of the message.

Message UUID
objects.message_uuid string

Unique ID of the message.

Message URI
objects.resource_uri string

URI to get details of this single message.

To
objects.to_number string

Number to which the message was sent.

Total Amount
objects.total_amount string

Amount charged for the message.

Rate
objects.total_rate string

Rate per unit of the message.

Units
objects.units integer

Number of units the message was split into.

Make a call

This operation is used to make a call.

Parameters

Name Key Required Type Description
From
from True string

Plivo number to be used to make the call.

To
to True string

The phone number to call.

Answer URL
answer_url True string

URL to be called when the call is made.

Answer Method
answer_method string

HTTP Method (GET/POST) that should be used to call the Answer URL.

Returns

Name Path Type Description
API ID
api_id string

Unique ID of the API request.

Response
message string

Response obtained when the call was made.

Call UUID
request_uuid string

Unique ID of the call.

Send SMS

This operation is used to send a text message.

Parameters

Name Key Required Type Description
From
src True string

Plivo number from which the message is to be sent.

To
dst True string

Phone number to which the message is to be sent.

Message
text True string

Text of the message to be sent.

Returns

Name Path Type Description
API ID
api_id string

Unique ID of the API request.

Response
message string

Response of the sent message.

Message UUID
message_uuid array of string

Unique ID of the message.