Query parameters

• Status string

  Only return Sim resources with this status.

  Values are new, ready, active, suspended, deactivated, canceled, scheduled, or updating.

• Iccid string

  Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.

• RatePlan string

  The SID or unique name of a RatePlan resource. Only return Sim resources assigned to this RatePlan resource.

• EId string

  Deprecated.

• SimRegistrationCode string

  Only return Sim resources with this registration code. This will return a list with a maximum size of 1.

• PageSize integer(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

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

  • sims array[object]
    Hide sims attributes Show sims attributes object

    • sid string | null

      The unique string that we created to identify the Sim resource.

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

    • account_sid string | null

      The SID of the Account to which the Sim resource belongs.

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

    • rate_plan_sid string | null

      The SID of the RatePlan resource to which the Sim resource is assigned.

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

    • friendly_name string | null

      The string that you assigned to describe the Sim resource.

    • iccid string | null

      The ICCID associated with the SIM.

    • e_id string | null

      Deprecated.

    • status string

      The status of the Sim resource. Can be: new, ready, active, deactivated, canceled, deleted, scheduled, or updating. See Status Values for the description of each status.

      Values are new, ready, active, suspended, deactivated, canceled, scheduled, or updating.

    • reset_status string

      The connectivity reset status of the SIM. Can be: null or resetting. When a connectivity reset is initiated on a SIM, this property is resetting. After the reset completes, it is null.

      Value is resetting.

    • commands_callback_url string(uri) | null

      The URL we call using the commands_callback_method when the SIM originates a machine-to-machine Command. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

    • commands_callback_method string(http-method) | null

      The HTTP method we use to call commands_callback_url. Can be: POST or GET. Default is POST.

      Values are GET or POST.

    • sms_fallback_method string(http-method) | null

      Deprecated.

      Values are GET or POST.

    • sms_fallback_url string(uri) | null

      Deprecated.

    • sms_method string(http-method) | null

      Deprecated.

      Values are GET or POST.

    • sms_url string(uri) | null

      Deprecated.

    • voice_fallback_method string(http-method) | null

      Deprecated. The HTTP method we use to call voice_fallback_url. Can be: GET or POST. Default is POST.

      Values are GET or POST.

    • voice_fallback_url string(uri) | null

      Deprecated. The URL we call using the voice_fallback_method when an error occurs while retrieving or executing the TwiML requested from voice_url.

    • voice_method string(http-method) | null

      Deprecated. The HTTP method we use to call voice_url. Can be: GET or POST. Default is POST.

      Values are GET or POST.

    • voice_url string(uri) | null

      Deprecated. The URL we call using the voice_method when the SIM-connected device makes a voice call.

    • 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 Sim resource was last updated specified in ISO 8601 format.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of related subresources.

    • ip_address string | null

      Deprecated.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)