github.com/twilio/twilio-go@v1.20.1/rest/proxy/v1/docs/ServicesSessionsParticipantsApi.md (about) 1 # ServicesSessionsParticipantsApi 2 3 All URIs are relative to *https://proxy.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateParticipant**](ServicesSessionsParticipantsApi.md#CreateParticipant) | **Post** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants | 8 [**DeleteParticipant**](ServicesSessionsParticipantsApi.md#DeleteParticipant) | **Delete** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} | 9 [**FetchParticipant**](ServicesSessionsParticipantsApi.md#FetchParticipant) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} | 10 [**ListParticipant**](ServicesSessionsParticipantsApi.md#ListParticipant) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants | 11 12 13 14 ## CreateParticipant 15 16 > ProxyV1Participant CreateParticipant(ctx, ServiceSidSessionSidoptional) 17 18 19 20 Add a new Participant to the Session 21 22 ### Path Parameters 23 24 25 Name | Type | Description 26 ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. 29 **SessionSid** | **string** | The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. 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 **Identifier** | **string** | The phone number of the Participant. 39 **FriendlyName** | **string** | The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.** 40 **ProxyIdentifier** | **string** | The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool. 41 **ProxyIdentifierSid** | **string** | The SID of the Proxy Identifier to assign to the Participant. 42 43 ### Return type 44 45 [**ProxyV1Participant**](ProxyV1Participant.md) 46 47 ### Authorization 48 49 [accountSid_authToken](../README.md#accountSid_authToken) 50 51 ### HTTP request headers 52 53 - **Content-Type**: application/x-www-form-urlencoded 54 - **Accept**: application/json 55 56 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 57 [[Back to Model list]](../README.md#documentation-for-models) 58 [[Back to README]](../README.md) 59 60 61 ## DeleteParticipant 62 63 > DeleteParticipant(ctx, ServiceSidSessionSidSid) 64 65 66 67 Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanently deleted when the [Session](https://www.twilio.com/docs/proxy/api/session) is deleted. 68 69 ### Path Parameters 70 71 72 Name | Type | Description 73 ------------- | ------------- | ------------- 74 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 75 **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to delete. 76 **SessionSid** | **string** | The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to delete. 77 **Sid** | **string** | The Twilio-provided string that uniquely identifies the Participant resource to delete. 78 79 ### Other Parameters 80 81 Other parameters are passed through a pointer to a DeleteParticipantParams struct 82 83 84 Name | Type | Description 85 ------------- | ------------- | ------------- 86 87 ### Return type 88 89 (empty response body) 90 91 ### Authorization 92 93 [accountSid_authToken](../README.md#accountSid_authToken) 94 95 ### HTTP request headers 96 97 - **Content-Type**: Not defined 98 - **Accept**: Not defined 99 100 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 101 [[Back to Model list]](../README.md#documentation-for-models) 102 [[Back to README]](../README.md) 103 104 105 ## FetchParticipant 106 107 > ProxyV1Participant FetchParticipant(ctx, ServiceSidSessionSidSid) 108 109 110 111 Fetch a specific Participant. 112 113 ### Path Parameters 114 115 116 Name | Type | Description 117 ------------- | ------------- | ------------- 118 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 119 **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to fetch. 120 **SessionSid** | **string** | The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to fetch. 121 **Sid** | **string** | The Twilio-provided string that uniquely identifies the Participant resource to fetch. 122 123 ### Other Parameters 124 125 Other parameters are passed through a pointer to a FetchParticipantParams struct 126 127 128 Name | Type | Description 129 ------------- | ------------- | ------------- 130 131 ### Return type 132 133 [**ProxyV1Participant**](ProxyV1Participant.md) 134 135 ### Authorization 136 137 [accountSid_authToken](../README.md#accountSid_authToken) 138 139 ### HTTP request headers 140 141 - **Content-Type**: Not defined 142 - **Accept**: application/json 143 144 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 145 [[Back to Model list]](../README.md#documentation-for-models) 146 [[Back to README]](../README.md) 147 148 149 ## ListParticipant 150 151 > []ProxyV1Participant ListParticipant(ctx, ServiceSidSessionSidoptional) 152 153 154 155 Retrieve a list of all Participants in a Session. 156 157 ### Path Parameters 158 159 160 Name | Type | Description 161 ------------- | ------------- | ------------- 162 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 163 **ServiceSid** | **string** | The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resources to read. 164 **SessionSid** | **string** | The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resources to read. 165 166 ### Other Parameters 167 168 Other parameters are passed through a pointer to a ListParticipantParams struct 169 170 171 Name | Type | Description 172 ------------- | ------------- | ------------- 173 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 174 **Limit** | **int** | Max number of records to return. 175 176 ### Return type 177 178 [**[]ProxyV1Participant**](ProxyV1Participant.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