メニュー

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?

通話データリソース

The event log provides events on any state change transitions that occur during a call, warnings seen on deteriorating network quality or audio equipment malfunction, and the events raised when the feedback submitted by the end user. At this time only Client Insights information is accessible via the API.

通話イベントを受け取る

イベントログは通話中に発生する状態変化の遷移、ネットワーク品質の低下やオーディオ機器の誤動作、およびエンドユーザーによってフィードバックが送信されたときに発生するイベントを提供します。 EventsリソースURIへのGETリクエストによって、イベントログを取得できます。

GET /Calls/{Call SID}/Events
        
        
        
        

        クエリーパラメーター

        パラメーター 概要
        Level 情報(INFO)、デバッグ(DEBUG)、警告z(WARNING)、そしてエラー(ERROR)レベルのイベントに基づいてイベント一覧をフィルタリングします。
        Group 特定のグループからのイベントに対してイベント一覧をフィルタリングします。

        リソースのプロパティ

        イベントプロパティー 概要
        group イベントの属するグループです。 グループは、以下のうちのいずれかの値を取ります: network-quality-warning-raisednetwork-quality-warning-clearedaudio-quality-warning-raisedaudio-quality-warning-clearedice-connection-statesignaling-statefeedback
        name イベントの識別子です。
        level イベントの深刻度に応じて、下記の値を取りえます: INFODEBUGWARNING、またはERROR
        timestamp クライアント上でイベントが記録された時点のタイムスタンプです。
        account_sid この通話の発信に使用されたAccountSIDです。
        payload_type ペイロードのタイプは下記の通りです: application/JSON
        ペイロード イベント固有のデータを含むペイロードです。
        sid このイベントの一意な識別しです。
        account_friendly_name 通話の発信に使用されたアカウントの名前です。
        parent_account_friendly_name 親アカウントの名前です。
        parent_account_sid 親アカウントのアカウントSIDです。
        publisher このイベントを発行したSDKまたはサーバーの名前です。 以下の値を取りえます: twilio-client-jstwilio-client-iostwilio-client-js、またはtwilio-serverです。
        publisher_metadata これはイベントの発行者の特徴を含んだオブジェクトです。

        発行者のメタデータ

        プロパティ 概要
        住所3(市区町村) クライアントが通話をかけた(または取った)市町村です。
        cpu_architecture 通話を発信(または受信)したデバイスのCPUアーキテクチャー(利用可能な場合)です
        engine_name Webページをレンダリングしたエンジンソフトウェア(Gecko、Webkitなど)です。
        location.lat クライアントのエンドポイントが位置していた場所の緯度です。
        location.lon クライアントのエンドポイントが位置していた場所の経度です。
        os_version 使用されたオペレーティングシステムのバージョン番号です。
        device_model クライアントに使用されたデバイスのモデルです。;
        os_name クライアントに使用されたオペレーティングシステムの名前です。
        country_iso_code 国を表現する2文字のISOコードです。
        クライアントが位置する国の名前です。
        user_agent イベント発行者から展開された、生のユーザーエージェント文字列です。
        device_type デバイスの種類(mobile(携帯電話)、laptop(ノートPC)、desktop(デスクトップPC))
        browser_major 通話の発信に使用されたブラウザーのメジャーバージョン番号です。
        engine_version Webページのレンダリングに使用されたエンジンソフトウェアのバージョン番号です。
        device_vendor デバイスの製造者です。 JavaScriptの場合、通常はnullです。
        browser_version 通話の発信に使用されたブラウザーのメジャーバージョン番号です。
        client_address 通話を発信したクライアントのIPアドレスです。
        browser_name 通話の発信に使用されたブラウザーの名前です。
        specific_subdivision 通話の発信された場所の名前です。

        ペイロード

        プロパティ 概要
        CLIENT_NAME 開発者によって与えられたクライアントの名前です。
        Direction Twilioから見た場合の通話の方向で、Outbound(発信)、Inbound(着信)のいずれかです。
        gateway 通話のルーティングに使用されたAWSのゲートウェイです。
        temp_call_sid 通話の接続中に使用される一時的なCall SIDです。
        selected_region 開発者によって選択された地域です。 既定ではGLLです。
        region この通話がルーティングされた地域です。
        sdk_version 通話の発信に使用されたTwilio Client SDKのバージョンです。
        プラットフォーム クライアントによって使用された下層のプラットフォーム(WebRTC/ORTC/iOS)です。
        audio_constraints AudioConstraintパラメーター: TwilioクライアントののaudioConstraintsパラメーターでは、根底の通話に直接オーディオ制限を渡すことで、AGCのような機能を有効または無効にできます。
        timestamp_ms ミリ秒精度のタイムスタンプです。
        Data イベントペイロード固有の追加情報を含むデータオブジェクトです。

        通話メトリックスを取得する

        ネットワーク品質を測定するため、Twilioクライアントのセンサーライブラリーは通話のライフサイクルにわたって毎秒ごとに通話メトリックスを標本化します。 これらのメトリックスは10秒ごとに、Twilio Insightsのバックエンドに送信されます。 MetricsリソースへのGETリクエストによって、通話に対するメトリックスデータを取得できます。

        GET /Calls/{Call SID}/Metrics
              
              
              
              

              リソースのプロパティ

              プロパティ 概要
              call_sid Call SIDはこの通話に対する一意な識別子です。
              timestamp このメトリックペイロードが記録された時点のタイムスタンプです。
              timestamp_ms ミリ秒精度のタイムスタンプです。
              jitter ジッターはRTT内におけるゆらぎの単位です。 これはミリ秒で表されます。 高ジッターは貧弱な通話品質と相関します。
              mos 平均オピニオン評点です。 これは全般的なネットワーク品質を表現する1〜4.5までのスコアです。
              rtt このサンプルの記録されたラウンドトリップタイム(ミリ秒)です。
              audio_level_out クライアント側で測定されたオーディオ出力レベルです。
              audio_level_in クライアント側で測定されたオーディオ入力レベルです。 マイクが消音状態になると、この値は0になります。
              packets_received このサンプルで受信されたパケット数です。
              packets_lost このサンプル中のパケットロスの数です。
              packets_lost_fraction このサンプルにおけるパケットロスの比率です。
              total_packets_received 通話中にこれまでに受信したパケットの累積数です。
              total_packets_lost このサンプルにおけるパケットロスの数です。
              total_bytes_sent この通話においてこれまで送信(受信)された累積バイト数です。
              total_bytes_received この通話においてこれまで送信(受信)された累積バイト数です。
              total_packets_sent 通話中に送信されたパケットの累積数です。

              通話サマリーを取得する

              通話サマリーリソースは1回のリクエストで通話に対するイベントログとメトリックスの双方を提供します。

              GET /Calls/{Call SID}/Summary
                    
                    
                    
                    

                    リソースのプロパティ

                    プロパティ 概要
                    account_friendly_name 通話の発信に使用されたアカウントの名前です。
                    parent_account_friendly_name 親アカウントの名前です。
                    parent_account_sid 親アカウントのアカウントSIDです。
                    call_sid Call SIDはこの通話に対する一意な識別子です。
                    parent_call_sid 親通話のCall SIDです。
                    サマリー 通話とメトリックスの要約を納めたサマリーオブジェクトです。 Summaryのプロパティーについては、下記をご参照ください。

                    Summaryオブジェクトのプロパティー

                    プロパティ 概要
                    publisher_metadata 上記で指定された発行者のメタデータオブジェクトと同様です。
                    Events 各グループおよびレベルにおけるイベント数が含まれています。
                    metrics メトリックスサマリーにはJitter、MoS、RTT、AudioLevelOut、AudioLevelIn、PacketLost、PacketReceived、PacketSentが含まれます。
                    client_metadata クライアントメタデータにはクライアント名、SDKバージョン、地域、選択された地域、および通話を誰が切ったのか、といった情報が含まれています。

                    Disconnected By オブジェクトプロパティー

                    プロパティ 概要
                    local Twilioクライアントの切断が開始されました。 "disconnected-by-local"イベントはイベントログ内に記録されます。
                    remote クライアントが、サーバーからの切断イベントを受信しました。 イベントログには"disconnected-by-remote"イベントが記録されます。
                    na A disconnect event was not generated. This could be due to multiple reasons: computer crashes, network issues, the browser being closed or crashing while the call was in progress, the client object being destroyed before the event could be sent to Twilio Insights, or any other behavior that results in Twilio not receiving the final events from the SDK unexpectedly. These will appear as "disconnected by: unknown" when viewing Insights data in Console and aggregate reports.
                    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.