All URIs are relative to https://supersim.twilio.com
| Method | HTTP request | Description |
|---|---|---|
| CreateIpCommand | Post /v1/IpCommands | |
| FetchIpCommand | Get /v1/IpCommands/{Sid} | |
| ListIpCommand | Get /v1/IpCommands |
SupersimV1IpCommand CreateIpCommand(ctx, optional)
Send an IP Command to a Super SIM.
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a CreateIpCommandParams struct
| Name | Type | Description |
|---|---|---|
| Sim | string | The sid or unique_name of the Super SIM to send the IP Command to. |
| 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. |
| DevicePort | int | The device port to which the IP Command will be sent. |
| PayloadType | string | |
| CallbackUrl | string | The URL we should call using the callback_method after we have sent the IP Command. |
| CallbackMethod | string | The HTTP method we should use to call callback_url. Can be GET or POST, and the default is POST. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SupersimV1IpCommand FetchIpCommand(ctx, Sid)
Fetch IP Command instance from your account.
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the IP Command resource to fetch. |
Other parameters are passed through a pointer to a FetchIpCommandParams 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]
[]SupersimV1IpCommand ListIpCommand(ctx, optional)
Retrieve a list of IP Commands from your account.
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a ListIpCommandParams struct
| Name | Type | Description |
|---|---|---|
| Sim | string | The SID or unique name of the Sim resource that IP Command was sent to or from. |
| SimIccid | string | The ICCID of the Sim resource that IP Command was sent to or from. |
| Status | string | The status of the IP Command. Can be: queued, sent, received or failed. See the IP Command Status Values for a description of each. |
| 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. |
| 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]