This method lets you retrieve details of all completed calls. The maximum number of results that you can fetch with a single API call is 20.
GET
https://api.plivo.com/v1/Account/{auth_id}/Call/
subaccount optional |
The ID of a subaccount, if you want to retrieve only calls made from a specific subaccount. |
call_direction optional |
The direction of the call, if you want to filter results by call direction. Allowed values: inbound, outbound |
from_number optional |
The number from which the calls were made, if you want to filter results by source number. You can filter the details by using the exact number or the prefix. |
to_number optional |
The destination number to which the calls were made, if you want to filter results by destination. You can filter the details by using the exact number or the prefix. |
parent_call_uuid optional |
Set this request parameter to the call UUID of an A leg to fetch all the B legs associated with it. |
bill_duration optional |
Filters calls by billed duration in seconds. The filter can be used in these five forms:
|
end_time optional |
Filters calls by their completion time. The time format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. The filter can be used in these five forms:
|
Note: You can combine these filters to get calls that ended in a particular time range.
When no end_time filter is specified, Plivo uses a default search window of the last 7 days. When only end_time__[gt|gte] or end_time__[lt|lte] is specified, Plivo uses a search window of 30 days from/to the specified end_time__[gt|gte] / end_time__[lt|lte]. Timestamps need to be UTC timestamps. |
|
hangup_cause_code optional |
Retrieves calls that were hung up with a specific hangup cause. Refer to our list of hangup causes and sources. |
hangup_source optional |
Retrieves calls that were hung up by a specific hangup source. Refer to our list of hangup causes and sources. |
limit optional |
Limits the number of results retrieved. The maximum it can be set to is 20. Defaults to 20. |
offset optional |
Denotes the number of value items by which the results should be offset. For example, if the results contains 1,000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results. |
stir_verification optional |
For outbound calls: Gives details about the attestation assigned to the call by Plivo For inbound calls: Gives details about the attestation received on the inbound call to your Plivo phone number. Allowed values:
|
Returns the call objects that match the filters specified in the request.
HTTP Status Code: 200
{
"api_id": "8299d094-dc72-11e5-b56c-22000ae90795",
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"answer_time": "2022-10-12 21:57:47+05:30",
"api_id": "52cd2e1d-2bfd-11ec-a7bd-0242ac110005",
"bill_duration": 1,
"billed_duration": 1,
"call_direction": "outbound",
"call_duration": 1,
"call_state": "ANSWER",
"call_uuid": "5607532d-5037-4066-befc-a8b40218dd4f",
"conference_uuid": null,
"end_time": "2022-10-12 21:57:47+05:30",
"from_number": "+12025551111",
"hangup_cause_code": 8011,
"hangup_cause_name": "Invalid Answer XML",
"hangup_source": "Error",
"initiation_time": "2022-10-12 21:57:40+05:30",
"parent_call_uuid": null,
"resource_uri": "/v1/Account/MA2025RK4E639VJFZAGV/Call/5607532d-5037-4066-befc-a8b40218dd4f/",
"stir_verification": "Not Applicable",
"to_number": "sip:sam9461399937766203278@phone.plivo.com",
"total_amount": "0.01667",
"total_rate": "1.00000",
"Stir_attestation":"A",
"voice_network_group": ""
},
{
"answer_time": "2022-10-12 21:57:47+05:30",
"api_id": "52cd2e1d-2bfd-11ec-a7bd-0242ac110005",
"bill_duration": 1,
"billed_duration": 1,
"call_direction": "outbound",
"call_duration": 1,
"call_state": "ANSWER",
"call_uuid": "5607532d-5037-4066-befc-a8b40218dd4f",
"conference_uuid": null,
"end_time": "2022-10-12 21:57:47+05:30",
"from_number": "+12025551111",
"hangup_cause_code": 8011,
"hangup_cause_name": "Invalid Answer XML",
"hangup_source": "Error",
"initiation_time": "2022-10-12 21:57:40+05:30",
"parent_call_uuid": null,
"resource_uri": "/v1/Account/MA2025RK4E639VJFZAGV/Call/5607532d-5037-4066-befc-a8b40218dd4f/",
"stir_verification": "Not Applicable",
"to_number": "sip:sam9461399937766203278@phone.plivo.com",
"total_amount": "0.01667",
"total_rate": "1.00000",
"Stir_attestation":"A",
"voice_network_group": ""
}
]
}
1
2
3
4
5
6
7
8
import plivo
client = plivo.RestClient('<auth_id>','<auth_token>')
response = client.calls.list(
limit=5,
offset=0, )
print(response)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
# Example for Call List
#
require 'rubygems'
require 'plivo'
include Plivo
include Plivo::Exceptions
api = RestClient.new("<auth_id>","<auth_token>")
begin
response = api.calls.list(
limit: 5,
offset: 0
)
puts response
rescue PlivoRESTError => e
puts 'Exception: ' + e.message
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Example for Call list
var plivo = require('plivo');
(function main() {
'use strict';
// If auth id and auth token are not specified, Plivo will fetch them from the environment variables.
var client = new plivo.Client("<auth_id>","<auth_token>");
client.calls.list(
{
limit: 5,
offset: 0,
},
).then(function (response) {
console.log(response);
}, function (err) {
console.error(err);
});
})();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
/**
* Example for Call list
*/
require 'vendor/autoload.php';
use Plivo\RestClient;
use Plivo\Exceptions\PlivoRestException;
$client = new RestClient("<auth_id>","<auth_token>");
try {
$response = $client->calls->list(
[
'limit' => 5,
'offset' => 2
]
);
print_r($response);
}
catch (PlivoRestException $ex) {
print_r($ex);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.plivo.api.samples.call;
import java.io.IOException;
import com.plivo.api.Plivo;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.call.Call;
import com.plivo.api.models.base.ListResponse;
/**
* Example for Call list
*/
class CallList {
public static void main(String [] args) {
Plivo.init("<auth_id>","<auth_token>");
try {
ListResponse<Call> response = Call.lister()
.limit(5)
.offset(0)
.list();
System.out.println(response);
} catch (PlivoRestException | IOException e) {
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
* Example for Call List
*/
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Exception;
namespace PlivoExamples
{
internal class Program
{
public static void Main(string[] args)
{
var api = new PlivoApi("<auth_id>","<auth_token>");
try
{
var response = api.Call.List(
limit:5,
offset:0
);
Console.WriteLine(response);
}
catch (PlivoRestException e)
{
Console.WriteLine("Exception: " + e.Message);
}
}
}
}
1
2
curl -i --user AUTH_ID:AUTH_TOKEN \
https://api.plivo.com/v1/Account/{auth_id}/Call/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Example for Call list
package main
import (
"fmt"
"github.com/plivo/plivo-go/v7"
)
func main() {
client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
if err != nil {
fmt.Print("Error", err.Error())
return
}
response, err := client.Calls.List(
plivo.CallListParams{
Limit: 5,
Offset: 0,
},
)
if err != nil {
fmt.Print("Error", err.Error())
return
}
fmt.Printf("Response: %#v\n", response)
}