Hérite de : : Object

Défini dans : : lib/opentok/sip.rb

Résumé des méthodes d'instance

Informations sur le constructeur

#initialiser(client) ⇒ Sip

Renvoie une nouvelle instance de Sip.

Détails de la méthode d'instance

#cadran(session_id, token, sip_uri, opts) ⇒ Objet

Appelle une passerelle SIP pour intégrer un flux audio uniquement à votre session OpenTok. Consultez la / Guide du développeur OpenTok SIP.

Exemples :

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)

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session correspondant à la session à laquelle la passerelle SIP va se connecter.

  • jeton (chaîne de caractères) —

    Le jeton correspondant à l'identifiant de session que l'utilisateur SIP utilisera pour se connecter.

  • sip_uri (Chaîne de caractères) —

    L'URI SIP que la passerelle SIP OpenTok va composer.

  • opts (Hash) —

    Un bloc définissant les options de l'appel SIP. Par exemple :

Table de hachage des options (opts) :

  • :de (chaîne de caractères)

    -

    Le numéro ou la chaîne de caractères qui sera transmis au numéro SIP final en tant qu'appelant. Il doit s'agir d'une chaîne de caractères sous la forme «from@example.com», où « from » peut être une chaîne de caractères ou un nombre. Si « from » est défini sur un nombre (par exemple, «14155550101@example.com»), il s'affichera comme numéro d'appelant sur les téléphones du réseau PSTN. Si le champ « De » n'est pas défini ou s'il contient une chaîne de caractères (par exemple, «joe@example.com”), +00000000 s'affichera comme numéro de l'appelant sur les téléphones du réseau PSTN.

  • :en-têtes (Hash)

    -

    Ce hachage définit les en-têtes personnalisés à ajouter à la requête SIP « INVITE » envoyée par OpenTok vers votre plateforme SIP.

  • :auth (Hash)

    -

    Cet objet contient le nom d'utilisateur et le mot de passe à utiliser dans la requête SIP INVITE pour l'authentification HTTP Digest, si votre plateforme SIP l'exige.

  • :secure (vrai, faux)

    -

    Indique si les données doivent être transmises sous forme cryptée (​vrai​) ou non (​faux​, valeur par défaut).

  • :vidéo (vrai, faux)

    -

    Indique si l'appel SIP inclura la vidéo (​true​) ou non (​false​, valeur par défaut). Lorsque la vidéo est incluse, la vidéo du client SIP est intégrée au flux OpenTok envoyé à la session OpenTok. Le client SIP recevra une seule vidéo composite regroupant les flux publiés dans la session OpenTok.

  • :observe_force_mute (vrai, faux)

    -

    Que le point d'extrémité SIP respecte ou non force mute moderation (vrai) ou non (faux, valeur par défaut).

  • :streams (Tableau)

    -

    Tableau contenant les identifiants des flux à inclure dans l'appel SIP. Si vous ne définissez pas cette propriété, tous les flux de la session sont inclus dans l'appel.

#play_dtmf_to_connection(session_id, connection_id, dtmf_digits) ⇒ Objet

Envoie des chiffres DTMF à un client spécifique connecté à une session OpnTok.

vers lequel le signal DTMF est envoyé. La lettre « p » indique une pause de 500 ms (si vous devez ajouter un délai avant l'envoi des chiffres).

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session.

  • connection_id (Chaîne de caractères) —

    L'identifiant de la connexion spécifique qui

  • dtmf_digits (Chaîne de caractères) —

    Les chiffres DTMF à envoyer. Il peut s'agir des chiffres de 0 à 9, ainsi que des caractères « * », « # » et « p ».

Augmentations :

  • (ArgumentError)

#play_dtmf_to_session(session_id, dtmf_digits) ⇒ Objet

Envoie des chiffres DTMF à tous les clients connectés à une session OpnTok.

Un « p » indique une pause de 500 ms (si vous devez ajouter un délai dans l'envoi des chiffres).

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session.

  • dtmf_digits (Chaîne de caractères) —

    Les chiffres DTMF à envoyer. Il peut s'agir des chiffres de 0 à 9, ainsi que des caractères « * », « # » et « p ».

Augmentations :

  • (ArgumentError)