Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

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

ステータス・コールバック

概要

Status Callbacks allow you to receive events related to the REST resources managed by Twilio: Rooms, Recordings and Compositions.

すべてのHTTPリクエストの「Content-Type」ヘッダーは“application/x-www-urlencoded”に設定されます。

目次

Rooms ステータスコールバック

Rooms Status Callbacks allow you to receive events related to your Rooms via HTTP request. Configure a StatusCallback URL when creating a Room using the REST API, and Twilio will make an HTTP request (webhook) to that URL whenever an event takes place in the Room.

Rooms APIは下記のステータスコールバックイベントを生成します。

Rooms ステータスコールバックイベント

The following events are dispatched to webhook URL specified at Room creation.

イベント 概要
room-created Room created.
room-ended Roomが終了しました。 (メモ: REST APIによって作成されたRoomsは、5分間Roomが空になるとroom-endedイベントを発行します。)
participant-connected Participant joined the Room.
participant-disconnected Participant left the Room.
track-added Participant added a Track.
track-removed Participant removed a Track.
track-enabled Participant unpaused a Track.
track-disabled Participant paused a Track.
recording-started Trackに対するRecordingが開始されました
recording-completed Trackに対するRecordingが完了しました
recording-failed レコーディング操作のリクエスト中に処理が失敗しました

A curl example of configuring the StatusCallback URL.

 curl -XPOST 'https://video.twilio.com/v1/Rooms' \
 -u '{API Key SID}:{API Secret}' \
 -d 'UniqueName=DailyStandup' \
 -d 'StatusCallback=https://hooks.yoursite.com/room-events' \
 -d 'StatusCallbackMethod=POST' \
 -d 'Type=peer-to-peer'

Roomsステータスコールバックリクエストパラメーター

Twilio passes the following parameters in each of the above-listed events whenever it makes an HTTP request to the StatusCallback URL you've set:

パラメーター イベント 概要
AccountSid すべて The AccountSid associated with this Room
Room Name すべて The UniqueName of the Room generating this event.
RoomSid すべて The Sid of the Room generating this event.
RoomStatus すべて The Status of the Room generating this event.
roomType すべて The Type of the Room generating this event.
StatusCallbackEvent すべて Roomイベント 例えば、room-createdです。 完全なリストについては、Roomsステータスコールバックイベントを参照してください。
Timestamp すべて イベントの時間です。 UTC ISO 8601タイムスタンプに適合しています。
ParticipantSid All Participant and Track Events The Sid for the Participant generating this event.
ParticipantStatus All Participant and Track Events このイベントを生成したParticipantの現在のStatusです - connectedまたはdisconnectedのいずれかです。
ParticipantDuration Only on participant-disconnected event The total duration the Participant remained connected to the Room.
ParticipantIdentity All Participant and Track Events The Identity of the Participant generating this event. Participant identities are set via the Participant's Access Token
RoomDuration Only on room-ended The total duration of the Room, in seconds.
TrackSid Trackの全イベント TrackのSidです。
TrackKind Trackの全イベント The Kind of the Track (data, audio or video).

Recordingsステータスコールバックのリクエストパラメーター

The parameters below are included only in events related to Recordings.

パラメーター EventType 概要
AccountSid recording-*の全イベント TwilioのアカウントSID
RecordingSid recording-*の全イベント RecordingSID.
Timestamp recording-*の全イベント イベントの時間です。 UTC ISO 8601タイムスタンプに適合しています。
StatusCallbackEvent recording-*の全イベント Roomのイベントです。 たとえば、recording-startedなどです。
RoomSid recording-*の全イベント The Sid of the Room generating this recording.
Room Name recording-*の全イベント The given name of the Room generating this recording.
roomType すべて The Type of the Room generating this event.
ParticipantSid recording-*の全イベント The Sid of the Participant generating this recording.
SourceSid recording-*の全イベント This recording’s source TrackSID, MTxxx.
RecordingUri recording-*の全イベント The relative URL to retrieve this recording's metadata.
MediaUri Only on recording-completed 生成されたメディアを取得するためのURLです。
Duration Only on recording-completed レコーディングの長さです。
Size Only on recording-completed レコーディングされた総バイト数です。
Container recording-*の全イベント Container of the recording. Container used are mka for audio recordings and mkv for video recordings.
Codec recording-*の全イベント Codec used for this recording. This could be PCMU or OPUS for audio recordings, and VP8 or H264 for video recordings.
ParticipantIdentity recording-*の全イベント The Identity of the Participant generating this event. Participant identities are set via the Participant's Access Token.
TrackName recording-*の全イベント The name that was given to the source track of this recording. If no name is given, the SourceSid is used.
Type recording-*の全イベント The type of track for this recording, audio or video.
FailedOperation Only on recording-failed 失敗した操作: RecordingStart | RecordingComplete | RecordingUpload

Composition Status Callbacks

Compositions Status Callbacks allow you to receive events related to your Compositions via HTTP request. Configure a StatusCallback URL when creating a Composition using the REST API, and Twilio will make an HTTP request (webhook) to that URL whenever an event takes place in the Composition.

The Compositions API will generate the following Status Callback events.

Compositions Status Callback events

The following events are dispatched to webhook URL specified at Composition creation.

イベント 概要
composition-started The media processing task started.
composition-available The media processing tasks completed and the Composition media file can be downloaded.
composition-progress Progress report for the media composition task, sent approximately every 10%.
composition-failed The media processing task failed.

Compositions Status Callback request parameters

The parameters below are included in the composition-* events.

パラメーター EventType 概要
AccountSid composition-*の全イベント TwilioのアカウントSID
CompositionSid composition-*の全イベント SID of the Composition.
CompositionUri composition-*の全イベント The relative URL to retrieve the Composition's metadata.
MediaUri Only on composition-available The relative URL to fetch the composed media.
Duration Only on composition-available Duration of the composition.
Size Only on composition-available Total number of bytes of the resulting composition.
PercentageDone Only on composition-progress Percentage of composition done.
SecondsRemaining Only on composition-progress Estimated time remaining for the composition job to be finished (in seconds).
FailedOperation Only on composition-failed Operation that failed.
ErrorMessage Only on composition-failed Human-readable message that provides more information about the error.
StatusCallbackEvent composition-*の全イベント The Composition event. For example, composition-started.
Timestamp composition-*の全イベント イベントの時間です。 UTC ISO 8601タイムスタンプに適合しています。
Rate this page:

ヘルプが必要ですか?

誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。