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

     1  # IpCommandsApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateIpCommand**](IpCommandsApi.md#CreateIpCommand) | **Post** /v1/IpCommands | 
     8  [**FetchIpCommand**](IpCommandsApi.md#FetchIpCommand) | **Get** /v1/IpCommands/{Sid} | 
     9  [**ListIpCommand**](IpCommandsApi.md#ListIpCommand) | **Get** /v1/IpCommands | 
    10  
    11  
    12  
    13  ## CreateIpCommand
    14  
    15  > SupersimV1IpCommand CreateIpCommand(ctx, optional)
    16  
    17  
    18  
    19  Send an IP Command to a Super SIM.
    20  
    21  ### Path Parameters
    22  
    23  This endpoint does not need any path parameter.
    24  
    25  ### Other Parameters
    26  
    27  Other parameters are passed through a pointer to a CreateIpCommandParams struct
    28  
    29  
    30  Name | Type | Description
    31  ------------- | ------------- | -------------
    32  **Sim** | **string** | The `sid` or `unique_name` of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.
    33  **Payload** | **string** | The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.
    34  **DevicePort** | **int** | The device port to which the IP Command will be sent.
    35  **PayloadType** | **string** | 
    36  **CallbackUrl** | **string** | The URL we should call using the `callback_method` after we have sent the IP Command.
    37  **CallbackMethod** | **string** | The HTTP method we should use to call `callback_url`. Can be `GET` or `POST`, and the default is `POST`.
    38  
    39  ### Return type
    40  
    41  [**SupersimV1IpCommand**](SupersimV1IpCommand.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: application/x-www-form-urlencoded
    50  - **Accept**: application/json
    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  ## FetchIpCommand
    58  
    59  > SupersimV1IpCommand FetchIpCommand(ctx, Sid)
    60  
    61  
    62  
    63  Fetch IP Command instance from your account.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **Sid** | **string** | The SID of the IP Command resource to fetch.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a FetchIpCommandParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  
    81  ### Return type
    82  
    83  [**SupersimV1IpCommand**](SupersimV1IpCommand.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## ListIpCommand
   100  
   101  > []SupersimV1IpCommand ListIpCommand(ctx, optional)
   102  
   103  
   104  
   105  Retrieve a list of IP Commands from your account.
   106  
   107  ### Path Parameters
   108  
   109  This endpoint does not need any path parameter.
   110  
   111  ### Other Parameters
   112  
   113  Other parameters are passed through a pointer to a ListIpCommandParams struct
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **Sim** | **string** | The SID or unique name of the Sim resource that IP Command was sent to or from.
   119  **SimIccid** | **string** | The ICCID of the Sim resource that IP Command was sent to or from.
   120  **Status** | **string** | The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
   121  **Direction** | **string** | The direction of the IP Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
   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  [**[]SupersimV1IpCommand**](SupersimV1IpCommand.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