Update active Conference Member

Update properties of an active conference member.

Request URL

PUThttps://voice.bandwidth.com/api/v2/accounts/{accountId}/conferences/{conferenceId}/members/{memberId}

Basic Authentication

Bandwidth's Voice API leverages Basic Authentication with your Dashboard API Credentials. Read more about how Bandwidth secures endpoints in the Security & Credentials document.


Supported Parameters

Parameter Description Mandatory
mute (optional) If true, member can't speak in the conference. If omitted, the parameter will not be modified. No
hold (optional) If true, member can't speak or hear in the conference. If omitted, the parameter will not be modified. No
callIdsToCoach (optional) Updates the list of calls to be coached by this member.
When a list of callIds is given:
  • If the member being updated is already the coach of the conference, updates the calls being coached.
  • If there is no coach in the conference, sets the member being updated as the coach of the given calls.
  • A conference may only have one coach, so setting this on a member when there is already a coach in the conference results in an error.
Note that this will not add the matching calls to the conference; each call must individually execute a <Conference> verb to join. If omitted, the parameter will not be modified.
No

Example 1 of 2 : Put an active conference member on mute

curl -X PUT \
    --url 'https://voice.bandwidth.com/api/v2/accounts/{accountId}/conferences/{conferenceId}/members/{memberId}' \
    -u '{username}:{password}' \
    -H 'Content-type: application/json' \
    --data-raw '
    {
      "mute"       : true
    }'
HTTP/1.1 204
// TODO
// TODO
# TODO
# TODO
// TODO
// TODO

Example 2 of 2 : Unmute a conference member and set it as coach

curl -X PUT \
    --url 'https://voice.bandwidth.com/api/v2/accounts/{accountId}/conferences/{conferenceId}/members/{memberId}' \
    -u '{username}:{password}' \
    -H 'Content-type: application/json' \
    --data-raw '
    {
      "mute"           : false,
      "callIdsToCoach" : ["c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d", "c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f"]
    }'
HTTP/1.1 204
// TODO
// TODO
# TODO
# TODO
// TODO
// TODO

results matching ""

    No results matching ""