モニター REST API: Events
イベントは Twilioのリソースの イベントを記録、変更トラッキング を提供するプラットフォームです。
例えば、電話番号の設定、アカウントのセキュリティを変更、録音ファイルを削除した時などですイベントは事実上Twilioでのアクションを全て記録します。API、Twilioコンソール、Twilioの従業員が変更 のいずれの場合も対象です。
イベント RESTリソースはイベントログの API経由での取得を提供します。それぞれの イベントは ログエントリーに類似します。
- イベントタイプ;
- イベントが関連するリソース;
- イベントを発生させた当事者;
- イベントの発生元ソース、IPアドレス; や
- すべての関連するイベントデータ(どのようなプロパティが変更されたかなど)
イベント は Twilioプロダクト全体で動作します。これらは Twilioアプリケーションで何が起きているかを全て可視化するために助けになるツールです。APIはログの取得、ログ収集ツールやSIEM(セキュリティ情報およびイベント管理)へのデータのプッシュに利用できます。
イベントプロパティー
| Names in PHP format | |
|---|---|
accountSid
|
The SID of the Account that created the Event resource. |
actorSid
|
The SID of the actor that caused the event, if available. Can be |
actorType
|
The type of actor that caused the event. Can be: |
description
|
A description of the event. Can be |
eventData
|
An object with additional data about the event. The contents depend on |
eventDate
|
The date and time in GMT when the event was recorded specified in ISO 8601 format. |
eventType
|
The event's type. Event-types are typically in the form: |
resourceSid
|
The SID of the resource that was affected. |
resourceType
|
The type of resource that was affected. For a full list of all resource-types, see the Monitor Event Types. |
sid
|
The unique string that we created to identify the Event resource. |
source
|
The originating system or interface that caused the event. Can be: |
sourceIpAddress
|
The IP address of the source, if the source is outside the Twilio cloud. This value is |
url
|
The absolute URL of the resource that was affected. Can be |
links
|
The absolute URLs of related resources. |
イベント通知ページやイベントリストページを作成する際、これらのフィールドが役に立ちます。たとえば、"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
必須
|
The SID of the Event resource to fetch. |
例
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.
By default, all Events are included. You can always filter your
Events by event-date using theStartDateandEndDateparameters.
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 a400 Bad Request error.
パラメーター
| Names in None format | |
|---|---|
actor_sid
オプション
|
Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials. |
event_type
オプション
|
Only include events of this Event Type. |
resource_sid
オプション
|
Only include events that refer to this resource. Useful for discovering the history of a specific resource. |
source_ip_address
オプション
|
Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console. |
start_date
オプション
|
Only include events that occurred on or after this date. Specify the date in GMT and ISO 8601 format. |
end_date
オプション
|
Only include events that occurred on or before this date. Specify the date in GMT and ISO 8601 format. |
例 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 |
ヘルプが必要ですか？
誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。