Herdado de: : Object

Definido em: : lib/opentok/sip.rb

Resumo dos métodos de instância

Detalhes do construtor

#inicializar(cliente) ⇒ Sip

Retorna uma nova instância de Sip.

Detalhes do método de instância

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

Liga a um gateway SIP para inserir um fluxo apenas de áudio na sua sessão do OpenTok. Consulte o / Guia do desenvolvedor do OpenTok SIP.

Exemplos:

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 (String) —

    O ID da sessão correspondente à sessão à qual o gateway SIP se conectará.

  • token (String) —

    O token correspondente ao ID da sessão que o usuário SIP utilizará para se conectar.

  • sip_uri (String) —

    O URI SIP que o gateway SIP da OpenTok irá discar.

  • opts (Hash) —

    Um hash que define as opções para a chamada SIP. Por exemplo:

Hash de opções (opts):

  • :de (String)

    —

    O número ou sequência de caracteres que será enviado ao número SIP final como identificador do chamador. Deve ser uma sequência de caracteres no formato “from@example.com”, em que “from” pode ser uma sequência de caracteres ou um número. Se “from” for definido como um número (por exemplo, “14155550101@example.com”), ele aparecerá como o número de origem nos telefones PSTN. Se o campo “de” estiver indefinido ou configurado como uma sequência de caracteres (por exemplo, “joe@example.com”), +00000000 aparecerá como o número de origem nos telefones PSTN.

  • :headers (Hash)

    —

    Este hash define cabeçalhos personalizados a serem adicionados à solicitação SIP ​INVITE​ iniciada pelo OpenTok para a sua plataforma SIP.

  • :auth (Hash)

    —

    Este objeto contém o nome de usuário e a senha a serem utilizados na solicitação SIP INVITE para autenticação HTTP digest, caso isso seja exigido pela sua plataforma SIP.

  • :secure (true, false)

    —

    Se os dados de mídia devem ser transmitidos criptografados (​verdadeiro​) ou não (​falso​, valor padrão).

  • :vídeo (verdadeiro, falso)

    —

    Se a chamada SIP incluirá vídeo (​true​) ou não (​false​, o padrão). Quando o vídeo está incluído, o vídeo do cliente SIP é incorporado ao fluxo do OpenTok enviado para a sessão do OpenTok. O cliente SIP receberá um único vídeo composto a partir dos fluxos publicados na sessão do OpenTok.

  • :observe_force_mute (true, false)

    —

    Se o terminal SIP observa moderação com silenciamento forçado (verdadeiro) ou não (falso, o padrão).

  • :streams (Matriz)

    —

    Uma matriz de IDs de fluxos a serem incluídos na chamada SIP. Se essa propriedade não for definida, todos os fluxos da sessão serão incluídos na chamada.

#play_dtmf_to_connection(session_id, connection_id, dtmf_digits) ⇒ Objeto

Envia dígitos DTMF para um cliente específico conectado a uma sessão do OpnTok.

para onde o sinal DTMF está sendo enviado. Um “p” indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos).

Parâmetros:

  • session_id (String) —

    O ID da sessão.

  • connection_id (String) —

    O ID da conexão específica que

  • dtmf_digits (String) —

    Os dígitos DTMF a serem enviados. Isso pode incluir os números de 0 a 9, “*”, “#” e “p”.

Aumentos:

  • (ArgumentError)

#play_dtmf_to_session(session_id, dtmf_digits) ⇒ Objeto

Envia dígitos DTMF para todos os clientes conectados a uma sessão do OpnTok.

Um “p” indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos).

Parâmetros:

  • session_id (String) —

    O ID da sessão.

  • dtmf_digits (String) —

    Os dígitos DTMF a serem enviados. Isso pode incluir os números de 0 a 9, “*”, “#” e “p”.

Aumentos:

  • (ArgumentError)