Update a Conference

Use this endpoint for the Conference method to modify the properties of a conference.

Parameters

Parameter	Description
AnnounceMethod Optional	Whether the request to AnnounceUrl is a GET or a POST. Default is POST.
AnnounceUrl Optional	The URL to send conference announcements to.
Status Optional	The status of the conference. If set to completed, the conference will end and all participants will be removed.

---

Examples

Request

cURL

curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json \
  -X POST \
  -u "YourProjectID:YourAuthToken"

Node.js

const { RestClient } = require('@signalwire/compatibility-api')
const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })

client.conferences('Sid')
      .update()
      .then(conference => console.log(conference.friendlyName))
      .done();

C#

using System;
using System.Collections.Generic;
using Twilio;
using Twilio.Rest.Api.V2010.Account;

class Program
{
    static void Main(string[] args)
    {
        TwilioClient.Init("YourProjectID", "YourAuthToken", new Dictionary<string, object> { ["signalwireSpaceUrl"] = "{SPACE}.signalwire.com" });

        var conference = ConferenceResource.Update(
            pathSid: "Sid"
        );

        Console.WriteLine(conference.FriendlyName);
    }
}

Python

from signalwire.rest import Client as signalwire_client

client = signalwire_client("YourProjectID", "YourAuthToken", signalwire_space_url = 'example.signalwire.com')

conference = client.conferences('Sid') \
                   .update()

print(conference.friendly_name)

Ruby

require 'signalwire/sdk'

@client = Signalwire::REST::Client.new 'YourProjectID', 'YourAuthToken', signalwire_space_url: "example.signalwire.com"

conference = @client.conferences('Sid')
                    .update()

puts conference.friendly_name

---

Request: Terminate a Conference

End an active conference call by setting the status to completed.

cURL

curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json \
  -X POST \
  --data-urlencode "Status=completed"
  -u "YourProjectID:YourAuthToken"

Node.js

const { RestClient } = require('@signalwire/compatibility-api')
const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })

client.conferences('Sid')
      .update({status: 'completed'})
      .then(conference => console.log(conference.friendlyName))
      .done();

C#

using System;
using System.Collections.Generic;
using Twilio;
using Twilio.Rest.Api.V2010.Account;

class Program
{
    static void Main(string[] args)
    {
        TwilioClient.Init("YourProjectID", "YourAuthToken", new Dictionary<string, object> { ["signalwireSpaceUrl"] = "{SPACE}.signalwire.com" });

        var conference = ConferenceResource.Update(
            status: ConferenceResource.UpdateStatusEnum.Completed,
            pathSid: "Sid"
        );

        Console.WriteLine(conference.FriendlyName);
    }
}

Python

from signalwire.rest import Client as signalwire_client

client = signalwire_client("YourProjectID", "YourAuthToken", signalwire_space_url = 'example.signalwire.com')

conference = client.conferences('Sid') \
                   .update(status='completed')

print(conference.friendly_name)

Ruby

require 'signalwire/sdk'

@client = Signalwire::REST::Client.new 'YourProjectID', 'YourAuthToken', signalwire_space_url: "example.signalwire.com"

conference = @client.conferences('Sid')
                    .update(status: 'completed')

puts conference.friendly_name

Responses

200 OK

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "api_version": "2010-04-01",
  "date_created": "Mon, 4 Oct 2018 20:00:45 +0000",
  "date_updated": "Mon, 4 Oct 2018 20:00:46 +0000",
  "friendly_name": null,
  "region": "us1",
  "sid": "b3877c40-da60-4998-90ad-b792e98472ca",
  "status": "completed",
  "subresource_uris": {
    "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472ca/Participants.json",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472ca/Recordings.json"
  },
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472ca.json"
}