Sign in

v1

latestOpenAPI 3.0.12026-07-23122654.9 KB
SupersimV1IpCommand

Send an IP Command to a Super SIM.

post/v1/IpCommands

Response

Created

sidstring nullable

The unique string that we created to identify the IP Command resource.

account_sidstring nullable

The SID of the Account that created the IP Command resource.

sim_sidstring nullable

The SID of the Super SIM that this IP Command was sent to or from.

sim_iccidstring nullable

The ICCID of the Super SIM that this IP Command was sent to or from.

status'queued' | 'sent' | 'received' | 'failed' nullable

The delivery status of the IP Command. This is one of the following: “queued”, “sent”, “failed” or “received”.

direction'to_sim' | 'from_sim' nullable

Either to_sim or from_sim. Indicates whether the IP Command resource was sent from or to the Super SIM.

device_ipstring nullable

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_portinteger nullable

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'text' | 'binary' nullable

Indicates how the payload is encoded. 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”.

payloadstring nullable

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_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

The absolute URL of the IP Command resource.