|
|
|
@ -1,7 +1,7 @@
@@ -1,7 +1,7 @@
|
|
|
|
|
|
|
|
|
|
Spreed WebRTC Channeling API v1.3.0 |
|
|
|
|
Spreed WebRTC Channeling API v1.4.0 |
|
|
|
|
================================================= |
|
|
|
|
(c)2014 struktur AG |
|
|
|
|
(c)2015 struktur AG |
|
|
|
|
|
|
|
|
|
The server provides a Websocket connection end point as channeling API to |
|
|
|
|
share peer information for peer to peer connectivity. |
|
|
|
@ -117,6 +117,7 @@ Special purpose documents for channling
@@ -117,6 +117,7 @@ Special purpose documents for channling
|
|
|
|
|
"Suserid": "", |
|
|
|
|
"Token": "some-very-long-string", |
|
|
|
|
"Version": "server-version-number", |
|
|
|
|
"ApiVersion": 1.4, |
|
|
|
|
"Turn": { |
|
|
|
|
"username": "turn-username", |
|
|
|
|
"password": "turn-password", |
|
|
|
@ -136,21 +137,26 @@ Special purpose documents for channling
@@ -136,21 +137,26 @@ Special purpose documents for channling
|
|
|
|
|
|
|
|
|
|
Keys: |
|
|
|
|
|
|
|
|
|
Type : Self (string) |
|
|
|
|
Id : Public Session id for this connection (string). |
|
|
|
|
Sid : Secure (non public) id for this session (string). |
|
|
|
|
Userid : User id if this session belongs to an authenticated user. Else empty. |
|
|
|
|
Suserid : Secure (non public) user id if session has an user id. Else empty. |
|
|
|
|
Token : Security token (string), to restablish connection with the same |
|
|
|
|
session. Pass the value as URL query parameter t, to the websocket URL. |
|
|
|
|
Version : Server version number. Use this to detect server upgrades. |
|
|
|
|
Turn : Mapping (interface{}) to contain TURN server details, like |
|
|
|
|
urls, password and username. See |
|
|
|
|
http://tools.ietf.org/html/draft-uberti-behave-turn-rest-00 |
|
|
|
|
and TURN REST API section in |
|
|
|
|
https://code.google.com/p/rfc5766-turn-server/wiki/turnserver |
|
|
|
|
for details. |
|
|
|
|
Stun : Array with STUN server URLs. |
|
|
|
|
Type : Self (string) |
|
|
|
|
Id : Public Session id for this connection (string). |
|
|
|
|
Sid : Secure (non public) id for this session (string). |
|
|
|
|
Userid : User id if this session belongs to an authenticated user. |
|
|
|
|
Else empty. |
|
|
|
|
Suserid : Secure (non public) user id if session has an user id. |
|
|
|
|
Else empty. |
|
|
|
|
Token : Security token (string), to restablish connection with the |
|
|
|
|
same session. Pass the value as URL query parameter t, to |
|
|
|
|
the websocket URL. |
|
|
|
|
Version : Server version number. Use this to detect server upgrades. |
|
|
|
|
ApiVersion : Server channeling API base version. Use this version to select |
|
|
|
|
client side compatibility with the connected server. |
|
|
|
|
Turn : Mapping (interface{}) to contain TURN server details, like |
|
|
|
|
urls, password and username. See |
|
|
|
|
http://tools.ietf.org/html/draft-uberti-behave-turn-rest-00 |
|
|
|
|
and TURN REST API section in |
|
|
|
|
https://code.google.com/p/rfc5766-turn-server/wiki/turnserver |
|
|
|
|
for details. |
|
|
|
|
Stun : Array with STUN server URLs. |
|
|
|
|
|
|
|
|
|
You can also send an empty Self document to the server to make the server |
|
|
|
|
transmit a fresh Self document (eg. to refresh when ttl was reached). Please |
|
|
|
@ -162,9 +168,10 @@ Special purpose documents for channling
@@ -162,9 +168,10 @@ Special purpose documents for channling
|
|
|
|
|
{ |
|
|
|
|
Type: "Hello", |
|
|
|
|
Hello: { |
|
|
|
|
Version: "1.0.0", |
|
|
|
|
Ua: "Test client 1.0", |
|
|
|
|
Id: "", |
|
|
|
|
"Version": "1.0.0", |
|
|
|
|
"Ua": "Test client 1.0", |
|
|
|
|
"Name": "", |
|
|
|
|
"Type": "", |
|
|
|
|
"Credentials": {...} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
@ -179,7 +186,10 @@ Special purpose documents for channling
@@ -179,7 +186,10 @@ Special purpose documents for channling
|
|
|
|
|
|
|
|
|
|
Version : Channel protocol version (string). |
|
|
|
|
Ua : User agent description (string). |
|
|
|
|
Id : Room id. The default Room has the empty string Id ("") (string). |
|
|
|
|
Name : Room name. The default Room has the empty string name ("") (string). |
|
|
|
|
Type : Room type. Use empty string to let the server select the |
|
|
|
|
default type. |
|
|
|
|
Id : Same as 'Name' (kept for compatibility). |
|
|
|
|
Credentials : An optional RoomCredentials document containing room |
|
|
|
|
authentication information. See the Room document for |
|
|
|
|
information on how such credentials should be handled after |
|
|
|
@ -218,10 +228,10 @@ Special purpose documents for channling
@@ -218,10 +228,10 @@ Special purpose documents for channling
|
|
|
|
|
|
|
|
|
|
Keys under Welcome: |
|
|
|
|
|
|
|
|
|
Room: Contains the current state of the room, see the description of |
|
|
|
|
the Room document for more details. |
|
|
|
|
Users: Contains the user list for the room, see the description of |
|
|
|
|
the Users document for more details. |
|
|
|
|
Room : Contains the current state of the room, see the description of |
|
|
|
|
the Room document for more details. |
|
|
|
|
Users : Contains the user list for the room, see the description of |
|
|
|
|
the Users document for more details. |
|
|
|
|
|
|
|
|
|
RoomCredentials |
|
|
|
|
|
|
|
|
@ -241,7 +251,7 @@ Special purpose documents for channling
@@ -241,7 +251,7 @@ Special purpose documents for channling
|
|
|
|
|
Room |
|
|
|
|
|
|
|
|
|
{ |
|
|
|
|
"Type": "Room", |
|
|
|
|
"Type": "room-type", |
|
|
|
|
"Name": "room-name-here" |
|
|
|
|
"Credentials": {...} |
|
|
|
|
} |
|
|
|
@ -256,8 +266,10 @@ Special purpose documents for channling
@@ -256,8 +266,10 @@ Special purpose documents for channling
|
|
|
|
|
|
|
|
|
|
Keys under Room: |
|
|
|
|
|
|
|
|
|
Name : The human readable ID of the room, currently must be globally |
|
|
|
|
unique. |
|
|
|
|
Type : The room type. This field should only be send to alter |
|
|
|
|
the room type. It will always contain the type of the room |
|
|
|
|
when returned by the server. |
|
|
|
|
Name : The human readable name of the room. |
|
|
|
|
Credentials : Optional authentication information for the room, see the |
|
|
|
|
documentation of the RoomCredentials document for more |
|
|
|
|
details. This field shall only be present when sending or |
|
|
|
@ -423,8 +435,8 @@ Additional types for session listing and notifications
@@ -423,8 +435,8 @@ Additional types for session listing and notifications
|
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
'buddyPicture' can be in next formats: |
|
|
|
|
1. Base64 encoded string of an image. |
|
|
|
|
'buddyPicture' can be in next formats: |
|
|
|
|
1. Base64 encoded string of an image. |
|
|
|
|
Example: data:image/jpeg;base64,/9j/4... |
|
|
|
|
2. url subpath to query REST API. Please refer to REST API for more information |
|
|
|
|
Example: img:8nG33oDk8Yv8fvK6IphL/6vjI2NLigcET/picture.jpg |
|
|
|
|