Heredan de: : Object

Definido en: : lib/opentok/sip.rb

Resumen de los métodos de instancia

Datos del constructor

#inicializar(cliente) ⇒ Sip

Devuelve una nueva instancia de Sip.

Detalles del método de instancia

#marcador(session_id, token, sip_uri, opts) ⇒ Objeto

Se conecta a una pasarela SIP para introducir un flujo de solo audio en tu sesión de OpenTok. Consulta la / Guía para desarrolladores de OpenTok SIP.

Ejemplos:

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)

Parámetros:

  • session_id (Cadena) —

    El identificador de sesión correspondiente a la sesión a la que se conectará la pasarela SIP.

  • token (Cadena) —

    El token correspondiente al identificador de sesión que utilizará el usuario SIP para conectarse.

  • sip_uri (Cadena) —

    El URI SIP al que llamará la pasarela SIP de OpenTok.

  • opts (Hash) —

    Un hash que define las opciones de la llamada SIP. Por ejemplo:

Hash de opciones (opts):

  • :de (Cadena)

    -

    El número o la cadena que se enviará al número SIP final como identificador de la persona que llama. Debe ser una cadena con el formato «from@example.com», donde «from» puede ser una cadena o un número. Si «from» se establece en un número (por ejemplo, «14155550101@example.com»), aparecerá como número de origen en los teléfonos PSTN. Si el campo «De» no está definido o se ha establecido como una cadena (por ejemplo, «joe@example.com»), +00000000 aparecerá como número de origen en los teléfonos de la red pública (PSTN).

  • :encabezados (Hash)

    -

    Este hash define los encabezados personalizados que se añadirán a la solicitud SIP «INVITE» enviada desde OpenTok a tu plataforma SIP.

  • :auth (Hash)

    -

    Este objeto contiene el nombre de usuario y la contraseña que se utilizarán en la solicitud SIP INVITE para la autenticación HTTP Digest, en caso de que tu plataforma SIP lo requiera.

  • :secure (verdadero, falso)

    -

    Si los datos deben transmitirse cifrados (​verdadero​) o no (​falso​, valor por defecto).

  • :vídeo (verdadero, falso)

    -

    Si la llamada SIP incluirá vídeo (​true​) o no (​false​, valor por defecto). Cuando se incluye vídeo, el vídeo del cliente SIP se incorpora a la transmisión de OpenTok que se envía a la sesión de OpenTok. El cliente SIP recibirá un único vídeo compuesto a partir de las transmisiones publicadas en la sesión de OpenTok.

  • :observe_force_mute (verdadero, falso)

    -

    Depende de si el punto final SIP cumple modulación de silenciamiento forzado (verdadero) o no (falso, el valor por defecto).

  • :streams (Matriz)

    -

    Una matriz de identificadores de flujos que se incluirán en la llamada SIP. Si no se configura esta propiedad, se incluirán en la llamada todos los flujos de la sesión.

#reproducir_dtmf_en_la_conexión(session_id, connection_id, dtmf_digits) ⇒ Objeto

Envía dígitos DTMF a un cliente específico conectado a una sesión de OpnTok.

a la que se envía la señal DTMF. Una «p» indica una pausa de 500 ms (si necesitas añadir un retraso al enviar los dígitos).

Parámetros:

  • session_id (Cadena) —

    El identificador de sesión.

  • connection_id (Cadena) —

    El ID de la conexión específica que

  • dtmf_digits (Cadena) —

    Los dígitos DTMF que se deben enviar. Pueden ser los números del 0 al 9, «*», «#» y «p».

Aumentos:

  • (ArgumentError)

#reproducir_dtmf_en_la_sesión(session_id, dtmf_digits) ⇒ Objeto

Envía dígitos DTMF a todos los clientes conectados a una sesión de OpnTok.

La letra «p» indica una pausa de 500 ms (si necesitas añadir un retraso al enviar los dígitos).

Parámetros:

  • session_id (Cadena) —

    El identificador de sesión.

  • dtmf_digits (Cadena) —

    Los dígitos DTMF que se deben enviar. Pueden ser los números del 0 al 9, «*», «#» y «p».

Aumentos:

  • (ArgumentError)