Plivo

App · 16 actions

Send messages, make calls and look up Plivo message, call and recording records.

Actions

ActionWhat it does
Delete a recordingDelete a recording.
Get a application recordGet a application record.
Get a call recordGet a call record.
Get a endpoint recordGet a endpoint record.
Get a message recordGet a message record.
Get a number recordGet a number record.
Get a recording recordGet a recording record.
Get account detailsGet account details.
List applicationsList applications.
List completed callsList completed calls.
List message recordsList message records.
List recordingsList recordings.
List SIP endpointsList SIP endpoints.
List your phone numbersList your phone numbers.
Make an outbound callMake an outbound call.
Send an SMS or MMSSend an SMS or MMS.

Delete a recording

Delete a recording.

Inputs

Recording IDrecording_idtextRequired
Recording ID.

Outputs

dataobject
The response from Plivo.
Example output
{
  "data": {}
}

Get a application record

Get a application record.

Inputs

Appapp_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 uuidcall_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

Endpointendpoint_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 uuidmessage_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

NumbernumbertextRequired
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 IDrecording_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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.
App nameapp_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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.
Call directioncall_directiontext
Call direction.One of: inbound, outbound.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
From numberfrom_numbertext
From number.
To numberto_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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.
Message directionmessage_directiontext
Message direction.One of: inbound, outbound.
Message statemessage_statetext
Message state.One of: queued, sent, delivered, undelivered, failed, received.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
From numberfrom_numbertext
From number.
To numberto_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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.
Call uuidcall_uuidtext
Call uuid.
From numberfrom_numbertext
From number.
To numberto_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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
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

Limitlimitnumber
Limit.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.
Number typenumber_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 numberfrom_numbertextRequired
From number.
To numberto_numbertextRequired
To number.
Answer URLanswer_urltextRequired
Answer URL.
Answer methodanswer_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 numberfrom_numbertextRequired
From number.
To numberto_numbertextRequired
To number.
Texttexttext
Text.
Typetypetext
Type.One of: sms, mms.
Media URLSmedia_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"
    ]
  }
}

On this page