Scripting API リファレンス|TropoスクリプティングAPI

record() method

   

recordメソッドを使用すると留守番電話のように録音することができます。 音声ファイルは、レコーディングの最後にFTPまたはHTTP POST/Multipart Form経由で外部サーバーに自動的に送信されます。

 

Tropoは同期方式であり、録音はブロッキングメソッドです。 つまり、録音が完了するまで他のメソッドは使用できません。

更に詳しく知りたい場合は、以下のの記事をご覧ください: 通話録音 通話者入力の録音  

パラメータ

text
データの種類:String型 デフォルト:なし 任意
テキストをTTS(合成音声)で読み上げることや、音声ファイルを指定して再生することができます。 
 

名前付きパラメータ

 
allowSignals
データの種類:String型またはArray型 デフォルト:*(任意の信号) 任意
このパラメータを使用すると、この関数にシグナルを割り当てることができます。一致するシグナル名を持つTropo REST APIからのイベントは、この関数を中断します。 すでにこの関数が実行され完了していた場合、中断の要求は無視されます。 この関数がまだ実行されていない場合、中断の要求は実行されるまでジョブキューに並びます。 デフォルトでは、allowSignalsはどんなシグナルも有効なものとして認識します。 allowSignalsを定めなかった場合、その関数は「中断なし」として定義されます。 配列を使うこともできます。配列にある名前のいずれかに一致するシグナルを受信した際に、この関数を中断します。
attempts
データの種類:Integer型 デフォルト:1 任意
録音を終了する際に、ユーザーに聞かせる自動応答音声への応答が無かった場合、それを何回繰り返すか設定します。
bargein
データの種類:Boolean型 デフォルト:true 任意
自動応答の音声を最後まで聞かせるかどうかを定義します。 trueであればガイダンスの途中でもDTMF入力を受け付け、falseであれば、ガイダンスを最後まで聞かせます。 Pythonを使用する場合には、trueとfalseではなく、必ずTrueとFalseを使用してください。
beep
データの種類:Boolean型 デフォルト:false 任意
trueに設定されている場合、発信者に録音の開始を知らせる音声を聞かせます。 Pythonを使用している場合は、trueとfalseではなく、必ずTrueとFalseを使うようにしてください。
interdigitTimeout
データの種類:Integer型 デフォルト:なし 任意
conferencerecordそしてtransferの場合には、interdigitTimeoutがTropoが新たなキー入力を認識するまでに、 ユーザが必要とする待機時間を秒単位で定めます。 基本的には、ユーザが間違ったキーを押してセッションを終了してしまった場合(#を押そうとして *を押した場合など)に、 キーを押し直すまでにTropoにどれくらい待機させるかを設定します。
maxTime
データの種類:Integer型 デフォルト:30 任意
録音時間の上限(秒単位)を変更します。デフォルトは30秒です。
onError
データの種類:Function型 デフォルト:なし 任意
入力中にシステムエラー(非ユーザーエラー)が起こった場合に実行する、 イベントハンドラを登録します。 ユーザーエラーへの対処についてはonBadChoiceonTimeoutご覧ください。
onEvent
データの種類:Function型 デフォルト:なし 任意
全てのイベントをキャッチして実行するイベントハンドラを登録します。 これは基本的にonEventが他の全てのイベントハンドラの後で実行されることを意味します。 従って、たとえばタイムアウトが発生した場合、onTimeoutがまず実行され、その後にonEventが実行されます。 それから元の状態に戻ります。 他のイベントハンドラが定義されていない場合、onEventが引き続き実行されます。
onHangup
データの種類:Function型 デフォルト:なし 任意
ユーザーが通信を遮断するか電話を切ったときに実行するイベントハンドラを登録します。
onRecord
データの種類:Function型 デフォルト:なし 任意
録音の吹き込みが完了した際に動作するイベントハンドラを設定します。
onSignal
データの種類:Function型 デフォルト:なし 任意
シグナルで関数が中断された場合に実行するコールバック関数を指定します。
onTimeout
データの種類:Function型 デフォルト:なし 任意
ユーザーが特定の時間内に話し始めなかった場合、このイベントハンドラが起動し、録音指示メッセージとビープ音が再生されます。
recordURI
データの種類:String型 デフォルト:なし 任意
録音したオーディオファイルを送信するためのFTPまたはHTTPのURLのことです。 POST経由で送信する場合、フォームフィールドの名前は「filename」です。
recordFormat
データの種類:String型 デフォルト:audio/wav 任意
録音に使用される音声フォーマットのことで、値には「audio/wav」、「audio/mp3」、「audio/au」があります。
recordMethod
データの種類:String型 デフォルト:POST 任意
HTTP経由で録音を送信する場合、このパラメータが使用されるメソッドを決定します。 「POST」(デフォルトではこちら)あるいは「PUT」に設定できます。 POST経由で送信する場合、フォームフィールドの名前は「filename」です。
recordPassword
データの種類:String型 デフォルト:なし 任意
HTTP Basic認証と FTP のログイン用のパスワードを設定します。  URL内のユーザーおよびパスワードのフィールドに「:」、「@」および「/」が含まれている場合、 その文字はエンコードしなければならないことに注意してください。
recordUser
データの種類:String型 デフォルト:なし 任意
HTTP Basic認証と FTP のログイン用のユーザー名を設定します。  URL内のユーザーおよびパスワードのフィールドに「:」、「@」および「/」が含まれている場合、 その文字はエンコードしなければならないことに注意してください。
silenceTimeout
データの種類:Float型 デフォルト:5.0 任意
ユーザーが沈黙している間の時間上限で、秒単位で表わされます。 会話を一時停止しているわけではないことを保証するためのものです。
terminator
データの種類:String型 デフォルト:なし 任意
録音を停止させる為のタッチトーンキー(DTMF)です。
timeout
データの種類:Float型 デフォルト:30.0 任意
自動応答を再生した後に、ユーザーによる応答の開始を待つ時間のことで、秒単位で表します。
   var callerID = currentCall.callerID;
 
say("Welcome to speed therapy!");
record("15以内でお話しください。", {
    beep:true,
    maxTime:900,
    recordURI:"http://example.com/recording.js"
    }
);  
callerID = $currentCall.callerID
 
say "Welcome to speed therapy!"
record "15以内でお話しください。", {
    :beep => true,
    :maxTime => 900,
    :recordURI => "http://example.com/recording.rb"
    }
<?php
$callerID = $currentCall->callerID;
 
say("Welcome to speed therapy!");
record("15以内でお話しください。", array (
    "beep" => true,
    "maxTime" => 900,
    "recordURI"=>"http://example.com/recording"
    )
);
?>
callerID = currentCall.callerID
 
say("Welcome to speed therapy!")
record("15以内でお話しください。", {
    "beep":True,
    "maxTime":900,
    "recordURI":"http://example.com/recording.py"
    }
)
callerID = currentCall.callerID
 
say("Welcome to speed therapy!")
record("15以内でお話しください。", [
    beep:true,
    maxTime:900,
    recordURI:"http://example.com/recording.groovy"
)
   
log redirect