Conference Member

The following actions can be performed with the Member APIs:

BaseURI: https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member

Hangup a Member

This API lets you hangup a particular member in a conference by using the member ID.

DELETE https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/

The member_id attribute which is passed in the URL can be one of the following two forms:

  1. Member ID: The member specified by the member_id.
  2. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Arguments

None

Response

HTTP Status Code: 204

{
  "message": "hangup",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Kick Member

This API lets you kick a member out of a conference. When a member is kicked out of a conference, action is performed based on the next element in the XML.

POST https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/

For eg. If the XML to start the conference is the one below, Plivo will play the text in the <Speak> tag after the member has been kicked.

<Response>
    <Conference enterSound="beep:1">MyConference</Conference>
    <Speak>Good bye. You have been kicked out of the conference</Speak>
</Response>

The member_id attribute which is passed in the URL can be one of the following two forms:

  1. Member ID: The member specified by the member_id.
  2. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

None

Response

HTTP Status Code: 202

{
  "message": "kicked",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Mute Member

This API lets you mute members in a conference. When a member is muted, audio from their device will be muted and other members in the conference will not be able to hear the caller.

POST https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

None

Response

HTTP Status Code: 202

{
  "message": "muted",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Unmute Member

This API lets you unmute members which have been muted by the Mute Member API.

DELETE https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

None

Response

HTTP Status Code: 204


Play Sound to Member

This API lets you play a mp3 or a wav file to a member in the conference.

POST https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

Parameter Description
url (mandatory) URL of the sound file to be played.

Response

HTTP Status Code: 202

{
  "message" : "play queued into conference",
  "api_id" : "4e44bd4e-f830-11e6-b886-067c5485c240",
  "member_id" : "[u'160005', u'160004', u'160003', u'160002']"
}

Stop Playing Sound to Member

This API will stop the file which is being played to a member initiated by the Play API

DELETE https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

None

Response

HTTP Status Code: 204

{
  "message": "playing in conference stopped",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Play Text to Member

This API will play text to a member in a conference.

POST https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Speak/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

The following parameters are required to make the member(s) in a conference listen to a speech:

Parameters

Parameter Description
text(mandatory) The text that the member must hear.
voice(optional) The voice to be used. Can be MAN or WOMAN. Defaults to WOMAN.
language The language to be used, see Supported voices and languages below. Defaults to en-US .

Response

HTTP Status Code: 202

{
  "message" : "speak queued into conference",
  "api_id" : "8dd6820e-fe83-11e6-b6f4-061564b78b75",
  "member_id" : "[u'all']"
}

Supported voice and languages

Language Value WOMAN Voice MAN Voice
Danishda-DKyesyes
Dutchnl-NLyesyes
English - Australianen-AUyesyes
English - Britishen-GByesyes
English - USAen-USyesyes
Frenchfr-FRyesyes
French - Canadianfr-CAyesno
Germande-DEyesyes
Italianit-ITyesyes
Polishpl-PLyesyes
Portuguesept-PTnoyes
Portuguese - Brazilianpt-BRyesyes
Russianru-RUyesno
Spanishes-ESyesyes
Spanish - USAes-USyesyes
Swedishsv-SEyesno

Stop Playing Text to Member

This API will stop playing text to a member in a conference which was initiated by the Play Text API

DELETE https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Speak/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attribues

None

Response

HTTP Status Code: 204

{
  "message": "speak stopped",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Make Member Deaf

This API lets you deaf a particular member. When this operation is made on a conference member, the member will not be able to hear any audio from the conference.

POST https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attributes

None

Response

HTTP Status Code: 202

{
  "message": "deaf",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Enable Hearing For Member

This API lets you un-deaf a member in a conference.

DELETE https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/

The member_id attribute which is passed in the URL can be one of the following three forms:

  1. Member ID: The member specified by the member_id.
  2. Comma separated list of member IDs: List of member IDs on which this operation will be performed.
  3. ‘all’: The string ‘all’, this action will be performed on all members of the conference.

Attribues

None

Response

HTTP Status Code: 204