github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsConferencesParticipantsApi.md (about) 1 # AccountsConferencesParticipantsApi 2 3 All URIs are relative to *https://api.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateParticipant**](AccountsConferencesParticipantsApi.md#CreateParticipant) | **Post** /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json | 8 [**DeleteParticipant**](AccountsConferencesParticipantsApi.md#DeleteParticipant) | **Delete** /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json | 9 [**FetchParticipant**](AccountsConferencesParticipantsApi.md#FetchParticipant) | **Get** /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json | 10 [**ListParticipant**](AccountsConferencesParticipantsApi.md#ListParticipant) | **Get** /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json | 11 [**UpdateParticipant**](AccountsConferencesParticipantsApi.md#UpdateParticipant) | **Post** /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json | 12 13 14 15 ## CreateParticipant 16 17 > ApiV2010Participant CreateParticipant(ctx, ConferenceSidoptional) 18 19 20 21 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **ConferenceSid** | **string** | The SID of the participant's conference. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateParticipantParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. 39 **From** | **string** | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint. 40 **To** | **string** | The phone number, SIP address, or Client identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified. 41 **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application. 42 **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`. 43 **StatusCallbackEvent** | **[]string** | The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`. 44 **Label** | **string** | A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant. 45 **Timeout** | **int** | The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds. 46 **Record** | **bool** | Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`. 47 **Muted** | **bool** | Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`. 48 **Beep** | **string** | Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`. 49 **StartConferenceOnEnter** | **bool** | Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference. 50 **EndConferenceOnExit** | **bool** | Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`. 51 **WaitUrl** | **string** | The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic). 52 **WaitMethod** | **string** | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. 53 **EarlyMedia** | **bool** | Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`. 54 **MaxParticipants** | **int** | The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`. 55 **ConferenceRecord** | **string** | Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`. 56 **ConferenceTrim** | **string** | Whether to trim leading and trailing silence from the conference recording. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`. 57 **ConferenceStatusCallback** | **string** | The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored. 58 **ConferenceStatusCallbackMethod** | **string** | The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. 59 **ConferenceStatusCallbackEvent** | **[]string** | The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`. 60 **RecordingChannels** | **string** | The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`. 61 **RecordingStatusCallback** | **string** | The URL that we should call using the `recording_status_callback_method` when the recording status changes. 62 **RecordingStatusCallbackMethod** | **string** | The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. 63 **SipAuthUsername** | **string** | The SIP username used for authentication. 64 **SipAuthPassword** | **string** | The SIP password for authentication. 65 **Region** | **string** | The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. 66 **ConferenceRecordingStatusCallback** | **string** | The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available. 67 **ConferenceRecordingStatusCallbackMethod** | **string** | The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. 68 **RecordingStatusCallbackEvent** | **[]string** | The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`. 69 **ConferenceRecordingStatusCallbackEvent** | **[]string** | The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'` 70 **Coaching** | **bool** | Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined. 71 **CallSidToCoach** | **string** | The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. 72 **JitterBufferSize** | **string** | Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`. 73 **Byoc** | **string** | The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) 74 **CallerId** | **string** | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint. 75 **CallReason** | **string** | The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) 76 **RecordingTrack** | **string** | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio. 77 **TimeLimit** | **int** | The maximum duration of the call in seconds. Constraints depend on account and configuration. 78 **MachineDetection** | **string** | Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection). 79 **MachineDetectionTimeout** | **int** | The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. 80 **MachineDetectionSpeechThreshold** | **int** | The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. 81 **MachineDetectionSpeechEndThreshold** | **int** | The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. 82 **MachineDetectionSilenceTimeout** | **int** | The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000. 83 **AmdStatusCallback** | **string** | The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. 84 **AmdStatusCallbackMethod** | **string** | The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. 85 **Trim** | **string** | Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`. 86 **CallToken** | **string** | A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call. 87 88 ### Return type 89 90 [**ApiV2010Participant**](ApiV2010Participant.md) 91 92 ### Authorization 93 94 [accountSid_authToken](../README.md#accountSid_authToken) 95 96 ### HTTP request headers 97 98 - **Content-Type**: application/x-www-form-urlencoded 99 - **Accept**: application/json 100 101 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 102 [[Back to Model list]](../README.md#documentation-for-models) 103 [[Back to README]](../README.md) 104 105 106 ## DeleteParticipant 107 108 > DeleteParticipant(ctx, ConferenceSidCallSidoptional) 109 110 111 112 Kick a participant from a given conference 113 114 ### Path Parameters 115 116 117 Name | Type | Description 118 ------------- | ------------- | ------------- 119 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 120 **ConferenceSid** | **string** | The SID of the conference with the participants to delete. 121 **CallSid** | **string** | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. 122 123 ### Other Parameters 124 125 Other parameters are passed through a pointer to a DeleteParticipantParams struct 126 127 128 Name | Type | Description 129 ------------- | ------------- | ------------- 130 **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to delete. 131 132 ### Return type 133 134 (empty response body) 135 136 ### Authorization 137 138 [accountSid_authToken](../README.md#accountSid_authToken) 139 140 ### HTTP request headers 141 142 - **Content-Type**: Not defined 143 - **Accept**: Not defined 144 145 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 146 [[Back to Model list]](../README.md#documentation-for-models) 147 [[Back to README]](../README.md) 148 149 150 ## FetchParticipant 151 152 > ApiV2010Participant FetchParticipant(ctx, ConferenceSidCallSidoptional) 153 154 155 156 Fetch an instance of a participant 157 158 ### Path Parameters 159 160 161 Name | Type | Description 162 ------------- | ------------- | ------------- 163 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 164 **ConferenceSid** | **string** | The SID of the conference with the participant to fetch. 165 **CallSid** | **string** | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. 166 167 ### Other Parameters 168 169 Other parameters are passed through a pointer to a FetchParticipantParams struct 170 171 172 Name | Type | Description 173 ------------- | ------------- | ------------- 174 **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource to fetch. 175 176 ### Return type 177 178 [**ApiV2010Participant**](ApiV2010Participant.md) 179 180 ### Authorization 181 182 [accountSid_authToken](../README.md#accountSid_authToken) 183 184 ### HTTP request headers 185 186 - **Content-Type**: Not defined 187 - **Accept**: application/json 188 189 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 190 [[Back to Model list]](../README.md#documentation-for-models) 191 [[Back to README]](../README.md) 192 193 194 ## ListParticipant 195 196 > []ApiV2010Participant ListParticipant(ctx, ConferenceSidoptional) 197 198 199 200 Retrieve a list of participants belonging to the account used to make the request 201 202 ### Path Parameters 203 204 205 Name | Type | Description 206 ------------- | ------------- | ------------- 207 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 208 **ConferenceSid** | **string** | The SID of the conference with the participants to read. 209 210 ### Other Parameters 211 212 Other parameters are passed through a pointer to a ListParticipantParams struct 213 214 215 Name | Type | Description 216 ------------- | ------------- | ------------- 217 **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to read. 218 **Muted** | **bool** | Whether to return only participants that are muted. Can be: `true` or `false`. 219 **Hold** | **bool** | Whether to return only participants that are on hold. Can be: `true` or `false`. 220 **Coaching** | **bool** | Whether to return only participants who are coaching another call. Can be: `true` or `false`. 221 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 222 **Limit** | **int** | Max number of records to return. 223 224 ### Return type 225 226 [**[]ApiV2010Participant**](ApiV2010Participant.md) 227 228 ### Authorization 229 230 [accountSid_authToken](../README.md#accountSid_authToken) 231 232 ### HTTP request headers 233 234 - **Content-Type**: Not defined 235 - **Accept**: application/json 236 237 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 238 [[Back to Model list]](../README.md#documentation-for-models) 239 [[Back to README]](../README.md) 240 241 242 ## UpdateParticipant 243 244 > ApiV2010Participant UpdateParticipant(ctx, ConferenceSidCallSidoptional) 245 246 247 248 Update the properties of the participant 249 250 ### Path Parameters 251 252 253 Name | Type | Description 254 ------------- | ------------- | ------------- 255 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 256 **ConferenceSid** | **string** | The SID of the conference with the participant to update. 257 **CallSid** | **string** | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. 258 259 ### Other Parameters 260 261 Other parameters are passed through a pointer to a UpdateParticipantParams struct 262 263 264 Name | Type | Description 265 ------------- | ------------- | ------------- 266 **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update. 267 **Muted** | **bool** | Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`. 268 **Hold** | **bool** | Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference. 269 **HoldUrl** | **string** | The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. 270 **HoldMethod** | **string** | The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`. 271 **AnnounceUrl** | **string** | The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. 272 **AnnounceMethod** | **string** | The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`. 273 **WaitUrl** | **string** | The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic). 274 **WaitMethod** | **string** | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. 275 **BeepOnExit** | **bool** | Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`. 276 **EndConferenceOnExit** | **bool** | Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`. 277 **Coaching** | **bool** | Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined. 278 **CallSidToCoach** | **string** | The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. 279 280 ### Return type 281 282 [**ApiV2010Participant**](ApiV2010Participant.md) 283 284 ### Authorization 285 286 [accountSid_authToken](../README.md#accountSid_authToken) 287 288 ### HTTP request headers 289 290 - **Content-Type**: application/x-www-form-urlencoded 291 - **Accept**: application/json 292 293 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 294 [[Back to Model list]](../README.md#documentation-for-models) 295 [[Back to README]](../README.md) 296