github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/docs/ConversationsParticipantsApi.md (about)

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