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

conference() method

   

これを使えば2つ以上の通話を1つに結ぶことができるので、参加者全員が同時に通信できます。 conferenceを利用する前に、まず最初にsayを使って発信者をconferenceに紹介しましょう。 このページの1番下にあるコード例をご覧ください。

Tropoは同期方式なので、conferenceはブロッキングメソッドです。つまり、conferenceが完了するまで、他のメソッドが実行されないということです。

conferenceIDは同一アカウントの全てのアプリケーション間で共有されます。 勿論、これらのIDは他のアカウントとは共有されません。 ですから、もしあなたのconferenceIDが1234の場合、別のTropoユーザーも1234を使用していても、競合することはありません。

詳細については、こちらをご覧ください。

パラメータ

conferenceId
データの種類:String型 デフォルト:なし 必須
これはconferenceを識別し、同じconferenceセッションに接続するための通話で使用される、固有のID番号です。
 

名前付きパラメータ

 
allowSignals
データの種類:String型またはArray型 デフォルト:*(任意の信号) 任意
このパラメータを使用すると、この関数にシグナルを割り当てることができます。一致するシグナル名を持つTropo REST APIからのイベントは、この関数を中断します。 すでにこの関数が実行され完了していた場合、中断の要求は無視されます。 この関数がまだ実行されていない場合、中断の要求は実行されるまでジョブキューに並びます。 デフォルトでは、allowSignalsはどんなシグナルも有効なものとして認識します。 allowSignalsを定めなかった場合、その関数は「中断なし」として定義されます。 配列を使うこともできます。配列にある名前のいずれかに一致するシグナルを受信した際に、この関数を中断します。
interdigitTimeout
データの種類:Integer型 デフォルト:なし 任意
conferencerecordそしてtransferの場合には、 interdigitTimeout がTropoが新たなキー入力を認識するまでに、 ユーザが必要とする待機時間を秒単位で定めます。 基本的には、 ユーザが間違ったキーを押してセッションを終了してしまった場合(#を押そうとして *を押した場合など)に、 キーを押し直すまでにTropoにどれくらいの待機させるかを定めます。
joinPrompt
データの種類:Boolean型またはHash型 デフォルト:false 任意
誰かが会議に参加したとき、全ての参加者が受け取る音声などを定義します。 trueと設定すると、デフォルトのビープ音が再生されますが、追加の属性として valuevoiceを使った音声合成(TTS)やオーディオURLのどちらにでも定義できます。   *valueは簡単な音声合成(TTS)および/またはオーディオURLを再生するために使われ、 SSMLに対応しています。*voiceはTTSで利用可能な声を定めます。音声が定義されていない場合には、 デフォルトの音声が使用されます。
leavePrompt
データの種類:Boolean型またはHash型 デフォルト:false 任意
誰かが会議から抜けるとき、全ての参加者が受け取る音声などを定義します。 trueと設定すると、デフォルトのビープ音が再生されますが、追加の属性として valuevoiceを使った音声合成(TTS)やオーディオURLのどちらにでも定義できます。   *valueは簡単な音声合成(TTS)および/またはオーディオURLを再生するために使われ、 SSMLに対応しています。*voiceはTTSで利用可能な声を定めます。音声が定義されていない場合には、 デフォルトの音声が使用されます。
mute
データの種類:Boolean型 デフォルト:false 任意
trueに設定すると、ユーザーはミュート状態で入室します。 Pythonを使用している場合は、trueとfalseではなく、必ずTrueとFalseを使うようにしてください。
onChoice
データの種類:Function型 デフォルト:なし 任意
電話を切ったのではなく、切断のためにterminatorが使用された場合に実行するイベントハンドラを登録します。
onError
データの種類:Function型 デフォルト:なし 任意
conference参加中にシステムエラーが発生した場合に実行されます。
onHangup
データの種類:Function型 デフォルト:なし 任意
ユーザーが通信を切断するか電話を切ったときに実行するイベントハンドラを登録します。
onSignal
データの種類:Function型 デフォルト:なし 任意
シグナルで関数を中断した場合に実行するコールバック関数を指定します。
playTones
データの種類:Boolean型 デフォルト:false 任意
電話のキーが押されたときに鳴る音(DTMF音)がconferenceの参加者が会議のメンバーに聞こえるかどうかを設定します。 Pythonを使用している場合は、trueとfalseではなく、必ずTrueとFalseを使うようにしてください。
terminator
データの種類:String型 デフォルト:なし 任意
これは会議の終了に使われるタッチトーンキー(DTMF)を設定します。
 
  conference("1337", {
    terminator: "*",
    playTones: true,
    onChoice: function(event) {
        say("切断しました。");
        }
    });
say("またのご利用をお待ちしております。"); 
say "Welcome to the geek single hotline!"
conference "1337", {
  :terminator => "*",
  :playTones => true,
  :onChoice => lambda { |event| 
        say("切断しました。")
   }}
say "またのご利用をお待ちしております。"
<?php
 
say("Welcome to the geek singles hotline!");
conference("1337", array(
   "terminator"=>"*",
   "playTones" => true,
    "onChoice" => "choiceFCN"
    )
);
function choiceFCN($event) {
    say("切断しました。");
    }
say("またのご利用をお待ちしております。");
 
?>
say("Welcome to the geek singles hotline!")
conference("1337", {
    "terminator":"*",
    "playTones":True,
    "onChoice": lambda event : say("切断しました。")
})
say("またのご利用をお待ちしております。")
say("Welcome to the geek singles hotline!")
conference("1337", [
    terminator: "*",
    playTones : true,
    onChoice: { event->
        say "切断しました。"}
])
say("またのご利用をお待ちしております。")
   
call getHeader