github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/docs/ServicesConversationsParticipantsApi.md (about) 1 # ServicesConversationsParticipantsApi 2 3 All URIs are relative to *https://conversations.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateServiceConversationParticipant**](ServicesConversationsParticipantsApi.md#CreateServiceConversationParticipant) | **Post** /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants | 8 [**DeleteServiceConversationParticipant**](ServicesConversationsParticipantsApi.md#DeleteServiceConversationParticipant) | **Delete** /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid} | 9 [**FetchServiceConversationParticipant**](ServicesConversationsParticipantsApi.md#FetchServiceConversationParticipant) | **Get** /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid} | 10 [**ListServiceConversationParticipant**](ServicesConversationsParticipantsApi.md#ListServiceConversationParticipant) | **Get** /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants | 11 [**UpdateServiceConversationParticipant**](ServicesConversationsParticipantsApi.md#UpdateServiceConversationParticipant) | **Post** /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid} | 12 13 14 15 ## CreateServiceConversationParticipant 16 17 > ConversationsV1ServiceConversationParticipant CreateServiceConversationParticipant(ctx, ChatServiceSidConversationSidoptional) 18 19 20 21 Add a new participant to the conversation in a specific service 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. 30 **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. 31 32 ### Other Parameters 33 34 Other parameters are passed through a pointer to a CreateServiceConversationParticipantParams struct 35 36 37 Name | Type | Description 38 ------------- | ------------- | ------------- 39 **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header 40 **Identity** | **string** | A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. 41 **MessagingBindingAddress** | **string** | The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field). 42 **MessagingBindingProxyAddress** | **string** | The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field). 43 **DateCreated** | **time.Time** | The date on which this resource was created. 44 **DateUpdated** | **time.Time** | The date on which this resource was last updated. 45 **Attributes** | **string** | An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. 46 **MessagingBindingProjectedAddress** | **string** | The address of the Twilio phone number that is used in Group MMS. 47 **RoleSid** | **string** | The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. 48 49 ### Return type 50 51 [**ConversationsV1ServiceConversationParticipant**](ConversationsV1ServiceConversationParticipant.md) 52 53 ### Authorization 54 55 [accountSid_authToken](../README.md#accountSid_authToken) 56 57 ### HTTP request headers 58 59 - **Content-Type**: application/x-www-form-urlencoded 60 - **Accept**: application/json 61 62 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 63 [[Back to Model list]](../README.md#documentation-for-models) 64 [[Back to README]](../README.md) 65 66 67 ## DeleteServiceConversationParticipant 68 69 > DeleteServiceConversationParticipant(ctx, ChatServiceSidConversationSidSidoptional) 70 71 72 73 Remove a participant from the conversation 74 75 ### Path Parameters 76 77 78 Name | Type | Description 79 ------------- | ------------- | ------------- 80 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 81 **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. 82 **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. 83 **Sid** | **string** | A 34 character string that uniquely identifies this resource. 84 85 ### Other Parameters 86 87 Other parameters are passed through a pointer to a DeleteServiceConversationParticipantParams struct 88 89 90 Name | Type | Description 91 ------------- | ------------- | ------------- 92 **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header 93 94 ### Return type 95 96 (empty response body) 97 98 ### Authorization 99 100 [accountSid_authToken](../README.md#accountSid_authToken) 101 102 ### HTTP request headers 103 104 - **Content-Type**: Not defined 105 - **Accept**: Not defined 106 107 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 108 [[Back to Model list]](../README.md#documentation-for-models) 109 [[Back to README]](../README.md) 110 111 112 ## FetchServiceConversationParticipant 113 114 > ConversationsV1ServiceConversationParticipant FetchServiceConversationParticipant(ctx, ChatServiceSidConversationSidSid) 115 116 117 118 Fetch a participant of the conversation 119 120 ### Path Parameters 121 122 123 Name | Type | Description 124 ------------- | ------------- | ------------- 125 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 126 **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. 127 **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. 128 **Sid** | **string** | A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID. 129 130 ### Other Parameters 131 132 Other parameters are passed through a pointer to a FetchServiceConversationParticipantParams struct 133 134 135 Name | Type | Description 136 ------------- | ------------- | ------------- 137 138 ### Return type 139 140 [**ConversationsV1ServiceConversationParticipant**](ConversationsV1ServiceConversationParticipant.md) 141 142 ### Authorization 143 144 [accountSid_authToken](../README.md#accountSid_authToken) 145 146 ### HTTP request headers 147 148 - **Content-Type**: Not defined 149 - **Accept**: application/json 150 151 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 152 [[Back to Model list]](../README.md#documentation-for-models) 153 [[Back to README]](../README.md) 154 155 156 ## ListServiceConversationParticipant 157 158 > []ConversationsV1ServiceConversationParticipant ListServiceConversationParticipant(ctx, ChatServiceSidConversationSidoptional) 159 160 161 162 Retrieve a list of all participants of the conversation 163 164 ### Path Parameters 165 166 167 Name | Type | Description 168 ------------- | ------------- | ------------- 169 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 170 **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. 171 **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants. 172 173 ### Other Parameters 174 175 Other parameters are passed through a pointer to a ListServiceConversationParticipantParams struct 176 177 178 Name | Type | Description 179 ------------- | ------------- | ------------- 180 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 181 **Limit** | **int** | Max number of records to return. 182 183 ### Return type 184 185 [**[]ConversationsV1ServiceConversationParticipant**](ConversationsV1ServiceConversationParticipant.md) 186 187 ### Authorization 188 189 [accountSid_authToken](../README.md#accountSid_authToken) 190 191 ### HTTP request headers 192 193 - **Content-Type**: Not defined 194 - **Accept**: application/json 195 196 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 197 [[Back to Model list]](../README.md#documentation-for-models) 198 [[Back to README]](../README.md) 199 200 201 ## UpdateServiceConversationParticipant 202 203 > ConversationsV1ServiceConversationParticipant UpdateServiceConversationParticipant(ctx, ChatServiceSidConversationSidSidoptional) 204 205 206 207 Update an existing participant in the conversation 208 209 ### Path Parameters 210 211 212 Name | Type | Description 213 ------------- | ------------- | ------------- 214 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 215 **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. 216 **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. 217 **Sid** | **string** | A 34 character string that uniquely identifies this resource. 218 219 ### Other Parameters 220 221 Other parameters are passed through a pointer to a UpdateServiceConversationParticipantParams struct 222 223 224 Name | Type | Description 225 ------------- | ------------- | ------------- 226 **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header 227 **DateCreated** | **time.Time** | The date on which this resource was created. 228 **DateUpdated** | **time.Time** | The date on which this resource was last updated. 229 **Identity** | **string** | A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. 230 **Attributes** | **string** | An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. 231 **RoleSid** | **string** | The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. 232 **MessagingBindingProxyAddress** | **string** | The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it. 233 **MessagingBindingProjectedAddress** | **string** | The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it. 234 **LastReadMessageIndex** | **int** | Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. 235 **LastReadTimestamp** | **string** | Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. 236 237 ### Return type 238 239 [**ConversationsV1ServiceConversationParticipant**](ConversationsV1ServiceConversationParticipant.md) 240 241 ### Authorization 242 243 [accountSid_authToken](../README.md#accountSid_authToken) 244 245 ### HTTP request headers 246 247 - **Content-Type**: application/x-www-form-urlencoded 248 - **Accept**: application/json 249 250 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 251 [[Back to Model list]](../README.md#documentation-for-models) 252 [[Back to README]](../README.md) 253