Retrieve participant details

    This method retrieves the details of a particular multiparty call (MPC) participant.

    API Endpoint

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

    Arguments

    No arguments need to be passed.

    Returns

    Returns the details of the specific ongoing MPC participant.

    Note: Returns a null value if the MPC has ended or the participant is no longer active in (has exited from) the MPC.

    Response

    HTTP Status Code: 200

    {
      "api_id": "3eecec6d-45cf-11eb-9014-0242ac110003",
      "billed_amount": null,
      "billed_duration": null,
      "call_uuid": "dd473c48-34a6-4d67-a033-af590b41c23f",
      "coach_mode": false,
      "duration": null,
      "end_mpc_on_exit": false,
      "exit_cause": null,
      "exit_time": null,
      "hold": false,
      "join_time": "2020-12-24 10:01:56+00:00",
      "member_id": "355",
      "mpc_uuid": "4e9ae3f1-a29c-4524-a1b4-4758922e589b",
      "mute": false,
      "resource_uri": "/v1/Account/MAOTE1OWE0MDK0MTLHYW/MultiPartyCall/name_test_mpc_1/Participant/355/",
      "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.get_participant(participant_id=member_id, uuid=uuid)
    print(response)
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    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.get_participant(
        "friendly_name":"mpc_name",
        "member_id":"memberid")
      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.getParticipant(2132, '7503f05f-2d6e-4ab3-b9e6-3b0d81ae9087', 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
            ->getParticipant("member_id", ["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
    
    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;
    
    public class GetParticipant {
    
        public static void main(String[] args) throws PlivoValidationException, IOException, PlivoRestException {
            Plivo.init("<auth_id>", "<auth_token>");
            try {
                MultiPartyCall.participantGetter(MultiPartyCallUtils.mpcUuid("<YOUR-MPC-UUID>"), "member_id").get();
            } 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
    26
    
    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/{Member Id}/
    
    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 {
            panic(err)
        }
        response, err: = client.MultiPartyCall.GetParticipant(plivo.MultiPartyCallParticipantParams {
            FriendlyName: "MPC_Name",
            ParticipantId: "member_id"
        })
        if err != nil {
            panic(err)
        }
        fmt.Printf("Response: %#v\n", response)
    }