Class: 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)

Parameters:

• session_id (String) —

  The session ID corresponding to the session to which the SIP gateway will connect.

• token (String) —

  The token for the session ID with which the SIP user will use to connect.

• sip_uri (String) —

  The SIP URI the OpenTok SIP gateway will dial.

• opts (Hash) —

  A hash defining options for the SIP call. For example:

Options Hash (opts):

• :from (String) —

  The number or string that will be sent to the final SIP number as the caller. It must be a string in the form of “from@example.com”, where from can be a string or a number. If from is set to a number (for example, “14155550101@example.com”), it will show up as the incoming number on PSTN phones. If from is undefined or set to a string (for example, “joe@example.com”), +00000000 will show up as the incoming number on PSTN phones.

• :headers (Hash) —

  This hash defines custom headers to be added to the SIP ​INVITE​ request initiated from OpenTok to the your SIP platform.

• :auth (Hash) —

  This object contains the username and password to be used in the the SIP INVITE​ request for HTTP digest authentication, if it is required by your SIP platform.

• :secure (true, false) —

  Whether the media must be transmitted encrypted (​true​) or not (​false​, the default).

• :video (true, false) —

  Whether the SIP call will include video (​true​) or not (​false​, the default). With video included, the SIP client’s video is included in the OpenTok stream that is sent to the OpenTok session. The SIP client will receive a single composed video of the published streams in the OpenTok session.

• :observe_force_mute (true, false) —

  Whether the SIP end point observes force mute moderation (true) or not (false, the default).

• :streams (Array) —

  An array of stream IDs for streams to include in the SIP call. If you do not set this property, all streams in the session are included in the call.