Latest Legacy

Retrieve a multiparty call

Allows you to retrieve details of a specific multiparty call.

API Endpoint

GET https://api.plivo.com/v1/Account/{auth_id}/MultiPartyCall/name_{mpc_name}/

Arguments

No arguments need to be passed.

Returns

Returns the details of the specific multiparty call.

Note: You can fetch the details of an MPC using its name only for an ongoing multiparty call. For details of a call that has ended, specify the UUID instead of the name.

Response

HTTP Status Code: 200

{
"api_id": "3c45f7da-45c9-11eb-8575-0242ac11000a",
"billed_amount": null,
"billed_duration": null,
"creation_time": "2020-12-24 09:20:03+00:00",
"duration": null,
"end_time": null,
"friendly_name": "test_mpc",
"mpc_uuid": "8742d531-292a-46aa-8754-836be1092885",
"participants": "/v1/Account/MAOTE1OWE0MDK0MTLHYW/MultiPartyCall/name_test_mpc/Participant/",
"recording": "not-recording",
"resource_uri": "/v1/Account/MAOTE1OWE0MDK0MTLHYW/MultiPartyCall/name_test_mpc/",
"start_time": "2020-12-24 09:20:03+00:00",
"status": "Active",
"stay_alone": false,
"sub_account": null,
"termination_cause": null,
"termination_cause_code": null
}

Example Request

1
2
3
4
5
6
import plivo

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

response = client.multi_party_calls.get("6bce28b8-ca38-4998-bd05-25fd8ed0f227")
print(response)
1
2
3
4
5
6
7
8
9
10
11
12
require 'rubygems'
require 'plivo'
include Plivo
include Plivo::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")
begin
  response = api.multipartycalls.get("friendly_name":"mpc_name")
  puts response
rescue PlivoRESTError => e
  puts 'Exception: ' + e.message
end
1
2
3
4
5
6
7
8
9
10
11
12
var plivo = require('plivo');

(function main() {
    'use strict';

    var client = new plivo.Client("<auth_id>","<auth_token>");
    client.multiPartyCalls.get('6bce28b8-ca38-4998-bd05-25fd8ed0f227').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
<?php
require 'vendor/autoload.php';

use Plivo\RestClient;
use Plivo\Exceptions\PlivoRestException;

$client = new RestClient("<auth_id>", "<auth_token>");
try
{
    $response = $client
        ->multiPartyCalls
        ->get(["friendly_name" => "mpc_name", ]);
    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
package com.plivo.examples.multipartycall;

import com.plivo.api.Plivo;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.exceptions.PlivoValidationException;
import com.plivo.api.models.multipartycall.MultiPartyCall;
import com.plivo.api.models.multipartycall.MultiPartyCallUtils;

import java.io.IOException;

class GetMPC {

    public static void main(String[] args) throws IOException, PlivoRestException, PlivoValidationException {
        Plivo.init("<auth_id>", "<auth_token>");
        try {
            MultiPartyCall mpc = MultiPartyCall.getter(MultiPartyCallUtils.mpcUuid("<YOUR-MPC-UUID>")).get();
            System.out.println((mpc.getMpcUuid().equals("<YOUR-MPC-UUID>")));
        } catch (Exception 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
using System;
using Plivo;
using Plivo.Exception;

namespace PlivoExamples
{
    class Program
    {
        static void Main(string[] args)
        {
            var api = new PlivoApi("<auth_id>", "<auth_token>");

            try
            {
                var response = api.MultiPartyCall.Get(mpcUuid: "mpc_uuid");
                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}/MultiPartyCall/name_{mpc_name}/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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 {
        panic(err)
    }
    response, err: = client.MultiPartyCall.Get(plivo.MultiPartyCallBasicParams {
        FriendlyName: "MPC_Name"
    })
    if err != nil {
        panic(err)
    }
    fmt.Printf("Response: %#v\n", response)
}