メニュー

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

イベントは Twilioのリソースの イベントを記録、変更トラッキング を提供するプラットフォームです。

例えば、電話番号の設定、アカウントのセキュリティを変更、録音ファイルを削除した時などですイベントは事実上Twilioでのアクションを全て記録します。API、Twilioコンソール、Twilioの従業員が変更 のいずれの場合も対象です。

イベント RESTリソースはイベントログの API経由での取得を提供します。それぞれの イベントは ログエントリーに類似します。

  • イベントタイプ;
  • イベントが関連するリソース;
  • イベントを発生させた当事者;
  • イベントの発生元ソース、IPアドレス; や
  • すべての関連するイベントデータ(どのようなプロパティが変更されたかなど)

イベント は Twilioプロダクト全体で動作します。これらは Twilioアプリケーションで何が起きているかを全て可視化するために助けになるツールです。APIはログの取得、ログ収集ツールやSIEM(セキュリティ情報およびイベント管理)へのデータのプッシュに利用できます。

Event properties

Names in Python format
account_sid
sid<AC> Not PII

イベントが記録されたアカウントを識別する 34 文字の文字列です。

actor_sid
sid<US> Not PII

有効であれば、イベントを発生させた当事者 を一意に識別する 34 文字の文字列です。おそらく Null です。

actor_type
文字列 Not PII

イベントの当事者のタイプ例えば、userはTwilioコンソールでログインユーザーを変更した場合、accountは認証されたアカウントからAPIを経由して発生したイベント、twilio-adminはTwilioの従業員などです。

description
文字列 Not PII

アドレスの より読みやすい形式の説明です。おそらく Null です。

event_data
オブジェクト Not PII

イベントに関する他のデータがエンコードされている自由形式の JSON オブジェクトです。正確な内容は、event_type に応じて異なります。 たとえば、フォーム RESOURCE.updated のイベントデータの場合、event_data には、リソースのプロパティの更新前後の値がエンコードされた resource_properties ディクショナリが格納されます。

event_date
date_time<iso8601> Not PII

イベント が生成された日時、UTC ISO 8601 フォーマットで提供

event_type
文字列 Not PII

イベントタイプは文字で表されます。イベントタイプは典型的にRESOURCE_TYPE.ACTIONのフォームで、RESOURCE_TYPEが影響を与えたリソースを示し、ACTIONは何が起きたかを示します。例えば、phone-number.created。すべての イベントタイプのリストはこちらをご覧ください。

resource_sid
sid Not PII

影響を受けたリソース を一意に識別する 34 文字の文字列です。

resource_type
文字列 Not PII

影響を受けたリソースタイプすべての リソースタイプ のリストはこちらをご覧ください。

sid
sid<AE> Not PII

この イベント を識別する 34 文字の文字列です。

source
文字列 Not PII

このイベントの発生元のシステムまたはインターフェイスです。web は、Twilio コンソールでのユーザーの操作により発生したイベントを示します。api は、REST API にリクエストを送信したことにより発生したイベントを示します。twilio は、Twilio の自動システムまたは内部システムにより発生したイベントを示します。

source_ip_address
文字列 Not PII

The IP address of the source, if the source is outside the Twilio cloud. For instance, the ip address of an originating API request. Null for events with {"source": "twilio"}

url
url Not PII

links
uri_map Not PII

イベント通知ページやイベントリストページを作成する際、これらのフィールドが役に立ちます。たとえば、"On {event_date}, a {event_type} event was generated for resource {resource_type} via {source} by {actor_type} {actor_sid} from {source_ip_address}" のように、人間が読みやすい形式の文字列を表示できます。

ソース、当事者タイプ、および当事者 Sid

ソース、当事者タイプ、および当事者 Sid は、密接に関係しています。これらはすべて、誰または何が、どこで、イベントを発生させたかを示すのに役立ちます。次の表は、あなたが目にするであろう、最も一般的な組み合わせを示します。

ソース actor_type actor_sid description
api アカウント AC123 アカウント AC123 は、API により認証され、イベントを発生させました。
Web user US456 Sid が US456 であるユーザーが Twilio コンソールにログインして、イベントを発生させました。このユーザーの Sid は、Twilio コンソールの「Manager Users」ページで確認できます。
twilio twilio-admin null Twilio 管理者が Twilio の管理インターフェイスで変更を行いました。

Fetch an Event resource

GET
https://monitor.twilio.com/v1/Events/{Sid}
パラメーター
Names in None format
sid
必須
GET sid<AE> Not PII

この イベント を識別する 34 文字の文字列です。

        
        
        
        

        Read multiple Event resources

        GET
        https://monitor.twilio.com/v1/Events

        Returns a list of Events in this account, sorted by event-date. This list includes [paging information][4].

        デフォルトでは、すべてのイベントが返されます。StartDate パラメーターと EndDate パラメーターを使用して、いつでもイベント日でイベントをフィルタリングできます。

        In addition, you may filter by any one of the other fields. Filtering on more than one field in the same request is not supported and will result in a 400 Bad Request error.

        [4] /docs/api/rest/response#response-formats-list-paging-information

        パラメーター
        Names in None format
        actor_sid
        オプション
        GET sid<US> Not PII

        この当事者が発生させたイベントのみを返します。特定のユーザーまたは API クレデンシャルが実行したアクションを監査する場合に役立ちます。

        event_type
        オプション
        GET 文字列 Not PII

        この EventType のイベントのみを返します。

        resource_sid
        オプション
        GET sid Not PII

        このリソースを参照するイベントのみを返します。特定のリソースの履歴を見つける場合に役立ちます。

        source_ip_address
        オプション
        GET 文字列 Not PII

        この IP アドレスから発生したイベントのみを返します。API または Twilio コンソールから発生した疑わしいアクティビティを追跡する場合に役立ちます。

        start_date
        オプション
        GET date_time<iso8601> Not PII

        この日付以降のイベントのみを返します。EndDate と組み合わせて、イベントの日付範囲を定義するのに役立ちます。入力はUTC ISO 8601タイムスタンプですが、時間の部分はフィルターで無視されます。

        end_date
        オプション
        GET date_time<iso8601> Not PII

        この日付以降のイベントのみを返します。StartDate と組み合わせて、イベントの日付範囲を定義するのに役立ちます。入力はUTC ISO 8601タイムスタンプですが、時間の部分はフィルターで無視されます。

        例 1
              
              
              
              
              An example that filters for all events in March, 2015

              日付によるフィルタリング

              An example that filters for all events in March, 2015
              例 2
                    
                    
                    
                    
                    Using the Events list resource and the `ResourceSid` filter to find out everything that happened a a specific phone-number

                    電話番号のフィルタリング

                    Using the Events list resource and the `ResourceSid` filter to find out everything that happened a a specific phone-number
                    例 3
                          
                          
                          
                          
                          Using the `SourceIpAddress` filter to track the activity of a particular IP address on a day in April

                          IP アドレスのフィルタリング

                          Using the `SourceIpAddress` filter to track the activity of a particular IP address on a day in April
                          例 4
                                
                                
                                
                                
                                `ActorSid`, `ResourceSid`, and `SourceIpAddress` may only be used one-at-a-time, so this request that uses both `ActorSid` and `ResourceSid` returns an HTTP 400 error

                                一度に使用するフィルタープロパティーは 1 つだけです!

                                `ActorSid`, `ResourceSid`, and `SourceIpAddress` may only be used one-at-a-time, so this request that uses both `ActorSid` and `ResourceSid` returns an HTTP 400 error

                                サポートされているすべてのリソースタイプとイベントタイプの完全なリスト

                                現在、イベントは、次に示すリソースタイプと関連イベントタイプを追跡しています。

                                リソースタイプ イベントタイプ
                                アカウント account.created
                                account.updated
                                account.deleted
                                アプリケーション application.created
                                application.updated
                                application.deleted
                                authorized-connect-app authorized-connect-app.created
                                authorized-connect-app.deleted
                                call call.deleted
                                caller-id caller-id.created
                                caller-id.updated
                                caller-id.deleted
                                connect-app connect-app.created
                                connect-app.updated
                                connect-app.deleted
                                invoice-settings invoice-settings.updated
                                message message.updated
                                message.deleted
                                message-body message-body.deleted
                                message-media message-media.deleted
                                payment payment.created
                                payment-method payment-method.created
                                payment-method.updated
                                payment-method.deleted
                                payment-refund payment-refund.created
                                phone-number phone-number.created
                                phone-number.updated
                                phone-number.deleted
                                recharge-trigger recharge-trigger.created
                                recharge-trigger.updated
                                recharge-trigger.deleted
                                レコーディング recording.deleted
                                Shortcode shortcode.created
                                shortcode.updated
                                shortcode.deleted
                                sip-credential-list sip-credential-list.created
                                sip-credential-list.updated
                                sip-credential-list.deleted
                                sip-domain sip-domain.created
                                sip-domain.updated
                                sip-domain.deleted
                                sip-ip-access-control-list sip-ip-access-control-list.created
                                sip-ip-access-control-list.updated
                                sip-ip-access-control-list.deleted
                                support-plan support-plan.updated
                                sms-geographic-permissions sms-geographic-permissions.updated
                                トランスクリプション transcription.deleted
                                usage-trigger usage-trigger.created
                                usage-trigger.updated
                                usage-trigger.deleted
                                voice-geographic-permissions voice-geographic-permissions.updated
                                wireless-sim wireless-sim.updated
                                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.