Retrieve a list of IP Commands from your account

GET /v1/IpCommands

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

Retrieve a list of IP Commands from your account.

Query parameters

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

    Values are queued, sent, received, or failed.

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

    Values are to_sim or from_sim.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • ip_commands array[object]
      Hide ip_commands attributes Show ip_commands attributes
      • 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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/IpCommands 
curl \
 -X GET https://supersim.twilio.com/v1/IpCommands \
 --user "username:password"
Response examples (200) 
{
  "ip_commands": [
    {
      "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"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}