GitHub/tinode-chat
1
0
Fork 0
mirror of https://github.com/tinode/chat.git synced 2026-05-07 20:12:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add 'webrtc' header info in API doc.

Browse Source
This commit is contained in:
aforge
2022-06-09 20:22:24 +03:00
parent 0f08a69c66
commit d476ef1ec2
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+8
View File
@@ -880,6 +880,14 @@ The following values are currently defined for the `head` field:
* `reply`: an indicator that the message is a reply to another message, a unique ID of the original message, `"grp1XUtEhjv6HND:123"`.
* `sender`: a user ID of the sender added by the server when the message is sent by on behalf of another user, `"usr1XUtEhjv6HND"`.
* `thread`: an indicator that the message is a part of a conversation thread, a topic-unique ID of the first message in the thread, `":123"`; `thread` is intended for tagging a flat list of messages as opposite to a creating a tree.
* `webrtc`: a string representing the state of the video call the message represents. Possible values:
* `"started"`: call has been initiated and being established
* `"accepted"`: call has been accepted and established
* `"finished"`: previously successfully established call has been ended
* `"missed"`: call was hung up by the caller or timed out before getting established
* `"declined"`: call was hung up by the callee before getting established
* `"disconnected"`: call was terminated by the server for other reasons (e.g. due to an error)
* `webrtc-duration`: a number represeting video call duration after establishment (in milliseconds).
Application-specific fields should start with an `x-<application-name>-`. Although the server does not enforce this rule yet, it may start doing so in the future.