Erbt von: : Object

Definiert in: : lib/opentok/sip.rb

Zusammenfassung der Instanzmethoden

Angaben zum Hersteller

#initialisieren(Client) ⇒ Sip

Gibt eine neue Instanz von Sip zurück.

Details zur Instanzmethode

#Wählscheibe(session_id, token, sip_uri, opts) ⇒ Objekt

Stellt eine Verbindung zu einem SIP-Gateway her, um einen reinen Audio-Stream in Ihre OpenTok-Sitzung einzuspeisen. Siehe die / OpenTok SIP-Entwicklerhandbuch.

Beispiele:

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)

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der Sitzung, mit der sich das SIP-Gateway verbinden wird.

  • Token (Zeichenkette) —

    Das Token für die Sitzungs-ID, mit der sich der SIP-Benutzer verbinden wird.

  • sip_uri (Zeichenkette) —

    Die SIP-URI, die das OpenTok-SIP-Gateway anwählen wird.

  • opts (Hash) —

    Ein Hash, der Optionen für den SIP-Anruf definiert. Zum Beispiel:

Options-Hash (opts):

  • :von (Zeichenkette)

    -

    Die Nummer oder Zeichenfolge, die als Anrufer an die endgültige SIP-Nummer gesendet wird. Es muss sich um eine Zeichenfolge im Format „from@example.com“, wobei „from“ eine Zeichenfolge oder eine Zahl sein kann. Wenn „from“ auf eine Zahl gesetzt ist (zum Beispiel „14155550101@example.com“), wird diese Nummer auf PSTN-Telefonen als anrufende Nummer angezeigt. Ist das Feld „Von“ nicht definiert oder auf eine Zeichenfolge gesetzt (zum Beispiel „joe@example.com“), wird auf PSTN-Telefonen die Nummer +00000000 als anrufende Nummer angezeigt.

  • :headers (Hash)

    -

    Dieser Hash definiert benutzerdefinierte Header, die der von OpenTok an Ihre SIP-Plattform gesendeten SIP-INVITE-Anfrage hinzugefügt werden sollen.

  • :auth (Hash)

    -

    Dieses Objekt enthält den Benutzernamen und das Passwort, die in der SIP-INVITE-Anfrage für die HTTP-Digest-Authentifizierung verwendet werden sollen, sofern dies von Ihrer SIP-Plattform verlangt wird.

  • :secure (true, false)

    -

    Ob die Medien verschlüsselt übertragen werden müssen (​wahr​) oder nicht (​falsch​, Standardeinstellung).

  • :video (true, false)

    -

    Gibt an, ob der SIP-Anruf Video enthält (​true​) oder nicht (​false​, Standardeinstellung). Wenn Video enthalten ist, wird das Video des SIP-Clients in den OpenTok-Stream aufgenommen, der an die OpenTok-Sitzung gesendet wird. Der SIP-Client erhält ein einziges zusammengesetztes Video aus den in der OpenTok-Sitzung veröffentlichten Streams.

  • :observe_force_mute (true, false)

    -

    Ob der SIP-Endpunkt Stummschaltung der Moderation erzwingen (wahr) oder nicht (falsch, Standardwert).

  • :streams (Array)

    -

    Ein Array mit Stream-IDs für Streams, die in den SIP-Anruf einbezogen werden sollen. Wenn Sie diese Eigenschaft nicht festlegen, werden alle Streams der Sitzung in den Anruf einbezogen.

#play_dtmf_to_connection(session_id, connection_id, dtmf_digits) ⇒ Objekt

Sendet DTMF-Ziffern an einen bestimmten Client, der mit einer OpnTok-Sitzung verbunden ist.

an das das DTMF-Signal gesendet wird. Ein „p“ steht für eine Pause von 500 ms (falls Sie beim Senden der Ziffern eine Verzögerung einfügen müssen).

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID.

  • connection_id (Zeichenkette) —

    Die Verbindungs-ID der jeweiligen Verbindung, die

  • dtmf_digits (Zeichenkette) —

    Die zu sendenden DTMF-Ziffern. Dazu gehören die Ziffern 0–9 sowie „*“, „#“ und „p“.

Erhöht:

  • (ArgumentError)

#play_dtmf_to_session(session_id, dtmf_digits) ⇒ Objekt

Sendet DTMF-Ziffern an alle Clients, die mit einer OpnTok-Sitzung verbunden sind.

Ein „p“ steht für eine Pause von 500 ms (falls Sie beim Senden der Ziffern eine Verzögerung einfügen müssen).

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID.

  • dtmf_digits (Zeichenkette) —

    Die zu sendenden DTMF-Ziffern. Dazu gehören die Ziffern 0–9 sowie „*“, „#“ und „p“.

Erhöht:

  • (ArgumentError)