Kick Out a Participant

    This request can be triggered to disconnect a Participant from an ongoing MPC.

    API Endpoint

    GET https://api.plivo.com/v1/Account/{Auth Id}/MultiPartyCall/name_{mpc_name}/Participant/{all | member_id}/


    For participant call legs that were added to the MPC using the <MultipartyCall> XML element:

    • If onExitActionUrl is not specified: the participants will be disconnected and the call will proceed to the next element in the XML document.
    • If onExitActionUrl is specified: the participants will be disconnected and the call will proceed to the XML document returned by the onExitActionUrl.

    For participant call legs that were added to the MPC using the Add Participant API:

    • If on_exit_action_url is not specified: MPC will be terminated with the hangup cause “Multiparty Call Ended” (hangup cause code 4020) and hangup cause will be API Request.
    • If on_exit_action_url is specified: the participants will be disconnected and the call will proceed to the XML document returned by the on_exit_action_url.

    Arguments

    No arguments need to be passed.

    Returns

    Returns an acknowledgement that the participant was disconnected from the MPC.

    Response

    HTTP Status Code: 204

    Example Request

    1
    2
    3
    4
    5
    6
    
    import plivo
    
    client = plivo.RestClient(auth_id="your_auth_id", auth_token="your_auth_token")
    
    response = client.multi_party_calls.start_recording(friendly_name='mpc_name', file_format='wav', status_callback_url='https://plivo.com/status')
    print(response)
    
    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.kickParticipant(10, '12345678-90123456').then(function (response) {
            console.log(response);
        }, function (err) {
            console.error(err);
        });
    })();