Send an IP Command to a Super SIM

POST /v1/IpCommands

Machine-to-machine IP Commands sent to/from Super SIMs

Send an IP Command to a Super SIM.

Body

  • CallbackMethod string(http-method)

    The HTTP method we should use to call callback_url. Can be GET or POST, and the default is POST.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • CallbackUrl string(uri)

    The URL we should call using the callback_method after we have sent the IP Command.

  • DevicePort integer Required

    The device port to which the IP Command will be sent.

  • Payload string Required

    The payload to be delivered to the device.

  • PayloadType string

    Indicates how the payload is encoded. Either text or binary. Defaults to text.

    Values are text or binary.

  • Sim string Required

    The sid or unique_name of the Super SIM to send the IP Command to.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • device_ip string | null

      The IP address of the device that the IP Command was sent to or received from

    • device_port integer | null

      The port that the IP Command either originated from or was sent to

    • direction string | null

      The direction of the IP Command

      Values are to_sim or from_sim.

    • payload string | null

      The payload of the IP Command sent to or from the Super SIM

    • payload_type string | null

      The payload type of the IP Command

      Values are text or binary.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HG[0-9a-fA-F]{32}$.

    • sim_iccid string | null

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

    • sim_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HS[0-9a-fA-F]{32}$.

    • status string | null

      The status of the IP Command

      Values are queued, sent, received, or failed.

    • url string(uri) | null

      The absolute URL of the IP Command resource
POST /v1/IpCommands 
curl \
 -X POST https://supersim.twilio.com/v1/IpCommands \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'CallbackMethod=HEAD&CallbackUrl=https%3A%2F%2Fexample.com&DevicePort=42&Payload=string&PayloadType=text&Sim=string'
Request example 
{
  "CallbackMethod": "HEAD",
  "CallbackUrl": "https://example.com",
  "DevicePort": 42,
  "Payload": "string",
  "PayloadType": "text",
  "Sim": "string"
}
Request examples 
{
  "CallbackMethod": "HEAD",
  "CallbackUrl": "https://example.com",
  "DevicePort": 42,
  "Payload": "string",
  "PayloadType": "text",
  "Sim": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "device_ip": "string",
  "device_port": 42,
  "direction": "to_sim",
  "payload": "string",
  "payload_type": "text",
  "sid": "string",
  "sim_iccid": "string",
  "sim_sid": "string",
  "status": "queued",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "device_ip": "string",
  "device_port": 42,
  "direction": "to_sim",
  "payload": "string",
  "payload_type": "text",
  "sid": "string",
  "sim_iccid": "string",
  "sim_sid": "string",
  "status": "queued",
  "url": "https://example.com"
}