Path parameters

• Sid string Required

  The SID of the IP Command resource to fetch.

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

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • 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

  Hide response attributes Show response attributes object

  • sid string | null

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

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

  • account_sid string | null

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

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

  • 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}$.

  • sim_iccid string | null

    The ICCID of the Super SIM 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”.

    Values are queued, sent, received, or failed.

  • direction string

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

    Values are to_sim or from_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.

    Default value is 0.

  • 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”.

    Values are text or 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 format.

  • date_updated string(date-time) | null

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

  • url string(uri) | null

    The absolute URL of the IP Command resource.