github.com/twilio/twilio-go@v1.20.1/rest/ip_messaging/v2/docs/ServicesUsersChannelsApi.md (about)

     1  # ServicesUsersChannelsApi
     2  
     3  All URIs are relative to *https://ip-messaging.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteUserChannel**](ServicesUsersChannelsApi.md#DeleteUserChannel) | **Delete** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 
     8  [**FetchUserChannel**](ServicesUsersChannelsApi.md#FetchUserChannel) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 
     9  [**ListUserChannel**](ServicesUsersChannelsApi.md#ListUserChannel) | **Get** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels | 
    10  [**UpdateUserChannel**](ServicesUsersChannelsApi.md#UpdateUserChannel) | **Post** /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid} | 
    11  
    12  
    13  
    14  ## DeleteUserChannel
    15  
    16  > DeleteUserChannel(ctx, ServiceSidUserSidChannelSid)
    17  
    18  
    19  
    20  
    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** | 
    29  **UserSid** | **string** | 
    30  **ChannelSid** | **string** | 
    31  
    32  ### Other Parameters
    33  
    34  Other parameters are passed through a pointer to a DeleteUserChannelParams struct
    35  
    36  
    37  Name | Type | Description
    38  ------------- | ------------- | -------------
    39  
    40  ### Return type
    41  
    42   (empty response body)
    43  
    44  ### Authorization
    45  
    46  [accountSid_authToken](../README.md#accountSid_authToken)
    47  
    48  ### HTTP request headers
    49  
    50  - **Content-Type**: Not defined
    51  - **Accept**: Not defined
    52  
    53  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    54  [[Back to Model list]](../README.md#documentation-for-models)
    55  [[Back to README]](../README.md)
    56  
    57  
    58  ## FetchUserChannel
    59  
    60  > IpMessagingV2UserChannel FetchUserChannel(ctx, ServiceSidUserSidChannelSid)
    61  
    62  
    63  
    64  
    65  
    66  ### Path Parameters
    67  
    68  
    69  Name | Type | Description
    70  ------------- | ------------- | -------------
    71  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72  **ServiceSid** | **string** | 
    73  **UserSid** | **string** | 
    74  **ChannelSid** | **string** | 
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a FetchUserChannelParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  
    84  ### Return type
    85  
    86  [**IpMessagingV2UserChannel**](IpMessagingV2UserChannel.md)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: application/json
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## ListUserChannel
   103  
   104  > []IpMessagingV2UserChannel ListUserChannel(ctx, ServiceSidUserSidoptional)
   105  
   106  
   107  
   108  
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **ServiceSid** | **string** | 
   117  **UserSid** | **string** | 
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a ListUserChannelParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   127  **Limit** | **int** | Max number of records to return.
   128  
   129  ### Return type
   130  
   131  [**[]IpMessagingV2UserChannel**](IpMessagingV2UserChannel.md)
   132  
   133  ### Authorization
   134  
   135  [accountSid_authToken](../README.md#accountSid_authToken)
   136  
   137  ### HTTP request headers
   138  
   139  - **Content-Type**: Not defined
   140  - **Accept**: application/json
   141  
   142  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   143  [[Back to Model list]](../README.md#documentation-for-models)
   144  [[Back to README]](../README.md)
   145  
   146  
   147  ## UpdateUserChannel
   148  
   149  > IpMessagingV2UserChannel UpdateUserChannel(ctx, ServiceSidUserSidChannelSidoptional)
   150  
   151  
   152  
   153  
   154  
   155  ### Path Parameters
   156  
   157  
   158  Name | Type | Description
   159  ------------- | ------------- | -------------
   160  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   161  **ServiceSid** | **string** | 
   162  **UserSid** | **string** | 
   163  **ChannelSid** | **string** | 
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a UpdateUserChannelParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **NotificationLevel** | **string** | 
   173  **LastConsumedMessageIndex** | **int** | 
   174  **LastConsumptionTimestamp** | **time.Time** | 
   175  
   176  ### Return type
   177  
   178  [**IpMessagingV2UserChannel**](IpMessagingV2UserChannel.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: application/x-www-form-urlencoded
   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