TWtwilio
WirelessV1Sim

Updates the given properties of a Sim resource on your Account.

Updates the given properties of a Sim resource on your Account.

post/v1/Sims/{Sid}

Request

  • Base URL
    https://wireless.twilio.com
  • URL
    https://wireless.twilio.com/v1/Sims/{Sid}
  • Auth
    HTTP basic

Path parameters

Sidstring required

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

Request body application/x-www-form-urlencoded

UniqueNamestring

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

CallbackMethod'GET' | 'POST' http-method

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

CallbackUrlstring uri

The URL we should call using the callback_url when the SIM has finished updating. When the SIM transitions from new to ready or from any status to deactivated, we call this URL when the status changes to an intermediate status (ready or deactivated) and again when the status changes to its final status (active or canceled).

FriendlyNamestring

A descriptive string that you create to describe the Sim resource. It does not need to be unique.

RatePlanstring

The SID or unique name of the RatePlan resource to which the Sim resource should be assigned.

Status'new' | 'ready' | 'active' | 'suspended' | 'deactivated' | 'canceled' | 'scheduled' | 'updating'

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.

CommandsCallbackMethod'GET' | 'POST' http-method

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

CommandsCallbackUrlstring uri

The URL we should call using the commands_callback_method when the SIM sends a Command. Your server should respond with an HTTP status code in the 200 range; any response body is ignored.

SmsFallbackMethod'GET' | 'POST' http-method

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

SmsFallbackUrlstring uri

The URL we should call using the sms_fallback_method when an error occurs while retrieving or executing the TwiML requested from sms_url.

SmsMethod'GET' | 'POST' http-method

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

SmsUrlstring uri

The URL we should call using the sms_method when the SIM-connected device sends an SMS message that is not a Command.

VoiceFallbackMethod'GET' | 'POST' http-method

Deprecated.

VoiceFallbackUrlstring uri

Deprecated.

VoiceMethod'GET' | 'POST' http-method

Deprecated.

VoiceUrlstring uri

Deprecated.

ResetStatus'resetting'

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.

AccountSidstring

The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new. For more information, see the Move SIMs between Subaccounts documentation.

Response

OK

sidstring nullable

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

unique_namestring nullable

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_sidstring nullable

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

rate_plan_sidstring nullable

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

friendly_namestring nullable

The string that you assigned to describe the Sim resource.

iccidstring nullable

The ICCID associated with the SIM.

e_idstring nullable

Deprecated.

status'new' | 'ready' | 'active' | 'suspended' | 'deactivated' | 'canceled' | 'scheduled' | 'updating'

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.

reset_status'resetting'

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.

commands_callback_urlstring uri nullable

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'GET' | 'POST' http-method nullable

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

sms_fallback_method'GET' | 'POST' http-method nullable

Deprecated.

sms_fallback_urlstring uri nullable

Deprecated.

sms_method'GET' | 'POST' http-method nullable

Deprecated.

sms_urlstring uri nullable

Deprecated.

voice_fallback_method'GET' | 'POST' http-method nullable

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

voice_fallback_urlstring uri nullable

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'GET' | 'POST' http-method nullable

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

voice_urlstring uri nullable

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of related subresources.

ip_addressstring nullable

Deprecated.

Changes

Changes to this operation have not been checked yet.