メニュー

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

Simインスタンスは無線網に接続できる物理的なSIMを表します。

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.

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

このリソースを一意に識別する 34 文字の文字列です。

uniqueName
文字列 Not PII

このリソースをsidの代わりに一意に識別する、ユーザー提供の文字列です。

accountSid
sid<AC> Not PII

このコマンドの属するアカウントの一意なIDです。

ratePlanSid
sid<WP> Not PII

このSimに対して構成されたRate Plan(料金プラン)の一意なIDです。

friendlyName
文字列 PII MTL: 30 DAYS

このリソースを識別するユーザー提供の文字列です。 一意ではありません。

iccid
文字列 PII MTL: 30 DAYS

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

eId
文字列 Not PII

status
enum:status Not PII

Simのステータスを表している文字列です。 取りうる値はnewreadyactivedeactivatedcanceledscheduled、またはupdatingです。 各ステータスの説明については、ステータス値を参照してください。

resetStatus
enum:reset_status Not PII

A string representing the connectivity reset status of the Sim. May be null or resetting. When a connectivity reset is initiated on a Sim, this property is set to resetting, once the reset is complete it is set to null.

commandsCallbackUrl
url Not PII

The URL that will receive a webhook when this 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

commands_callback_urlへのリクエストの発行時に使用するHTTPメソッドを表す文字列です。 POSTまたはPOSTのいずれかです。 既定値はPOSTです。

smsFallbackMethod
http_method Not PII

sms_fallback_url へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。GET または POST のいずれかです。

smsFallbackUrl
url Not PII

VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する sms_url です。

smsMethod
http_method Not PII

voice_urlをリクエストするときに使用されるメソッド。GETもしくはPOSTです

smsUrl
url Not PII

The URL Twilio will request when the SIM-connected device send an SMS that is not a Command.

voiceFallbackMethod
http_method Not PII

voice_fallback_url へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。GET または POST のいずれかです。

voiceFallbackUrl
url Not PII

VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する voice_url です。

voiceMethod
http_method Not PII

voice_urlをリクエストするときに使用されるメソッド。GETもしくはPOSTです

voiceUrl
url Not PII

SIMの接続されたデバイスが通話を発信したときにTwilioがリクエストするURLです。

dateCreated
date_time<iso8601> Not PII

このリソースの作成された日時で、ISO 8601形式のGMTで取得可能です。

dateUpdated
date_time<iso8601> Not PII

このリソースが最後に更新された日時で、ISO 8601形式のGMTで取得可能です。

url
url Not PII

このリソースに対するURLです。

links
uri_map Not PII

各Simインスタンスリソースは利便性を考慮し、下記に一覧されているいくつかのサブリソースをサポートしています。

ipAddress
文字列 Not PII

ステータス値

下記の表では、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

The Sim can connect to the network and is capable of consuming network resources in accordance with its Rate Plan, but no monthly fee will be charged.

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レスポンスを返します。

Retrieve a Sim Instance

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

              このリソースを一意に識別する 34 文字の文字列です。

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

              このリソースをSidの代わりに一意に識別する、ユーザー提供の文字列です。

              callbackMethod
              オプション
              post http_method Not PII

              コールバックURLへのリクエストの発行時にTwilioが使用するHTTPメソッド(有効な選択肢はGETまたはPOST)です。 既定値はPOSTです。

              callbackUrl
              オプション
              post url Not PII

              TwilioはSimが更新を終了すると、このURLにリクエストを発行します。 Simのnewステータスからreadyステータスへの、またはどのステータスからでもdeactivatedステータスへの移行時、2つのコールバックを受信します。 ひとつは、Simが中間ステータスに遷移した際の(readyまたはdeactivated)、そしてもうひとつは最終ステータスに移行する際のステータス(activeまたはcanceled)です。

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

              このリソースを識別するユーザー提供の文字列です。 一意ではありません。

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

              The Sid or UniqueName of the RatePlan that this Sim should use.

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

              Simのステータスを表している文字列です。 有効なオプションはSimの現在の状態によりますが、readyactivesuspendedまたはdeactivatedが考えられます。

              commandsCallbackMethod
              オプション
              post http_method Not PII

              CommandsCallbackUrlへのリクエストの発行時に使用するHTTPメソッドを表す文字列です。 POSTまたはPOSTのいずれかです。 既定値はPOSTです。

              commandsCallbackUrl
              オプション
              post url Not PII

              The URL that will receive a webhook when this Sim originates a Command. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

              smsFallbackMethod
              オプション
              post http_method Not PII

              The HTTP method Twilio will use when requesting the sms_fallback_url. Either GET or POST.

              smsFallbackUrl
              オプション
              post url Not PII

              VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する sms_url です。

              smsMethod
              オプション
              post http_method Not PII

              voice_urlをリクエストするときに使用されるメソッド。GETもしくはPOSTです

              smsUrl
              オプション
              post url Not PII

              The URL Twilio will request when the SIM-connected device sends an SMS message that is not a Command.

              voiceFallbackMethod
              オプション
              post http_method Not PII

              voice_fallback_urlをリクエストする時に使用されるHTTPメソッド。 GETもしくはPOSTです。

              voiceFallbackUrl
              オプション
              post url Not PII

              VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する voice_url です。

              voiceMethod
              オプション
              post http_method Not PII

              voice_urlをリクエストするときに使用されるメソッド。GETもしくはPOSTです

              voiceUrl
              オプション
              post url Not PII

              SIMの接続されたデバイスが通話を発信したときにTwilioがリクエストするURLです。

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

              Pass resetting to initiate a connectivity reset on a Sim, this is the only valid value for this parameter.

              コールバック値

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

              パラメーター 概要
              SimSid このコールバックの参照元のSimです。
              SimUniqueName The Sim's UniqueName, if it has one.
              SimStatus |
              SimStatus Simの新しいステータスを表す更新文字列です。
              ErrorCode エラーの発生時、エラーコードが提供されます。
              ErrorMessage エラーの発生時、エラーメッセージが提供されます。
              ApiVersion 最初のリクエストが発行されたAPIのバージョンです。
              AccountSid このコマンドの属するアカウントの一意なIDです。

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

              Update a SIM Instance

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

                          Not Supported. SIM resources are created by ordering SIMs, or registering a Starter 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:

                          ヘルプが必要ですか?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.