REST Client MethodsConference Participants

Update

View as Markdown

Use this endpoint for the Conference Participants method to modify the properties of participant in an active conference call.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
CallSidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.

Request

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`.
Allowed values:
CoachingbooleanOptional
Whether the participant is coaching another call. Requires `CallSidToCoach` to be set.
CallSidToCoachstringOptionalformat: "uuid"
The unique identifier of the participant who is being coached. Required when `Coaching` is true.
HoldbooleanOptional
Whether or not a participant is on hold.
HoldMethodenumOptionalDefaults to GET
Whether the request to `HoldUrl` is a `GET` or a `POST`. Default is `GET`.
Allowed values:
HoldUrlstringOptionalformat: "uri"
The URL to send hold music to that will be played when participant is on hold.
MutedbooleanOptional
Whether or not a participant is muted.
WaitUrlstringOptionalformat: "uri"
The URL for wait music to be played while a conference is not yet started.
WaitMethodenumOptionalDefaults to POST
Whether the request to `WaitUrl` is a `GET` or a `POST`. Default is `POST`.
Allowed values:

Response

account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
call_sidstringRequiredformat: "uuid"
The unique identifier for the Participant call connected to this conference.
call_sid_to_coachstring or nullRequiredformat: "uuid"
The unique identifier of the participant who is being coached.
coachingbooleanRequired
Whether the participant is coaching another call.
conference_sidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
date_createdstringRequired
The date, in RFC 2822 format, this conference participant was created.
statusenumRequired
The status of the conference call.
Allowed values:
date_updatedstringRequired
The date, in RFC 2822 format, this conference participant was updated.
end_conference_on_exitbooleanRequired
Whether or not a conference ends when a participant leaves the conference call.
mutedbooleanRequired
Whether or not a participant is muted.
holdbooleanRequired
Whether or not a participant is on hold.
start_conference_on_enterbooleanRequired
Whether or not a conference will begin when this participant enters the conference call.
uristringRequired
The URI for this conference participant.

Request examples

Update a participant

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5      .participants('CallSid')
6      .update()
7      .then(participant => console.log(participant.callSid))
8      .done();

Coaching a participant

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5.participants('CallSid')
6.update({Muted: false, Coaching: true, Beep: false, CallSidToCoach: 'CallSidToCoach'})
7.then(participant => console.log(participant.callSid))
8.done();

Monitoring a conference

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5.participants('CallSid')
6.update({muted: true, coaching: true, beep: false, callSidToCoach: 'CallSidToCoach'})
7.then(participant => console.log(participant.callSid))
8.done();

Barge a conference

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5.participants('CallSid')
6.update({muted: false, coaching: false, callSidToCoach: ''})
7.then(participant => console.log(participant.callSid))
8.done();

Mute a participant

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5      .participants('CallSid')
6      .update({muted: true})
7      .then(participant => console.log(participant.callSid))
8      .done();

Put a participant on hold

In this example, we will place a participant in an active conference on hold and play hold music.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.conferences('ConferenceSid')
5      .participants('CallSid')
6      .update({hold: true, holdUrl: 'http://www.your-application.com/hold'})
7      .then(participant => console.log(participant.callSid))
8      .done();