Plivo
App · 16 actions
Send messages, make calls and look up Plivo message, call and recording records.
Actions
| Action | What it does |
|---|---|
| Delete a recording | Delete a recording. |
| Get a application record | Get a application record. |
| Get a call record | Get a call record. |
| Get a endpoint record | Get a endpoint record. |
| Get a message record | Get a message record. |
| Get a number record | Get a number record. |
| Get a recording record | Get a recording record. |
| Get account details | Get account details. |
| List applications | List applications. |
| List completed calls | List completed calls. |
| List message records | List message records. |
| List recordings | List recordings. |
| List SIP endpoints | List SIP endpoints. |
| List your phone numbers | List your phone numbers. |
| Make an outbound call | Make an outbound call. |
| Send an SMS or MMS | Send an SMS or MMS. |
Delete a recording
Delete a recording.
Inputs
- Recording ID
recording_idtextRequired - Recording ID.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {}
}Get a application record
Get a application record.
Inputs
- App
app_idtextRequired - App ID.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"answer_url": "example",
"app_id": "example",
"app_name": "example",
"message_url": "example"
}
}Get a call record
Get a call record.
Inputs
- Call uuid
call_uuidtextRequired - Call uuid.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"call_direction": "example",
"call_duration": "example",
"call_uuid": "example",
"end_time": "example",
"from_number": "example",
"hangup_cause_name": "example",
"to_number": "example"
}
}Get a endpoint record
Get a endpoint record.
Inputs
- Endpoint
endpoint_idtextRequired - Endpoint ID.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"alias": "example",
"endpoint_id": "example",
"sip_uri": "example",
"username": "example"
}
}Get a message record
Get a message record.
Inputs
- Message uuid
message_uuidtextRequired - Message uuid.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"from_number": "example",
"message_direction": "example",
"message_state": "example",
"message_time": "example",
"message_uuid": "example",
"to_number": "example"
}
}Get a number record
Get a number record.
Inputs
- Number
numbertextRequired - Number.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"application": "example",
"carrier": "example",
"number": "example",
"number_type": "example"
}
}Get a recording record
Get a recording record.
Inputs
- Recording ID
recording_idtextRequired - Recording ID.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"add_time": "example",
"call_uuid": "example",
"recording_duration_ms": 1,
"recording_id": "example",
"recording_url": "example"
}
}Get account details
Get account details.
Inputs
None.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"account_type": "example",
"auth_id": "example",
"cash_credits": "example",
"name": "example"
}
}List applications
List applications.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
- App name
app_nametext - App name.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"answer_url": "example",
"app_id": "example",
"app_name": "example",
"message_url": "example"
}
]
}
}List completed calls
List completed calls.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
- Call direction
call_directiontext - Call direction.One of:
inbound,outbound. - Start time
start_timedate and time - Start time.
- End time
end_timedate and time - End time.
- From number
from_numbertext - From number.
- To number
to_numbertext - To number.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"call_direction": "example",
"call_duration": "example",
"call_uuid": "example",
"end_time": "example",
"from_number": "example",
"hangup_cause_name": "example",
"to_number": "example"
}
]
}
}List message records
List message records.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
- Message direction
message_directiontext - Message direction.One of:
inbound,outbound. - Message state
message_statetext - Message state.One of:
queued,sent,delivered,undelivered,failed,received. - Start time
start_timedate and time - Start time.
- End time
end_timedate and time - End time.
- From number
from_numbertext - From number.
- To number
to_numbertext - To number.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"from_number": "example",
"message_direction": "example",
"message_state": "example",
"message_time": "example",
"message_uuid": "example",
"to_number": "example"
}
]
}
}List recordings
List recordings.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
- Call uuid
call_uuidtext - Call uuid.
- From number
from_numbertext - From number.
- To number
to_numbertext - To number.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"add_time": "example",
"call_uuid": "example",
"recording_duration_ms": 1,
"recording_id": "example",
"recording_url": "example"
}
]
}
}List SIP endpoints
List SIP endpoints.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"alias": "example",
"endpoint_id": "example",
"sip_uri": "example",
"username": "example"
}
]
}
}List your phone numbers
List your phone numbers.
Inputs
- Limit
limitnumber - Limit.From 1 to 20.
- Offset
offsetnumber - Offset.At least 0.
- Number type
number_typetext - Number type.One of:
local,tollfree,mobile,national.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"meta": {
"limit": 1,
"next": "example",
"offset": 1,
"total_count": 1
},
"objects": [
{
"application": "example",
"carrier": "example",
"number": "example",
"number_type": "example"
}
]
}
}Make an outbound call
Make an outbound call.
Inputs
- From number
from_numbertextRequired - From number.
- To number
to_numbertextRequired - To number.
- Answer URL
answer_urltextRequired - Answer URL.
- Answer method
answer_methodtext - Answer method.One of:
GET,POST.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"api_id": "example",
"message": "example",
"request_uuid": "example"
}
}Send an SMS or MMS
Send an SMS or MMS.
Inputs
- From number
from_numbertextRequired - From number.
- To number
to_numbertextRequired - To number.
- Text
texttext - Text.
- Type
typetext - Type.One of:
sms,mms. - Media URLS
media_urlslist - Image or video URLs for an MMS.
Outputs
dataobject- The response from Plivo.
Example output
{
"data": {
"api_id": "example",
"message": "example",
"message_uuid": [
"example"
]
}
}