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

docs updated

Browse Source
This commit is contained in:
or-else
2023-02-12 20:02:55 -08:00
parent 112d100c2b
commit 3ab9d9a5cb
4 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+8 -2
View File
@@ -628,7 +628,7 @@ Every client to server message contains the main payload described in the sectio
}
```
The `attachments` array lists URLs of files uploaded out of band. Such listing increments use counter of these files. Once the use counter drops to 0, the files will be automatically deleted.
The `obo` can be set by the `root` user. If the `obo` is set, the server will treat the message as if it came from the sepcified user as opposite to the actual sender.
The `obo` (On Behalf Of) can be set by the `root` user. If the `obo` is set, the server will treat the message as if it came from the specified user as opposite to the actual sender.
The `authlevel` is supplementary to the `obo` and permits setting custom authentication level for the user. A an `"auth"` level is used if the field is unset.
#### `{hi}`
@@ -668,7 +668,12 @@ acc: {
// default: current user, optional
token: "XMgS...8+BO0=", // string, authentication token to use for the request if the
// session is not authenticated, optional
// Temporary authentication parameters for one-off actions, like password reset.
tmpscheme: "code", // name of the temp wuth scheme
tmpsecret: "XMgS...8+BO0=", // temp auth secret
status: "ok", // change user's status; no default value, optional.
authlevel: "auth", // authentication level of the user when UserID is set and not equal
// to the current user; Either "", "auth" or "anon"; default: ""
scheme: "basic", // authentication scheme for this account, required;
// "basic" and "anon" are currently supported for account creation.
secret: base64encode("username:password"), // string, base64 encoded secret for the chosen
@@ -888,8 +893,9 @@ The following values are currently defined for the `head` field:
* `"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
* `"missed"`: call timed out before getting established
* `"declined"`: call was hung up by the callee before getting established
* `"busy"`: the call was declined due to the callee being in another call.
* `"disconnected"`: call was terminated by the server for other reasons (e.g. due to an error)
* `webrtc-duration`: a number representing a video call duration (in milliseconds).