Update Member

Update a member status/properties.

Request URL

POSThttps://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}/members/{memberId}


Supported Parameters

Parameter Description Mandatory
state If completed, member will be removed from the conference. No
joinTone If true, will play a tone when the member joins the conference. If false, no tone is played when the member joins the conference. No
leavingTone If true, will play a tone when the member leaves the conference. If false, no tone is played when the member leaves the conference. No
mute If true, member can’t speak in the conference. If false, this members can speak in the conference (unless set at the conference level). No
hold If true, member can’t hear or speak in the conference. If false, member can hear and speak in the conference (unless set at the conference level). No

Example 1 of 3: Remove member from conference

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}/members/{memberId} \
    -u {token}:{secret} \
    -H "Content-type: application/json" \
    -d \
    '
    {
        "state": "completed"
    }'
// Promise
client.Conference.updateMember("conferenceID", "memberId", {state: "completed"}).then(function(){});
// Callback
client.Conference.updateMember("conferenceID", "memberId", {state: "completed"}, function(err){});
await client.Conference.UpdateMemberAsync("{conferenceId1}", "{memberId1}", new UpdateMemberData {State = MemberState.Completed});
member.update(:state=>completed)

Example 2 of 3: Keep member from speaking in the conference

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}/members/{memberId} \
    -u {token}:{secret} \
    -H "Content-type: application/json" \
    -d \
    '
    {
        "mute": "true"
    }'
// Promise
client.Conference.updateMember("conferenceID", "memberId", {mute: "true"}).then(function(){});
// Callback
client.Conference.updateMember("conferenceID", "memberId", {mute: "true"}, function(err){});
await client.Conference.MuteMemberAsync("{conferenceId1}", "{memberId1}", true);
member.update(:mute=>true)

Example 3 of 3: Keep member from hearing the conference audio

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}/members/{memberId} \
    -u {token}:{secret} \
    -H "Content-type: application/json" \
    -d \
    '
    {
        "hold": "true"
    }'
// Promise
client.Conference.updateMember("conferenceID", "memberId", {hold: "true"}).then(function(){});
// Callback
client.Conference.updateMember("conferenceID", "memberId", {hold: "true"}, function(err){});
await client.Conference.HoldMemberAsync("{conferenceId1}", "{memberId1}", true);
member.update(:hold=>true)

results matching ""

    No results matching ""