Retrieve all participant details

    This method retrieves details of a list of participants in an ongoing multiparty call.

    API Endpoint

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

    Arguments

    No arguments need to be passed.

    Returns

    Returns the details of all the participants in the specified ongoing multiparty call.

    Response

    HTTP Status Code: 200

    {
      "api_id": "2de9cf75-9606-11eb-8ca5-0242ac110006",
      "meta": {
        "count": 3,
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null
      },
      "objects": [
        {
          "billed_amount": null,
          "billed_duration": null,
          "call_uuid": "58e76e86-54b8-402e-9d83-a16e29b6582c",
          "coach_mode": true,
          "duration": null,
          "end_mpc_on_exit": false,
          "exit_cause": null,
          "exit_time": null,
          "hold": false,
          "join_time": "2021-04-05 11:57:51+00:00",
          "member_id": "229",
          "mpc_uuid": "d5c8be43-87d0-4ba6-90a1-011bb6ab0a00",
          "mute": false,
          "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4QA/MultiPartyCall/name_test_mpc_1/Participant/229/",
          "role": "supervisor",
          "start_mpc_on_enter": true
        },
        {
          "billed_amount": null,
          "billed_duration": null,
          "call_uuid": "9def1955-870f-4052-84ca-02063d24105d",
          "coach_mode": false,
          "duration": null,
          "end_mpc_on_exit": false,
          "exit_cause": null,
          "exit_time": null,
          "hold": false,
          "join_time": "2021-04-05 11:57:32+00:00",
          "member_id": "228",
          "mpc_uuid": "d5c8be43-87d0-4ba6-90a1-011bb6ab0a00",
          "mute": false,
          "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4QA/MultiPartyCall/name_test_mpc_1/Participant/228/",
          "role": "customer",
          "start_mpc_on_enter": true
        },
        {
          "billed_amount": null,
          "billed_duration": null,
          "call_uuid": "b4e8210e-9cd5-4d92-b989-2ff889ee0e1f",
          "coach_mode": false,
          "duration": null,
          "end_mpc_on_exit": false,
          "exit_cause": null,
          "exit_time": null,
          "hold": false,
          "join_time": "2021-04-05 11:56:38+00:00",
          "member_id": "226",
          "mpc_uuid": "d5c8be43-87d0-4ba6-90a1-011bb6ab0a00",
          "mute": false,
          "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4QA/MultiPartyCall/name_test_mpc_1/Participant/226/",
          "role": "agent",
          "start_mpc_on_enter": true
        }
      ]
    }
    

    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.list_participants(friendly_name=mpc_name, uuid=mpc_uuid)
    print(response)
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    
    require "rubygems"
    require "/root/plivo-ruby/lib/plivo.rb"
    include Plivo
    include Plivo::Exceptions
    
    api = RestClient.new("<auth_id>","<auth_token>")
    begin
      response = api.multipartycalls.list_participants("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.listParticipants('6bce28b8-ca38-4998-bd05-25fd8ed0f227', null).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
            ->listParticipants(["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
    23
    24
    25
    26
    27
    28
    29
    30
    
    package com.plivo.examples.multipartycall;
    
    import com.plivo.api.Plivo;
    import com.plivo.api.exceptions.PlivoValidationException;
    import com.plivo.api.exceptions.PlivoRestException;
    import com.plivo.api.models.base.ListResponse;
    import com.plivo.api.models.multipartycall.MultiPartyCall;
    import com.plivo.api.models.multipartycall.MultiPartyCallParticipant;
    import com.plivo.api.models.multipartycall.MultiPartyCallParticipantList;
    import com.plivo.api.models.multipartycall.MultiPartyCallUtils;
    
    import java.io.IOException;
    
    public class ListParticipants {
    
      public static void main(String[] args) throws IOException, PlivoRestException, PlivoValidationException {
        Plivo.init("<auth_id>", "<auth_token>");
    
        try
        {
          MultiPartyCallParticipantList participantList1 = MultiPartyCall.participantList(MultiPartyCallUtils.mpcUuid("myMPCUuid1"));
          ListResponse<MultiPartyCallParticipant> resp1 = participantList1.list();
          System.out.println(resp1);
        }
          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.ListParticipants(friendlyName: "mpc_name");
                    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}/Participant/
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/plivo/plivo-go"
    )
    
    func main() {
    	client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
    	if err != nil {
    			fmt.Print("Error", err.Error())
    			return
    		}
    	response, err := client.MultiPartyCall.ListParticipants(plivo.MultiPartyCallBasicParams{MpcUuid: "mpc_uuid"}, plivo.MultiPartyCallListParticipantParams{})
    	if err != nil {
    			fmt.Print("Error", err.Error())
    			return
    		}
    	fmt.Printf("Response: %#v\n", response)
    
    }