Update Conference | SignalWire

{
  "sid": "b3877c40-da60-4998-90ad-b792e98472cf",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "friendly_name": "My Conference Room",
  "status": "init",
  "api_version": "2010-04-01",
  "region": "us1",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
  "subresource_uris": {
    "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
  }
}

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Ends a voice conference or plays an announcement into the conference identified by SID. Use participant operations to mute, hold, coach, announce to, or remove one caller; Video Conference configuration uses the separate Video API. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"

The unique identifier for the account that created this conference.

SidstringRequiredformat: "uuid"

The unique identifier for this conference.

Request

This endpoint expects an object.

StatusenumOptional

The status of this conference. Only 'completed' is allowed to end the conference.

AnnounceUrlstringOptionalformat: "uri"

The URL to send conference announcements to.

AnnounceMethodenumOptionalDefaults to POST

Whether the request to AnnounceUrl is a GET or a POST. Default is POST.

Response

The request has succeeded.

sidstringformat: "uuid"

The unique identifier for this conference.

account_sidstringformat: "uuid"

The unique identifier for the account that created this conference.

date_createdstring

The date, in RFC 2822 format, this conference was created.

date_updatedstring

The date, in RFC 2822 format, this conference was updated.

friendly_namestring

A description, up to 64 characters, of the conference room.

statusenum

The status of this conference.

api_versionstring

The version of the SignalWire API.

regionstring

The region where this conference audio was mixed.

uristring

The URI for this conference.

subresource_urisobject

The links to associated subresources.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

503

Service Unavailable Error