Informizely customer feedback surveys
By using the Aculab site, you agree with our use of cookies.

WebRTC Clients

This describes the web services that relate to Aculab Cloud WebRTC Clients.

WebRTC Clients can use the WebRTC Interface to register to receive calls from Aculab Cloud applications. Registration requires a time-limited token. The web services here provide the ability to generate one of these tokens and to list those clients that are currently registered for calls.

 This is a low level API. For information on higher level APIs see the Web Services Language Wrappers
  • WebRTC Generate Token

    This generates a token to allow WebRTC clients to register for calls.

    Url:https://ws.aculabcloud.net/webrtc_generate_token
    Methods:GET, POST

    ParameterValueDescription
    client idstringThe client id of the WebRTC client that will be registered. This is the same as the clientId used when creating the WebRTC client.
    ttlinteger (optional)The time, in seconds, that the token is valid for. This must be between 600 and 86400. The default is 3600.

    Returns:

    A JSON object containing the following properties:

    ParameterValueDescription
    tokenstringthe generated token.

    Example:

    https://ws.aculabcloud.net/webrtc_generate_token?client_id=myClientId&ttl=1200

    Response:

      {
        "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ik45dHZUcGhxX2ZKRjdrcEFZZ1c4aWRQVU1GZnE5MHFNTGRjWlpjSk81ckEiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOiIwLTAtMCIsImV4cCI6MTU4Mzg0MzYwNywiaWF0IjoxNTgzODQwMDA3LCJpc3MiOiJmZzhjZTl0c3pzeDNrazB4aXFsaHEyd3BzIiwibmJmIjoxNTgzODQwMDA3LCJzY29wZSI6WyJ3ZWJydGNjbGllbnQiXSwic3ViIjoibXlDbGllbnRJZCJ9.LdzXDXy0eeNYKCyAoGcYqMSS11aSeBiGQFCU-qlBGpDxM1KqMwG3mZBUZ68At27q4zEU-vwRuy1_3imcKfX2LXwkFRL5gO-fPxI2RBuOU9PWMHnwRgpQHGT8Fr8ETBiEqhP-KpBkXj3wUzTK3zeyq9_dWqXvsfB0VVObgs5QZUk"
      }
  • WebRTC Registered Clients

    This returns a list of clients that are currently registered for calls.

    Url:https://ws.aculabcloud.net/webrtc_registered_clients
    Methods:GET, POST

    Returns:

    A JSON object containing a list of dictionaries describing registered clients. The dictionaries contain the following fields:

    ParameterValueDescription
    client_idstringthe client id used to register the client.
    last_modifiedstringthe time, in the format YYYY-MM-DD_hh:mm:ss, when the registration was last modified.
    expiresstringthe time, in the format YYYY-MM-DD_hh:mm:ss, when the registration will expire.

    Example:

    https://ws.aculabcloud.net/webrtc_registered_users

    Response:

      [
        {
          "client_id": "myClientId",
          "last_modified": "2020-03-10_11:35:33",
          "expires": "2020-03-10_11:55:33"
        }
      ]