Fetch a Sim resource on your Account

GET /v1/Sims/{Sid}

A resource representing a Programmable Wireless SIM

Fetch a Sim resource on your Account.

Path parameters

  • Sid string Required

    The SID or the unique_name of the Sim resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • 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}$.

    • commands_callback_method string(http-method) | null

      The HTTP method we use to call commands_callback_url

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

    • commands_callback_url string(uri) | null

      The URL we call when the SIM originates a machine-to-machine Command

    • 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 Sim resource was last updated

    • e_id string | null

      Deprecated

    • friendly_name string | null

      The string that you assigned to describe the Sim resource

    • iccid string | null

      The ICCID associated with the SIM

    • ip_address string | null

      Deprecated

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

    • reset_status string | null

      The connectivity reset status of the SIM

      Value is resetting.

    • sid string | null

      The unique string that identifies the Sim resource

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

    • sms_fallback_method string(http-method) | null

      Deprecated

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

    • sms_fallback_url string(uri) | null

      Deprecated

    • sms_method string(http-method) | null

      Deprecated

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

    • sms_url string(uri) | null

      Deprecated

    • status string | null

      The status of the Sim resource

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the resource

    • voice_fallback_method string(http-method) | null

      Deprecated. The HTTP method we use to call voice_fallback_url

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

    • voice_fallback_url string(uri) | null

      Deprecated. The URL we call 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

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

    • voice_url string(uri) | null

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

GET /v1/Sims/{Sid}
curl \
 -X GET https://wireless.twilio.com/v1/Sims/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "commands_callback_method": "HEAD",
  "commands_callback_url": "https://example.com",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "e_id": "string",
  "friendly_name": "string",
  "iccid": "string",
  "ip_address": "string",
  "links": {},
  "rate_plan_sid": "string",
  "reset_status": "resetting",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_url": "https://example.com",
  "status": "new",
  "unique_name": "string",
  "url": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "commands_callback_method": "HEAD",
  "commands_callback_url": "https://example.com",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "e_id": "string",
  "friendly_name": "string",
  "iccid": "string",
  "ip_address": "string",
  "links": {},
  "rate_plan_sid": "string",
  "reset_status": "resetting",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_url": "https://example.com",
  "status": "new",
  "unique_name": "string",
  "url": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}