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

     1  # SimsApi
     2  
     3  All URIs are relative to *https://wireless.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteSim**](SimsApi.md#DeleteSim) | **Delete** /v1/Sims/{Sid} | 
     8  [**FetchSim**](SimsApi.md#FetchSim) | **Get** /v1/Sims/{Sid} | 
     9  [**ListSim**](SimsApi.md#ListSim) | **Get** /v1/Sims | 
    10  [**UpdateSim**](SimsApi.md#UpdateSim) | **Post** /v1/Sims/{Sid} | 
    11  
    12  
    13  
    14  ## DeleteSim
    15  
    16  > DeleteSim(ctx, Sid)
    17  
    18  
    19  
    20  Delete a Sim resource on your Account.
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **Sid** | **string** | The SID or the `unique_name` of the Sim resource to delete.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a DeleteSimParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  
    38  ### Return type
    39  
    40   (empty response body)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: Not defined
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## FetchSim
    57  
    58  > WirelessV1Sim FetchSim(ctx, Sid)
    59  
    60  
    61  
    62  Fetch a Sim resource on your Account.
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **Sid** | **string** | The SID or the `unique_name` of the Sim resource to fetch.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a FetchSimParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  
    80  ### Return type
    81  
    82  [**WirelessV1Sim**](WirelessV1Sim.md)
    83  
    84  ### Authorization
    85  
    86  [accountSid_authToken](../README.md#accountSid_authToken)
    87  
    88  ### HTTP request headers
    89  
    90  - **Content-Type**: Not defined
    91  - **Accept**: application/json
    92  
    93  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    94  [[Back to Model list]](../README.md#documentation-for-models)
    95  [[Back to README]](../README.md)
    96  
    97  
    98  ## ListSim
    99  
   100  > []WirelessV1Sim ListSim(ctx, optional)
   101  
   102  
   103  
   104  Retrieve a list of Sim resources on your Account.
   105  
   106  ### Path Parameters
   107  
   108  This endpoint does not need any path parameter.
   109  
   110  ### Other Parameters
   111  
   112  Other parameters are passed through a pointer to a ListSimParams struct
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **Status** | **string** | Only return Sim resources with this status.
   118  **Iccid** | **string** | Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.
   119  **RatePlan** | **string** | The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
   120  **EId** | **string** | Deprecated.
   121  **SimRegistrationCode** | **string** | Only return Sim resources with this registration code. This will return a list with a maximum size of 1.
   122  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   123  **Limit** | **int** | Max number of records to return.
   124  
   125  ### Return type
   126  
   127  [**[]WirelessV1Sim**](WirelessV1Sim.md)
   128  
   129  ### Authorization
   130  
   131  [accountSid_authToken](../README.md#accountSid_authToken)
   132  
   133  ### HTTP request headers
   134  
   135  - **Content-Type**: Not defined
   136  - **Accept**: application/json
   137  
   138  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   139  [[Back to Model list]](../README.md#documentation-for-models)
   140  [[Back to README]](../README.md)
   141  
   142  
   143  ## UpdateSim
   144  
   145  > WirelessV1Sim UpdateSim(ctx, Sidoptional)
   146  
   147  
   148  
   149  Updates the given properties of a Sim resource on your Account.
   150  
   151  ### Path Parameters
   152  
   153  
   154  Name | Type | Description
   155  ------------- | ------------- | -------------
   156  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   157  **Sid** | **string** | The SID or the `unique_name` of the Sim resource to update.
   158  
   159  ### Other Parameters
   160  
   161  Other parameters are passed through a pointer to a UpdateSimParams struct
   162  
   163  
   164  Name | Type | Description
   165  ------------- | ------------- | -------------
   166  **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource.
   167  **CallbackMethod** | **string** | The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
   168  **CallbackUrl** | **string** | The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).
   169  **FriendlyName** | **string** | A descriptive string that you create to describe the Sim resource. It does not need to be unique.
   170  **RatePlan** | **string** | The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
   171  **Status** | **string** | 
   172  **CommandsCallbackMethod** | **string** | The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
   173  **CommandsCallbackUrl** | **string** | The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
   174  **SmsFallbackMethod** | **string** | The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
   175  **SmsFallbackUrl** | **string** | The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.
   176  **SmsMethod** | **string** | The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.
   177  **SmsUrl** | **string** | The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource).
   178  **VoiceFallbackMethod** | **string** | Deprecated.
   179  **VoiceFallbackUrl** | **string** | Deprecated.
   180  **VoiceMethod** | **string** | Deprecated.
   181  **VoiceUrl** | **string** | Deprecated.
   182  **ResetStatus** | **string** | 
   183  **AccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
   184  
   185  ### Return type
   186  
   187  [**WirelessV1Sim**](WirelessV1Sim.md)
   188  
   189  ### Authorization
   190  
   191  [accountSid_authToken](../README.md#accountSid_authToken)
   192  
   193  ### HTTP request headers
   194  
   195  - **Content-Type**: application/x-www-form-urlencoded
   196  - **Accept**: application/json
   197  
   198  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   199  [[Back to Model list]](../README.md#documentation-for-models)
   200  [[Back to README]](../README.md)
   201