継承元： : Object

定義場所： : lib/opentok/sip.rb

インスタンスメソッドの概要

コンストラクタの詳細

#初期化(クライアント) ⇒ Sip

Sip の新しいインスタンスを返します。

インスタンスメソッドの詳細

#ダイヤル(session_id, token, sip_uri, opts) ⇒ オブジェクト

SIPゲートウェイに接続して、OpenTokセッションに音声のみのストリームを入力します。詳しくは、 / OpenTok SIP 開発者ガイド.

例を挙げよう：

opts = { "from" => "14155550101@example.com",
  "auth" => { "username" => sip_username,
    "password" => sip_password },
  "headers" => { "X-KEY1" => "value1",
    "X-KEY1" => "value2" },
  "secure" => "true",
  "video" => "true",
  "observe_force_mute" => "true"
}
response = opentok.sip.dial(session_id, token, "sip:+15128675309@acme.pstn.example.com;transport=tls", opts)

パラメータ：

  • session_id (文字列) —

    SIPゲートウェイが接続するセッションに対応するセッションID。

  • token (String) —

    SIPユーザーが接続に使用するセッションIDのトークン。

  • sip_uri (文字列) —

    OpenTok SIPゲートウェイが発信するSIP URI。

  • opts (ハッシュ) —

    SIP コールのオプションを定義するハッシュ。例：

オプションハッシュ (opts):

  • :from (文字列)

    -

    最終的なSIP番号に対して発信者として送信される番号または文字列。これは「from@example.com», ここで from は文字列または数値です。from が数値に設定されている場合（例えば、「14155550101@example.com」）と指定すると、PSTN電話機にはその番号が発信元として表示されます。「from」が未定義の場合、または文字列（例：「joe@example.com”）、PSTN電話では発信元番号として「+00000000」と表示されます。

  • :headers (ハッシュ)

    -

    このハッシュは、OpenTokからお客様のSIPプラットフォームに向けて送信されるSIP INVITEリクエストに追加されるカスタムヘッダーを定義するものです。

  • :auth (ハッシュ)

    -

    このオブジェクトには、お使いのSIPプラットフォームでHTTPダイジェスト認証が要求される場合、SIP INVITEリクエストで使用するユーザー名とパスワードが含まれています。

  • :secure (true, false)

    -

    メディアを暗号化して送信する必要があるか（​true​）か、そうでないか（​false​、デフォルト）。

  • :video (true, false)

    -

    SIP通話にビデオが含まれるか（​true​）含まれないか（​false​、デフォルト）。ビデオが含まれる場合、SIPクライアントのビデオは、OpenTokセッションに送信されるOpenTokストリームに含まれます。SIPクライアントは、OpenTokセッション内で公開されたストリームを合成した単一のビデオを受信します。

  • :observe_force_mute (true, false)

    -

    SIPエンドポイントが以下を遵守するかどうか 強制ミュート (true) またはそうでない場合 (false、デフォルト)。

  • :streams (配列)

    -

    SIPコールに含めるストリームのIDの配列。このプロパティを設定しない場合、セッション内のすべてのストリームがコールに含まれます。

#play_dtmf_to_connection(session_id, connection_id, dtmf_digits) ⇒ オブジェクト

OpnTokセッションに接続されている特定のクライアントにDTMF信号を送信します。

DTMF信号の送信先です。「p」は500msの休止を表します（数字の送信に遅延を加える必要がある場合）。

パラメータ：

  • session_id (文字列) —

    セッションID。

  • connection_id (文字列) —

    特定の接続の接続IDは、

  • dtmf_digits (文字列) —

    送信するDTMF数字。0～9、および「*」、「#」、「p」を含めることができます。

引き上げ：

  • (ArgumentError)

#play_dtmf_to_session(session_id, dtmf_digits) ⇒ オブジェクト

OpnTokセッションに接続されているすべてのクライアントにDTMF信号を送信します。

「p」は500ミリ秒の休止を表します（数字の送信に遅延を加えたい場合）。

パラメータ：

  • session_id (文字列) —

    セッションID。

  • dtmf_digits (文字列) —

    送信するDTMF数字。0～9、および「*」、「#」、「p」を含めることができます。

引き上げ：

  • (ArgumentError)