Conferences

Update Conference

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}

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.

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

Changed in 6 of the 40 revisions of this API.14242

  • 2916d5e3072e22See the full diff
    • the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the sid response property allOf list for the response status 200

      response-property-all-of-added

  • 5344c0c93a4c17See the full diff
    • added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the subresource_uris/allOf[ConferenceSubresourceUris]/ response property for the status 200

      response-property-unevaluated-properties-added

  • d5fbaaddfa3e317See the full diff
    • request property Status was restricted to a list of enum values

      request-property-became-enum

    • the AnnounceUrl request property type/format changed from string/ to string/uri

      request-property-type-changed

    • the region response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • added the new completed enum value to the request property Status

      request-property-enum-value-added

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 422

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

    • removed ConferenceRegion from the region response property allOf list for the response status 200

      response-property-all-of-removed

    • the response property account_sid became required for the status 200

      response-property-became-required

    • the response property api_version became required for the status 200

      response-property-became-required

    • the response property date_created became required for the status 200

      response-property-became-required

    • the response property date_updated became required for the status 200

      response-property-became-required

    • the response property friendly_name became required for the status 200

      response-property-became-required

    • the response property region became required for the status 200

      response-property-became-required

    • the response property sid became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property subresource_uris became required for the status 200

      response-property-became-required

    • the response property subresource_uris/allOf[ConferenceSubresourceUris]/participants became required for the status 200

      response-property-became-required

    • the response property subresource_uris/allOf[ConferenceSubresourceUris]/recordings became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • request body became optional

      request-body-became-optional

  • 07f73f74a61d11See the full diff
    • removed the media type application/json from the request body

      request-body-media-type-removed

    • added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e7214See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter Sid

      new-request-path-parameter

    • request body became required

      request-body-became-required

    • removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • the region response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the subresource_uris response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property subresource_uris/participants from the response with the 200 status

      response-optional-property-removed

    • removed the optional property subresource_uris/recordings from the response with the 200 status

      response-optional-property-removed

    • added the media type application/json to the request body

      request-body-media-type-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added ConferenceRegion to the region response property allOf list for the response status 200

      response-property-all-of-added

    • added ConferenceStatus to the status response property allOf list for the response status 200

      response-property-all-of-added

    • added ConferenceSubresourceUris to the subresource_uris response property allOf list for the response status 200

      response-property-all-of-added

    • removed the au1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the br1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the de1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the ie1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the jp1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the sg1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the us1 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    • removed the us2 enum value from the region response property for the response status 200

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog