モニター REST API: Events
イベントは Twilioのリソースの イベントを記録、変更トラッキング を提供するプラットフォームです。
例えば、電話番号の設定、アカウントのセキュリティを変更、録音ファイルを削除した時などですイベントは事実上Twilioでのアクションを全て記録します。API、Twilioコンソール、Twilioの従業員が変更 のいずれの場合も対象です。
イベント RESTリソースはイベントログの API経由での取得を提供します。それぞれの イベントは ログエントリーに類似します。
- イベントタイプ;
- イベントが関連するリソース;
- イベントを発生させた当事者;
- イベントの発生元ソース、IPアドレス; や
- すべての関連するイベントデータ(どのようなプロパティが変更されたかなど)
イベント は Twilioプロダクト全体で動作します。これらは Twilioアプリケーションで何が起きているかを全て可視化するために助けになるツールです。APIはログの取得、ログ収集ツールやSIEM(セキュリティ情報およびイベント管理)へのデータのプッシュに利用できます。
Event properties
| Names in PHP format | |
|---|---|
accountSid
|
イベントが記録されたアカウントを識別する 34 文字の文字列です。 |
actorSid
|
有効であれば、イベントを発生させた当事者 を一意に識別する 34 文字の文字列です。おそらく Null です。 |
actorType
|
イベントの当事者のタイプ例えば、 |
description
|
アドレスの より読みやすい形式の説明です。おそらく Null です。 |
eventData
|
イベントに関する他のデータがエンコードされている自由形式の JSON オブジェクトです。正確な内容は、 |
eventDate
|
イベント が生成された日時、UTC ISO 8601 フォーマットで提供 |
eventType
|
イベントタイプは文字で表されます。イベントタイプは典型的に |
resourceSid
|
影響を受けたリソース を一意に識別する 34 文字の文字列です。 |
resourceType
|
影響を受けたリソースタイプすべての リソースタイプ のリストはこちらをご覧ください。 |
sid
|
この イベント を識別する 34 文字の文字列です。 |
source
|
このイベントの発生元のシステムまたはインターフェイスです。 |
sourceIpAddress
|
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 |
url
|
|
links
|
|
イベント通知ページやイベントリストページを作成する際、これらのフィールドが役に立ちます。たとえば、"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
https://monitor.twilio.com/v1/Events/{Sid}
パラメーター
| Names in None format | |
|---|---|
sid
必須
|
この イベント を識別する 34 文字の文字列です。 |
例
Read multiple Event resources
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
オプション
|
この当事者が発生させたイベントのみを返します。特定のユーザーまたは API クレデンシャルが実行したアクションを監査する場合に役立ちます。 |
event_type
オプション
|
この EventType のイベントのみを返します。 |
resource_sid
オプション
|
このリソースを参照するイベントのみを返します。特定のリソースの履歴を見つける場合に役立ちます。 |
source_ip_address
オプション
|
この IP アドレスから発生したイベントのみを返します。API または Twilio コンソールから発生した疑わしいアクティビティを追跡する場合に役立ちます。 |
start_date
オプション
|
この日付以降のイベントのみを返します。 |
end_date
オプション
|
この日付以降のイベントのみを返します。 |
例 1
例 2
例 3
例 4
サポートされているすべてのリソースタイプとイベントタイプの完全なリスト
現在、イベントは、次に示すリソースタイプと関連イベントタイプを追跡しています。
| リソースタイプ | イベントタイプ |
|---|---|
| アカウント | 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 |
ヘルプが必要ですか？
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.