Update Conference

Change the conference properties and/or status.

Request URL

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


Supported Parameters

Parameter Description Mandatory
state Conference state. Possible state values are: completed to terminate the conference. No
hold If true, all member can’t hear or speak in the conference. If false, all members can hear and speak in the conference (unless set at the member level). No
mute If true, all member can’t speak in the conference. If false, all members can speak in the conference (unless set at the member level). No
callbackUrl The complete URL where the events related to the Conference will be sent to. No
callbackHttpMethod Determine if the callback event should be sent via HTTP GET or HTTP POST. Values are GET or POST, default: POST. No
callbackTimeout Determine how long should the platform wait for callbackUrl’s response before timing out in milliseconds.
Maximum Time: 10000 (10s)
No
fallbackUrl The URL used to send the callback event if the request to callbackUrl fails. No
tag A string that will be included in the callback events of the conference. No

Example 1 of 2: Terminate Conference

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId} \
    -u {token}:{secret} \
    -H "Content-type: application/json" \
    -d \
    '
    {
        "state": "completed"
    }'
// Promise
client.Conference.update("conferenceID", {state: "completed"}).then(function(){});
// Callback
client.Conference.update("conferenceID", {state: "completed"}, function(err){});
await client.Conference.TerminateAsync("{conferenceId1}");
conference.complete()

Example 2 of 2: Prevent all members from speaking

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

results matching ""

    No results matching ""