API Overview

All Plivo APIs use HTTP verbs and standard HTTP status codes. To secure requests, all APIs are served over HTTPS. API Endpoint

https://api.plivo.com/v1/

The current version of the APIs is v1. Server SDKs are versioned as latest and legacy.

Authentication

All requests to Plivo API are authenticated with BasicAuth using your AUTH ID and AUTH TOKEN. Find your credentials on the Plivo console.

import plivo

client = plivo.RestClient('<auth_id>', '<auth_token>')

const plivo = require('plivo');

const client = new plivo.Client('<auth_id>', '<auth_token>');

require 'plivo'

client = Plivo::RestClient.new('<auth_id>', '<auth_token>')

<?php
require 'vendor/autoload.php';
use Plivo\RestClient;

$client = new RestClient('<auth_id>', '<auth_token>');

import com.plivo.api.Plivo;

Plivo.init("<auth_id>", "<auth_token>");

using Plivo;

var api = new PlivoApi("<auth_id>", "<auth_token>");

package main

import "github.com/plivo/plivo-go/v7"

func main() {
    client, _ := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
}

curl -u "<auth_id>:<auth_token>" \
    https://api.plivo.com/v1/Account/{auth_id}/

Content Type

Plivo only accepts input of type application/json.

POST requests: Arguments must be passed as JSON with Content-Type: application/json
GET and DELETE requests: Arguments must be passed in the query string

Timeouts and Proxies

Server SDKs support specifying timeouts and proxy settings for API requests.

import plivo

proxies = {
    'http': 'https://username:password@proxyurl:proxyport',
    'https': 'https://username:password@proxyurl:proxyport'
}
client = plivo.RestClient('<auth_id>', '<auth_token>', proxies=proxies, timeout=5)

const plivo = require('plivo');

let options = {
    'timeout': 5000,
    'host': 'https://proxyurl',
    'port': 'proxyport',
    auth: {
        username: 'my-user',
        password: 'my-password'
    }
};

const client = new plivo.Client('<auth_id>', '<auth_token>', options);

require 'plivo'

proxy = {
    proxy_host: "https://proxyurl",
    proxy_port: "proxyport",
    proxy_user: "username",
    proxy_pass: "password"
}
client = Plivo::RestClient.new('<auth_id>', '<auth_token>', proxy, timeout=5)

<?php
require 'vendor/autoload.php';
use Plivo\RestClient;

$client = new RestClient('<auth_id>', '<auth_token>', 'https://proxyurl', 'proxyport', 'username', 'password');
$client->client->setTimeout(5);

using Plivo;

var api = new PlivoApi(
    "<auth_id>", "<auth_token>",
    "https://proxyurl", "proxyport", "username", "password");
api.Client.SetTimeout(10);

package main

import "github.com/plivo/plivo-go/v7"

func main() {
    client, _ := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{
        Timeout: 5 * time.Second,
    })
}

Pagination

Plivo uses offset-based pagination to list resources.

Parameter	Description
`limit`	Number of results to return. Range: 1-20. Default: 20.
`offset`	Number of results to skip for pagination.

For example, with 100 results, limit=10 and offset=50 returns objects 51-60.

Asynchronous Requests

All Plivo API requests can be made asynchronous. When an async call is made, Plivo returns a generic response with the api_id, and the actual response is sent to your callback URL.

Parameter	Description
`callback_url`	URL to receive the API response.
`callback_method`	HTTP method for the callback. Default: `POST`.

Async Response

{
  "message": "async api spawned",
  "api_id": "63f0761a-e0ed-11e1-8ea7-12313924e3a6"
}

HTTP Status Codes

Code	Description
`200`	Request executed successfully
`201`	Resource created
`202`	Resource changed
`204`	Resource deleted
`400`	Parameter missing or invalid
`401`	Authentication failed
`404`	Resource not found
`405`	HTTP method not allowed
`429`	Too many requests (rate limited)
`500`	Server error

Response Format

All API responses are in JSON format. Every response includes an api_id to uniquely identify your request.

Field	Description
`api_id`	Unique identifier for the request.
`message`	Information about the request result.
`error`	Error details if the request failed.

{
  "api_id": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "message": "call fired",
  "request_uuid": "75b26856-8638-11e0-802c-6d99d509954e"
}

{
  "api_id": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "error": "answer_url parameter is missing"
}

Concepts

API Reference

API Overview

Authentication

Content Type

Timeouts and Proxies

Asynchronous Requests

HTTP Status Codes

Response Format

​Authentication

​Content Type

​Timeouts and Proxies

​Pagination

​Asynchronous Requests

​HTTP Status Codes

​Response Format

Authentication

Content Type

Timeouts and Proxies

Pagination

Asynchronous Requests

HTTP Status Codes

Response Format