Conferences

Update Conference

Changed on

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.

post/Accounts/{AccountSid}/Conferences/{Sid}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for this conference.

Request body application/x-www-form-urlencoded

Status'completed'

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

AnnounceUrlstring uri

The URL to send conference announcements to.

AnnounceMethod'GET' | 'POST'

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

Example request

{
  "Status": "completed",
  "AnnounceUrl": "https://your-api-endpoint.com/announce",
  "AnnounceMethod": "POST"
}

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

date_createdstring required

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

date_updatedstring required

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

friendly_namestring required

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

status'init' | 'in-progress' | 'completed' required

Conference status.

api_versionstring required

The version of the SignalWire API.

regionstring required

The region where this conference audio was mixed.

uristring required

The URI for this conference.

Example response

{
  "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",
  "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"
  }
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • breaking

      added 'unevaluatedProperties' constraint to the request body

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status