Connectors Reference

Plivo

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

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

MakeCall (Call Call Request Body, [internal]string auth_id)

Make a call

ListMessages ([internal]string auth_id)

List all messages

SendSMS (SMS SMS Request Body, [internal]string auth_id)

Send SMS

GetMessage ([internal]string auth_id, string message_uuid)

Get message

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Call

 

GetMessageResponse

 

ListMessagesResponse

 

MakeCallResponse

 

SendSMSResponse

 

SMS

 

 

Actions:

MakeCall

Summary: Make a call

Description: This operation is used to make a call.

 

Syntax:

Plivo.MakeCall (Call Call Request Body, [internal]string auth_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

Call Request Body

Call

 

 

True

auth_id

string

(Auth ID)

Auth ID of your Plivo account.

True

 

Returns:

          Type:MakeCallResponse

 

ListMessages

Summary: List all messages

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

 

Syntax:

Plivo.ListMessages ([internal]string auth_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

auth_id

string

(Auth ID)

Auth ID of your Plivo account.

True

 

Returns:

          Type:ListMessagesResponse

 

SendSMS

Summary: Send SMS

Description: This operation is used to send a text message.

 

Syntax:

Plivo.SendSMS (SMS SMS Request Body, [internal]string auth_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

SMS Request Body

SMS

 

 

True

auth_id

string

(Auth ID)

Auth ID of your Plivo account.

True

 

Returns:

          Type:SendSMSResponse

 

GetMessage

Summary: Get message

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

 

Syntax:

Plivo.GetMessage ([internal]string auth_id, string message_uuid)

 

Parameters:

Name

Type

Summary

Required

Related Action

auth_id

string

(Auth ID)

Auth ID of your Plivo account.

True

message_uuid

string

(Message UUID)

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

True

 

Returns:

          Type:GetMessageResponse

 


 

Call

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

From

Plivo number to be used to make the call.

to

string

To

The phone number to call.

answer_url

string

Answer URL

URL to be called when the call is made.

answer_method

string

Answer Method

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


 

GetMessageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

api_id

string

API ID

Unique ID of the API request.

error_code

string

Error Code

Delivery error code if the message isn't delivered.

from_number

string

From

Number from which the message was sent.

message_direction

string

Message Direction

Direction of the message (inbound/outbound).

message_state

string

Message Delivery Status

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

message_time

string

Timestamp

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

message_type

string

Message Type

Type of the message.

message_uuid

string

Message UUID

Unique ID of the message.

resource_uri

string

Message URI

URI to get details of this single message.

to_number

string

To

Number to which the message was sent.

total_amount

string

Total Amount

Amount charged for the message.

total_rate

string

Rate

Rate per unit of the message.

units

integer

Units

Number of units the message was split into.


 

ListMessagesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

api_id

string

API ID

Unique ID of the API request.

meta

Meta

Meta Information

Meta information about the response.

objects

array of (ObjectsItem)

Message List

Details of all messages.

 

Meta

Summary: Meta Information

Description: Meta information about the response.

 

          Properties:

Name

Type

Summary

limit

integer

Limit

Maximum number of messages in a single page.

next

string

Next

URI of next page of messages if exists.

offset

integer

Offset

Number of messages before this page.

previous

string

Previous

URI of the previous page.

total_count

integer

Total Count

Total number of messages.

 

ObjectsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

error_code

string

Error Code

Delivery error code if the message isn't delivered.

from_number

string

From

Number from which the message was sent.

message_direction

string

Message Direction

Direction of the message (inbound/outbound).

message_state

string

Message Delivery Status

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

message_time

string

Timestamp

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

message_type

string

Message Type

Type of the message.

message_uuid

string

Message UUID

Unique ID of the message.

resource_uri

string

Message URI

URI to get details of this single message.

to_number

string

To

Number to which the message was sent.

total_amount

string

Total Amount

Amount charged for the message.

total_rate

string

Rate

Rate per unit of the message.

units

integer

Units

Number of units the message was split into.

 


 

MakeCallResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

api_id

string

API ID

Unique ID of the API request.

message

string

Response

Response obtained when the call was made.

request_uuid

string

Call UUID

Unique ID of the call.


 

SendSMSResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

api_id

string

API ID

Unique ID of the API request.

message

string

Response

Response of the sent message.

message_uuid

array of (string)

Message UUID

Unique ID of the message.


 

SMS

Summary:

Description:

 

          Properties:

Name

Type

Summary

src

string

From

Plivo number from which the message is to be sent.

dst

string

To

Phone number to which the message is to be sent.

text

string

Message

Text of the message to be sent.