# Send an IP Command to a Super SIM.

**POST /v1/IpCommands**

Send an IP Command to a Super SIM.
Machine-to-machine IP Commands sent to/from Super SIMs

## Servers
- https://supersim.twilio.com: https://supersim.twilio.com ()


## Authentication methods
- Account sid auth token


## Parameters



### Body: application/x-www-form-urlencoded (object)

- **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.
- **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** (integer)
  The device port to which the IP Command will be sent.
- **PayloadType** (string)
  Either “text” or “binary”. For an IP Command sent to a Super SIM, `payload_type` is configurable. For an IP Command sent from a Super SIM, `payload_type` is always “binary”.
- **CallbackUrl** (string(uri))
  The URL we should call using the `callback_method` after we have sent the IP Command.
- **CallbackMethod** (string(http-method))
  The HTTP method we should use to call `callback_url`. Can be `GET` or `POST`, and the default is `POST`.


## Responses
### 201
Created
#### Headers
- **Access-Control-Allow-Origin** (string)
  Specify the origin(s) allowed to access the resource
- **Access-Control-Allow-Methods** (string)
  Specify the HTTP methods allowed when accessing the resource
- **Access-Control-Allow-Headers** (string)
  Specify the headers allowed when accessing the resource
- **Access-Control-Allow-Credentials** (boolean)
  Indicates whether the browser should include credentials
- **Access-Control-Expose-Headers** (string)
  Headers exposed to the client

#### Body: application/json (object)
- **sid** (string | null)
  The unique string that we created to identify the IP Command resource.
- **account_sid** (string | null)
  The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IP Command resource.
- **sim_sid** (string | null)
  The SID of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.
- **sim_iccid** (string | null)
  The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.
- **status** (string)
  The delivery status of the IP Command. This is one of the following: “queued”, “sent”, “failed” or “received”.
- **direction** (string)
  Either `to_sim` or `from_sim`. Indicates whether the IP Command resource was sent from or to the Super SIM.
- **device_ip** (string | null)
  The IP address of the device that the IP Command was sent to or received from. For an IP Command sent to a Super SIM, `device_ip` starts out as `null`, and once the IP Command is “sent”, the `device_ip` will be filled out. An IP Command sent from a Super SIM have its `device_ip` always set.
- **device_port** (integer)
  For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message.
- **payload_type** (string)
  Either “text” or “binary”. For an IP Command sent to a Super SIM, `payload_type` is configurable. For an IP Command sent from a Super SIM, `payload_type` is always “binary”.
- **payload** (string | null)
  The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.

  For an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message “as is”. The payload should not exceed 1300 bytes.

  For an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.
- **date_created** (string(date-time) | null)
  The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
- **date_updated** (string(date-time) | null)
  The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
- **url** (string(uri) | null)
  The absolute URL of the IP Command resource.


[Powered by Bump.sh](https://bump.sh)