All URIs are relative to https://supersim.twilio.com
| Method | HTTP request | Description |
|---|---|---|
| CreateSim | Post /v1/Sims | |
| FetchSim | Get /v1/Sims/{Sid} | |
| ListSim | Get /v1/Sims | |
| UpdateSim | Post /v1/Sims/{Sid} |
SupersimV1Sim CreateSim(ctx, optional)
Register a Super SIM to your Account
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a CreateSimParams struct
| Name | Type | Description |
|---|---|---|
| Iccid | string | The ICCID of the Super SIM to be added to your Account. |
| RegistrationCode | string | The 10-digit code required to claim the Super SIM for your Account. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SupersimV1Sim FetchSim(ctx, Sid)
Fetch a Super SIM instance from your account.
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the Sim resource to fetch. |
Other parameters are passed through a pointer to a FetchSimParams struct
| Name | Type | Description |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]SupersimV1Sim ListSim(ctx, optional)
Retrieve a list of Super SIMs from your account.
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a ListSimParams struct
| Name | Type | Description |
|---|---|---|
| Status | string | The status of the Sim resources to read. Can be new, ready, active, inactive, or scheduled. |
| Fleet | string | The SID or unique name of the Fleet to which a list of Sims are assigned. |
| Iccid | string | The ICCID associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs. |
| PageSize | int | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Limit | int | Max number of records to return. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SupersimV1Sim UpdateSim(ctx, Sidoptional)
Updates the given properties of a Super SIM instance from your account.
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the Sim resource to update. |
Other parameters are passed through a pointer to a UpdateSimParams struct
| Name | Type | Description |
|---|---|---|
| UniqueName | string | An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. |
| Status | string | |
| Fleet | string | The SID or unique name of the Fleet to which the SIM resource should be assigned. |
| CallbackUrl | string | The URL we should call using the callback_method after an asynchronous update has finished. |
| CallbackMethod | string | The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST. |
| AccountSid | string | The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]