Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: Sims

To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.

A Sim instance represents a physical SIM that is capable of connecting to a wireless network.

Before becoming active, a Sim must have a Rate Plan, which describes the capabilities and restrictions that will apply to the SIM.

一般的なタスク

  • Simインスタンスを取得する
  • Simインスタンスを更新する
  • Delete a Sim instance
  • List all Sims in an Account
  • View Sim lifecycle events

非同期のリソース

Simリソースは非同期オペレーションを実行します。 Simリソースの更新終了時に非同期の通知を受信するには、最初のHTTPリクエストにコールバックURLと、オプションでコールバックメソッドパラメーターを指定することが必要です。 下記にいくつか、これを行う例を示します。

HTTPリソースとメソッド

Simインスタンスリソース

リソースURL

https://wireless.twilio.com/v1/Sims/{SimSid}
https://wireless.twilio.com/v1/Sims/{SimUniqueName}

リソースのプロパティ

Simインスタンスリソースは、下記のプロパティーによって表されます:

Names in PHP format
sid
sid<DE> Not PII

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

uniqueName
文字列 Not PII

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.

accountSid
sid<AC> Not PII

The SID of the Account that created the Sim resource.

ratePlanSid
sid<WP> Not PII

The SID of the RatePlan resource configured for this SIM.

friendlyName
文字列 PII MTL: 30 DAYS

The string that you assigned to describe the resource.

iccid
文字列 PII MTL: 30 DAYS

SIMに関連づけられているICCIDです。

eId
文字列 Not PII

Deprecated.

status
enum:status Not PII

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

resetStatus
enum:reset_status Not PII

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.

commandsCallbackUrl
url Not PII

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.

commandsCallbackMethod
http_method Not PII

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

smsFallbackMethod
http_method Not PII

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

smsFallbackUrl
url Not PII

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

smsMethod
http_method Not PII

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

smsUrl
url Not PII

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

voiceFallbackMethod
http_method Not PII

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

voiceFallbackUrl
url Not PII

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

voiceMethod
http_method Not PII

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

voiceUrl
url Not PII

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

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

url
url Not PII

The absolute URL of the resource.

links
uri_map Not PII

The URLs of related subresources.

ipAddress
文字列 Not PII

Deprecated.

ステータス値

下記の表では、Simインスタンスで使用できるstatusの値を説明しています。

Status 概要
新規

The Sim is waiting to be activated so that it can join the network. A Sim can exist in new status indefinitely at no charge, but once it is transitioned to ready or active, it cannot be returned to new.

ready

Simはネットワークに接続でき、Rate Plan(料金プラン)に応じたネットワークリソースが使用可能ですが、月額料金は発生しません

Once the SIM has consumed 250KB of data or three months have passed, the Sim will transition automatically to active status. On the fifth Command sent to_sim or from_sim, the device will automatically transition to the active status.

Use the ready status when shipping your device to a customer if you aren't exactly sure when they'll start using it.

Note: This is not available for the Narrowband developer plan.

active Simはネットワークに接続でき、Rate Plan(料金プラン)に応じたネットワークリソースが使用可能です。
suspended The Sim is blocked from connecting to the network. After three months of suspension at no charge, a suspended monthly fee will be initiated. See Suspended SIM Fees on Programmable Wireless Pricing.
deactivated The Sim is blocked from connecting to the network. After 72 hours, the Sim will transition automatically to the terminal status canceled. Use this status when you never want the Sim to reconnect (for example, if it has been lost or stolen).
canceled Terminal status. The Sim is blocked from connecting to the network and can no longer be reactivated.
scheduled 上流のネットワーク事業者は一時的にSIMのステータスを更新できません。 上流のネットワーク事業者がトランザクションの受け入れを再開すると、Simは要求されたステータスに自動的に更新されます。
updating Simに非同期での更新が行われています。 Simの更新中は、一部の項目を変更できない可能性があります。 このような場合、409 Conflictレスポンスを返します。

Simインスタンスを取得する

HTTP GET

SidまたはAliasプロパティーによって識別されるSimの表現を返します。

Retrieve a SIM Instance using SID or Alias

In the following example, a Sim instance is requested using its *Sid*, represented as JSON.

        
        
        
        

        Retrieve a Sim using its UniqueName

        In this example, a Sim instance is requested using its UniqueName, represented as JSON.

              
              
              
              

              HTTP POST

              POSTメソッドで、Simインスタンスリソースを更新できます。

              パラメーター

              下記パラメーターの一部、または全部が提供できます。 リクエストパラメーターがインスタンスリソースのプロパティーに対応する場合、そのプロパティーが与えられた値によって更新されます。

              Names in PHP format
              sid
              必須
              post sid_like<DE> Not PII

              The SID of the Sim resource to update.

              uniqueName
              オプション
              post 文字列 Not PII

              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
              オプション
              post http_method Not PII

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

              callbackUrl
              オプション
              post url Not PII

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

              friendlyName
              オプション
              post 文字列 PII MTL: 30 DAYS

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

              ratePlan
              オプション
              post sid_like<WP> Not PII

              The sid or unique_name of the RatePlan resource that this SIM should use.

              status
              オプション
              post enum:status Not PII

              The new status of the resource. Can be: ready, active, suspended or deactivated; however the SIM might support additional values.

              commandsCallbackMethod
              オプション
              post http_method Not PII

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

              commandsCallbackUrl
              オプション
              post url Not PII

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

              smsFallbackMethod
              オプション
              post http_method Not PII

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

              smsFallbackUrl
              オプション
              post url Not PII

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

              smsMethod
              オプション
              post http_method Not PII

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

              smsUrl
              オプション
              post url Not PII

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

              voiceFallbackMethod
              オプション
              post http_method Not PII

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

              voiceFallbackUrl
              オプション
              post url Not PII

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

              voiceMethod
              オプション
              post http_method Not PII

              The HTTP method we use when we call voice_url. Can be: GET or POST.

              voiceUrl
              オプション
              post url Not PII

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

              resetStatus
              オプション
              post enum:reset_status Not PII

              Initiate a connectivity reset on the SIM. Set to resetting to initiate a connectivity reset on the SIM. No other value is valid.

              コールバック値

              コールバックURLがリクエストに含まれる場合、下記のパラメーターを含む非同期リクエストがそのURLに発行されます。

              パラメーター 概要
              SimSid このコールバックの参照元のSimです。
              SimUniqueName 存在する場合、そのSimのUniqueName(一意な名前)です。
              SimStatus Simの新しいステータスを表す更新文字列です。
              ErrorCode エラーの発生時、エラーコードが提供されます。
              ErrorMessage エラーの発生時、エラーメッセージが提供されます。
              ApiVersion 最初のリクエストが発行されたAPIのバージョンです。
              AccountSid このコマンドの属するアカウントの一意なIDです。

              コールバックメソッドがPOSTに設定されるか指定されなかった場合、コールバックパラメーターはHTMLフォームパラメーターとして渡されます。 コールバックメソッドがGETであった場合、コールバックパラメーターはクエリー文字列として渡されます。

              Simインスタンスを更新する

              In the following example, a Sim is updated by setting its status to active. Provide a callback URL and callback method to be asynchronously notified when the update has completed.

                    
                    
                    
                    

                    HTTP PUT

                    サポートされていません。

                    Delete a SIM Instance

                    HTTP DELETE

                    Delete a Sim from your account.

                    Simインスタンスのサブリソース

                    Sims Data Sessions Subresource

                    Real time insight into how and where your device is connecting to the cellular networks. See REST API: SIM Data Sessions resource.

                    Resource URLs:

                    https://wireless.twilio.com/v1/Sims/{Sid}/DataSessions
                    https://wireless.twilio.com/v1/Sims/{UniqueName}/DataSessions
                    

                    Sims Usage Records Subresource

                    Represents a usage report for the Sim over a specified period. See REST API: SIM Usage Records resource for properties and response formats.

                    Resource URLs:

                    https://wireless.twilio.com/v1/Sims/{SimSid}/UsageRecords
                    https://wireless.twilio.com/v1/Sims/{SimUniqueName}/UsageRecords
                    

                    Simsリストリソース

                    Resource URL:

                    https://wireless.twilio.com/v1/Sims
                    

                    List all SIMs in an Account

                    HTTP GET

                    HTTP GET returns a list of Sims within an account. The list includes paging information.

                          
                          
                          
                          

                          リストフィルター

                          The following GET query string parameters allow you to limit the list returned. Note that parameters are case-sensitive.

                          パラメーター 概要
                          Status このステータスのSimのみを返す
                          RatePlan この料金プランのSimのみを返す
                          Iccid Return Sims with thie Iccid. Currently, this should be a list with a maximum size 1.

                          HTTP POST

                          サポートされていません。 SIMリソースはSIMを注文するか、またはスターターSIMを登録することで作成されます。

                          HTTP PUT

                          サポートされていません。

                          HTTP DELETE

                          サポートされていません。

                          View SIM Lifecycle Events

                          The lifecycle events of a Sim are audited and reported by Monitor Events. An update to a Sim resource results in a Monitor Event with an Event Type of wireless-sim.updated.

                          The valid resource_properties that can be reported are rate_plan_sid and status. For each, a previous and updated value may be provided. For example:

                          "event_data": {
                            "resource_properties": {
                              "rate_plan_sid": {
                                "previous": "WP0195dea2f0b1e00dbc54d0715e36e2db",
                                "updated": "WP3b921b4711ee21ac01c7075a7eb19fcf"
                              },
                              "status": {
                                "previous": "new",
                                "updated": "active"
                              }
                            }
                          }
                          
                          Rate this page:

                          ヘルプが必要ですか?

                          誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。