Conference Participants

Update a Participant

Changed on

Changes an active voice-conference participant's mute, hold, coaching, wait-audio, or announcement settings by Call SID. Use Update Conference to end or announce to the entire conference, and delete the participant to remove only that caller.

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/{ConferenceSid}/Participants/{CallSid}

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/{ConferenceSid}/Participants/{CallSid}
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

ConferenceSidstring uuid required

Universal Unique Identifier.

The unique identifier for the conference this participant is in.

CallSidstring uuid required

Universal Unique Identifier.

The unique identifier for the Participant call connected to this conference.

Request body application/x-www-form-urlencoded

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.

Coachingboolean

Whether the participant is coaching another call. Requires CallSidToCoach to be set.

CallSidToCoachstring uuid

Universal Unique Identifier.

Holdboolean

Whether or not a participant is on hold.

HoldMethod'GET' | 'POST'

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

HoldUrlstring uri

The URL to send hold music to that will be played when participant is on hold.

Mutedboolean

Whether or not a participant is muted.

WaitUrlstring uri

The URL for wait music to be played while a conference is not yet started.

WaitMethod'GET' | 'POST'

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

Example request

{
  "AnnounceUrl": "https://your-api-endpoint.com/announce",
  "AnnounceMethod": "POST",
  "HoldMethod": "GET",
  "HoldUrl": "https://your-api-endpoint.com/hold-music",
  "WaitUrl": "https://your-api-endpoint.com/wait-music",
  "WaitMethod": "POST"
}

Response

The request has succeeded.

account_sidstring uuid required

Universal Unique Identifier.

call_sidstring uuid required

Universal Unique Identifier.

call_sid_to_coachstring uuid required

Universal Unique Identifier.

coachingboolean required

Whether the participant is coaching another call.

conference_sidstring uuid required

Universal Unique Identifier.

date_createdstring required

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

status'completed' | 'in-progress' required

Conference participant status.

date_updatedstring required

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

end_conference_on_exitboolean required

Whether or not a conference ends when a participant leaves the conference call.

mutedboolean required

Whether or not a participant is muted.

holdboolean required

Whether or not a participant is on hold.

start_conference_on_enterboolean required

Whether or not a conference will begin when this participant enters the conference call.

uristring required

The URI for this conference participant.

Example response

{
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "start_conference_on_enter": true,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      added to the request property allOf list

    • 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

    • breaking

      the response's property format changed 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

      the request property type was generalized from string to no type, and format from uuid to no format

    • info

      added to the response property allOf list for the response 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

    • info

      added to the response property anyOf list for the response status

    • info

      removed subschema #1 from the response property anyOf 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