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

     1  # UsersConversationsApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteUserConversation**](UsersConversationsApi.md#DeleteUserConversation) | **Delete** /v1/Users/{UserSid}/Conversations/{ConversationSid} | 
     8  [**FetchUserConversation**](UsersConversationsApi.md#FetchUserConversation) | **Get** /v1/Users/{UserSid}/Conversations/{ConversationSid} | 
     9  [**ListUserConversation**](UsersConversationsApi.md#ListUserConversation) | **Get** /v1/Users/{UserSid}/Conversations | 
    10  [**UpdateUserConversation**](UsersConversationsApi.md#UpdateUserConversation) | **Post** /v1/Users/{UserSid}/Conversations/{ConversationSid} | 
    11  
    12  
    13  
    14  ## DeleteUserConversation
    15  
    16  > DeleteUserConversation(ctx, UserSidConversationSid)
    17  
    18  
    19  
    20  Delete a specific User Conversation.
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **UserSid** | **string** | The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
    29  **ConversationSid** | **string** | The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a DeleteUserConversationParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  
    39  ### Return type
    40  
    41   (empty response body)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: Not defined
    50  - **Accept**: Not defined
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## FetchUserConversation
    58  
    59  > ConversationsV1UserConversation FetchUserConversation(ctx, UserSidConversationSid)
    60  
    61  
    62  
    63  Fetch a specific User Conversation.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **UserSid** | **string** | The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
    72  **ConversationSid** | **string** | The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a FetchUserConversationParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  
    82  ### Return type
    83  
    84  [**ConversationsV1UserConversation**](ConversationsV1UserConversation.md)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: application/json
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98  
    99  
   100  ## ListUserConversation
   101  
   102  > []ConversationsV1UserConversation ListUserConversation(ctx, UserSidoptional)
   103  
   104  
   105  
   106  Retrieve a list of all User Conversations for the User.
   107  
   108  ### Path Parameters
   109  
   110  
   111  Name | Type | Description
   112  ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114  **UserSid** | **string** | The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
   115  
   116  ### Other Parameters
   117  
   118  Other parameters are passed through a pointer to a ListUserConversationParams struct
   119  
   120  
   121  Name | Type | Description
   122  ------------- | ------------- | -------------
   123  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   124  **Limit** | **int** | Max number of records to return.
   125  
   126  ### Return type
   127  
   128  [**[]ConversationsV1UserConversation**](ConversationsV1UserConversation.md)
   129  
   130  ### Authorization
   131  
   132  [accountSid_authToken](../README.md#accountSid_authToken)
   133  
   134  ### HTTP request headers
   135  
   136  - **Content-Type**: Not defined
   137  - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   140  [[Back to Model list]](../README.md#documentation-for-models)
   141  [[Back to README]](../README.md)
   142  
   143  
   144  ## UpdateUserConversation
   145  
   146  > ConversationsV1UserConversation UpdateUserConversation(ctx, UserSidConversationSidoptional)
   147  
   148  
   149  
   150  Update a specific User Conversation.
   151  
   152  ### Path Parameters
   153  
   154  
   155  Name | Type | Description
   156  ------------- | ------------- | -------------
   157  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   158  **UserSid** | **string** | The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
   159  **ConversationSid** | **string** | The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
   160  
   161  ### Other Parameters
   162  
   163  Other parameters are passed through a pointer to a UpdateUserConversationParams struct
   164  
   165  
   166  Name | Type | Description
   167  ------------- | ------------- | -------------
   168  **NotificationLevel** | **string** | 
   169  **LastReadTimestamp** | **time.Time** | The date of the last message read in conversation by the user, given in ISO 8601 format.
   170  **LastReadMessageIndex** | **int** | The index of the last Message in the Conversation that the Participant has read.
   171  
   172  ### Return type
   173  
   174  [**ConversationsV1UserConversation**](ConversationsV1UserConversation.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: application/x-www-form-urlencoded
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188