2. Methods
2.1. activate.guest
Enable guest account and set password
Parameters
- token : Auth token
- account : Guest account
- password : New password to be set for the guest account
- hash : Security hash
- auth_type : 0 - plain, 1 - RSA
Returns
{
"ok": "boolean"
}
2.2. api.test
Function for testing API, It will return every argument you supply to it.
Returns
{
"args": "json",
"version": "string",
"ok": true
}
2.3. auth.revoke
Revokes an access token
Parameters
Returns
{
"revoked": "boolean",
"ok": "boolean"
}
2.4. auth.test
Checks authentication token and tells you who you are.
Parameters
Returns
{
"user": "string",
"user_id": "string",
"url": "string",
"ok": "boolean"
}
2.5. channels.clone
Clones channel
Parameters
- token : Auth token
- channel : ID of channel
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.6. channels.create
Creates a channel
Parameters
- token : Auth token
- name : Name of the channel
- group_folder_name : Name of the group where channel should be created
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.7. channels.delete
Deletes channel
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"ok":"boolean"
}
2.8. channels.diff
Lists all changes in channels.list since last call of channels.list or channels.diff with this token
Parameters
Returns
{
"channels_diff":"array of TTeamchatChannelChange",
"status":"added|deleted|renamed",
"ok":"boolean"
}
2.9. channels.exit
Remove channel from list of channels
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"ok":"boolean"
}
2.10. channels.getAutoFollow
Returns if channel is subscribed by authorized user
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"autofollow":"boolean",
"ok":"boolean"
}
2.11. channels.getNotificationsSettings
Returns if channel is subscribed by authorized user
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"subscribe":"boolean",
"ok":"boolean"
}
List all messages except thread comments
Parameters
- token : Auth token
- channel : ID of channel
- search : Search only threads containing this string in the main message
- count : Number of files to return per page
- page : Page number to return
- latest : Timestamp, end of the time range for filtering messages
- oldest : Timestamp, start of the time range for filtering messages
- inclusive : Boolean, include messages = latest | oldest timestamp
- descending : result sorting, default is true
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.13. channels.info
Returns information about the channel
Parameters
- token : Auth token
- channel : ID of channel
- include_unread_count : If true, info about count of unread messages in channel will be included
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.14. channels.invite
Invite user to the channel.
Parameters
- token : Auth token
- channel : ID of channel
- user : User ID
- comment : Reason of invitation
Returns
{
"ok":"boolean"
}
2.15. channels.join
Makes this channel active for the autheticated user
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"ok": "boolean"
}
2.16. channels.kick
Removes user from the channel.
Parameters
- token : Auth token
- channel : ID of channel
- user : User ID
Returns
{
"ok":"boolean"
}
2.17. channels.leave
Makes this channel inactive for the autheticated user
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"ok": "boolean"
}
2.18. channels.list
Lists all channels visible to the authorized user
Parameters
- token : Auth token
- include_unread_count : If true, info about count of unread messages in channel will be included
- exclude_members : If true, members of channel will be missing
- include_permissions : If true, info about caller permission for channel will be included
- collection_type : 0 - show all channel, 1 - only active channels, 2 - only inactive channels, 3 - only channels with unread messages
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channels":"array of TTeamchatChannel",
"ok":"boolean"
}
2.19. channels.rename
Renames channel
Parameters
- token : Auth token
- channel : ID of channel
- name : New name
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.20. channels.setAutoFollow
Set channel subscription of authorized user
Parameters
- token : Auth token
- channel : ID of channel
- autofollow : True if channel should be autofollowed
Returns
{
"ok":"boolean"
}
2.21. channels.setNotificationsSettings
Set channel subscription of authorized user
Parameters
- token : Auth token
- channel : ID of channel
- subscribe : True if channel should be subscribe, false if channel should be unsubscribed
Returns
{
"ok":"boolean"
}
2.22. channels.setpurpose
Sets purpose of the channel.
Parameters
- token : Auth token
- purpose : Purpose of the channel
- id : Channel ID
Returns
{
"purpose":"string",
"ok":"boolean"
}
2.23. channels.settopic
Sets topic of the channel.
Parameters
- token : Auth token
- topic : This is the topic of this channel
- id : Channel ID
Returns
{
"topic":"string",
"ok":"boolean"
}
2.24. channels.userPermissions
Returns permissions of the authenticated user for channel
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"permissions":"TTeamchatPermissions",
"ok":"boolean"
}
2.25. chat.delete
Deletes a message
Parameters
- token : Auth token
- channel : ID of channel
- ts : ID of message to delete
Returns
{
"ts": "string",
"channel": "string",
"ok": "boolean"
}
2.26. chat.postCodeBlock
Posts code block to the given channel
Parameters
- token : Auth token
- channel : ID of channel
- text : Code block of the message
- language : Specify language of the code block
- ts : ID of object which should be commented
Returns
{
"ts": "string",
"channel": "string",
"message": "TTeamchatCodeBlockEvent",
"ok": "boolean"
}
2.27. chat.postMessage
Posts message to the given channel
Parameters
- token : Auth token
- channel : ID of channel
- text : Text of the message
- ts : ID of object which should be commented
Returns
{
"ts": "string",
"channel": "string",
"message": "TTeamchatMessageEvent",
"ok": "boolean"
}
2.28. chat.update
Update text of a message
Parameters
- token : Auth token
- channel : ID of channel
- ts : ID of message to update
- text : New text
Returns
{
"ts": "string",
"channel": "string",
"text": "string",
"message": "TTeamchatMessageEvent",
"ok": "boolean"
}
2.29. chat.updateCodeBlock
Update code block code and language
Parameters
- token : Auth token
- channel : ID of channel
- ts : ID of message to update
- text : New code
- language : New language
Returns
{
"ts": "string",
"channel": "string",
"text": "string",
"message": "TTeamchatCodeBlockEvent",
"ok": "boolean"
}
2.30. conferences.checkPassword
Check if password for conference is correct (case sensitive)
Parameters
- meeting_id : ID of the meeting
- password : Meeting password
- token : Auth token
Returns
{
"correct": "boolean"
"ok": "boolean"
}
2.31. conferences.info
Get info about meeting
Parameters
- meeting_id : ID of the meeting
- token : Auth token
Returns
{
"conference":{
"meeting_id":"584355239",
"meeting_url":"https://192.168.2.173/conference/584355239",
"title":"kour",
"start_date_time":0,
"end_date_time":0,
"organizer_parsed":[
{
"email":"u1@new.cz",
"name":"Ondra Novy"
}
],
"has_password":false,
"password":"",
"dynamic_link":"https://teamchatmobile.page.link/?link=https%3A%2F%2F192.168.2.173%2Fconference%2F584355239%3Fmeeting_id%3D584355239%26conference_url%3Dhttps%253A%252F%252F192.168.2.173%252Fconference%252F%26teamchatapi_url%3Dhttps%253A%252F%252F192.168.2.173%252Fteamchatapi%252F&isi=1252689833&ibi=com.icewarp.teamchatMobile&apn=com.icewarp.teamchatmobile&afl=https://play.google.com/store/apps/details?id=com.icewarp.teamchatmobile&ofl=https%3A%2F%2F192.168.2.173%2Fconference%2F584355239%23desktop%3D1",
"recording_uri":"https://recordings.stage.conference.icewarp.com/room/613877347e9339b9d2e14b22",
"recording_api_uri":"https://recordings.stage.conference.icewarp.com/api/v1/public/rooms/613877347e9339b9d2e14b22"
},
"ok":true
}
2.32. conferences.joined
Create corresponding info when user is joined to existing meeting
Parameters
- token : Auth token
- meeting_id : ID of the meeting
- tzid : Timezone ID
Returns
{
"conference": "TTeamchatConference"
"ok": "boolean"
}
2.33. conferences.jwt
Get jitsi jwt
Parameters
- meeting_id : ID of the meeting
- username : user email
- password : meeting password
- token : Auth token
Returns
{
"jwt": "TTeamchatConferenceJwt"
"ok": "boolean"
}
2.34. conferences.list
List conferences of given type - History or Upcoming
Parameters
- token : Auth token
- type : 0 - History, 1 - Upcoming
- count : Number of files to return per page; applies only for type=0 (History)
- page : Page number to return; applies only for type=0 (History)
- days_future : How many days in future should be Upcoming conferences listed; applies only for type=1 (Upcoming)
- days_future_since : How many days in future should be Upcoming conferences listed Since; applies only for type=1 (Upcoming)
Returns
{
"conferences":"array of TTeamchatConference",
"ok":"boolean"
}
2.35. conferences.meetFree
Starts meeting without authentication
Parameters
- name : Name of the event
- password : Meeting password
- autorecording : Conference should be recorded right after start
- autolobby : Conference should be lobby right after start
Returns
{
"conference": "TTeamchatFreeConference"
"ok": "boolean"
}
2.36. conferences.meetNow
Starts meeting
Parameters
- token : Auth token
- name : Name of the event
- password : Meeting password
- autorecording : Conference should be recorded right after start
- autolobby : Conference should be lobby right after start
Returns
{
"conference": "TTeamchatConference"
"ok": "boolean"
}
2.37. conferences.recordingList
List all recordings for given conference
Parameters
- token : Auth token
- evn_id : id of conference
Returns
{
"conference": "TTeamchatConference"
}
2.38. conferences.remoteJoined
Create corresponding info when user is joined to existing meeting on remote server
Parameters
- token : Auth token
- meeting_id : ID of the meeting with remote host
- meeting_url : Url to join the meeting
- organizer : email of organizer on the remote server
- organizer_name : name of organizer on the remote server
- title : Title of the meeting on the remote server
- recordings_uri : A recording service url
- recordings_api_uri : A recording service url
Returns
{
"conference": "TTeamchatConference"
"ok": "boolean"
}
2.39. documentation.errors
Return list of all possible errors
Parameters
2.40. events.do
Manipulates an event or conference
Parameters
- token : Auth token
- channel : ID of channel, should be present events and not for conferences
- evnid : ID of event to delete
- item : vCal or EAS
- parameters : format which is sent in 'item' and action to do
Returns
{
"ok": "boolean"
}
2.41. events.get
Return vCal object of an event or conference
Parameters
- token : Auth token
- evnid : ID of event
- channel : ID of channel, should be present events and not for conferences
- exception_date : date to specify exception in reccurence pattern
Returns
{
"vcalendar": "string"
"ok": "boolean"
}
2.42. events.history
Return past events in the room
Parameters
- token : Auth token
- channel : ID of channel, should be present events and not for conferences
Returns
{
"messages": "TTeamChatMessageEvent"
"ok": "boolean"
}
2.43. events.upcoming
Return upcoming events in the room
Parameters
- token : Auth token
- channel : ID of channel, should be present events and not for conferences
Returns
{
"messages": "TTeamChatMessageEvent"
"ok": "boolean"
}
2.44. files.avatar
Download avatar of given internal or external contact. If external contact is requested, it is obtained from point of view of the caller
Parameters
- token : Auth token
- internal : If set to true (1), the avatar is not searched from point of view of the caller, but it is taken from the personal vcard of the email. It makes sense only for emails being local server accounts
- resize : If true then avatar will be resized
- width,height : Integer. If all theree values are set (resize,width,height), the image is resized into .jpg file before downloading
- skin : Name of the skin - it is used for obtaining face placeholder when the avatar is not found
2.45. files.download
Downloads file
Parameters
- token : Auth token
- ticket : Ticket of file
2.46. files.edit
Starts editing session on given document
Parameters
- token : Auth token
- id : ID of file to edit
- deviceid : ID of device, choosed by client
- mode : Editor mode (0=edit 1= join read 2= independent read)
- attid : Filename or index of the file - used only if the file is event attachment
- fallback : if the editor can not be opened in the requested mode, allow to fallback to another mode, 0= fallback to join edit or indeendent edit, 1= fallback to join edit, 2= no fallback
Returns
{
"data": "json",
"mode": "int",
"key": "string",
"ok": "boolean"
}
2.47. files.empty
Downloads empty file by given file type
Parameters
- token : Auth token
- filetype : Type of file you want to get ('text','spreadsheet','presentation')
2.48. files.exists
Checks if file exists
Parameters
- token : Auth token
- ticket : Ticket of file
2.49. files.invite
Creates invitation ( ticket ) for anonymous users to be able join collaboration editing
Parameters
- token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
- id : ID of file to invite (required)
- deviceid : ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)
- rights : Rights for document editing
- password : Password protected - value ( optional )
- expire : Expiration of this invitation ( optional )
2.50. ticket.info
Returns informations about ticket
Parameters
- ticket : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
2.51. files.list
Gets list of files on given channel, filtered by optional arguments
Parameters
- token : Auth token
- channel : ID of channel
- count : Number of files to return per page
- page : Page number to return
- search : Search only threads containing this string in the main message
- descending : result sorting, default is true
Returns
{
"messages":"array of TTeamchatFileEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.52. files.setEditingPermission
Set editing premission for user
Parameters
- token : Auth token
- user : User ID
- session_key : Editing session ID
- permission : 0= depNone,1= depRead, 2= depWrite, 3= depAdminister
Returns
{
"ok": "boolean"
}
2.53. files.setEditingProperties
Sets document properties, right now can be only used for changing filename of empty document
Parameters
- token : Auth token
- session_key : Editing session ID
- filename : New filename of document
Returns
{
"ok": "boolean"
}
2.54. files.stopedit
Stops editing session on given document
Parameters
- token : Auth token
- id : ID of file to stop edit
- ticket : ticket of file to stop edit
- deviceid : ID of device, choosed by client
- attid : Filename or index of the file - used only if the file is event attachment
2.55. files.uninvite
Deletes invitation for collaboration editing
Parameters
- token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
- id : ID of file to invite (required)
- deviceid : ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)
2.56. folders.userPermissions
Returns permissions of the authenticated user for channel folder
Parameters
- token : Auth token
- folder : folder email
Returns
{
"permissions":"TTeamchatPermissions",
"ok":"boolean"
}
2.57. groups.clone
Clones group
Parameters
- token : Auth token
- channel : ID of channel
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.58. groups.create
Creates a group = private channel
Parameters
- token : Auth token
- name : Name of the group
- users_to_invite : IDs of users that will be invited to group after creation; list delimited by semicolon
- warning : if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
Returns
{
"channel":"TTeamchatChannel",
"ok":"boolean"
}
2.59. http.download
Receive a remote file via HTTP
Parameters
- token : Auth token
- url : URL
2.60. items.info
Returns info about given item
Parameters
- token : Auth token
- channel : ID of channel
- ts : ID of item
Returns
{
"message": "TTeamchatMessageEvent",
"ok": "boolean"
}
2.61. iwauthentication.login.digest
Performs digest authentication against the IceWarp server. It is a two phase iteration operation.
Parameters
- username : username of the user you want to authenticate
- realm : value returned in the first iteration response
- nonce : value returned in the first iteration response
- qop : value returned in the first iteration response
- algorithm : value returned in the first iteration response
- method : value returned in the first iteration response
- nc : nonce count
- cnonce : client nonce
- response : calculated digest
- uri : uri of the request
2.62. iwauthentication.logout
Deauthorizes token
Parameters
Returns
{
"ok": "boolean"
}
2.63. iwauthentication.login.plain
Performs plain text authentication against the IceWarp server.
Parameters
- username : username of the user you want to authenticate
- password : password of the user above
Returns
{
"authorized":"boolean",
"token":"string",
"host":"string",
"ok":"boolean"
}
2.64. mentions.list
Lists all messages in the channel where authorized user is mentioned
Parameters
- token : Auth token
- channel : ID of channel
- count : Number of files to return per page
- search : Search only threads containing this string in the main message
- page : Page number to return
- descending : result sorting, default is true
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.65. notifications.register
Register device for Google or Apple notifications
Parameters
- token : Auth token
- device : Device ID
- type : Google or apple
- app : ID to determine app notifications license
- user : User ID, default is authorized user
- sound : Name of notification sound
- message_preview : If notification preview should be shown
- key : Encryption key
- cipher : Encryption cipher
- imei : Imei
Returns
{
"ok": "boolean"
}
2.66. notifications.resetBadge
Set badge count to 0 of all registrations fullfills parameters condition
Parameters
- token : Auth token
- device : Device ID
- user : User ID, default is authorized user
- app : ID to determine app notifications license
Returns
{
"ok": "boolean"
}
2.67. notifications.unregister
Deletes all notification registrations which fullfil parameters
Parameters
- token : Auth token
- device : Device ID
- app : ID to determine app notifications license
- user : User ID, default is authorized user
Returns
{
"ok": "boolean"
}
2.68. password.policy
Returns server password policy
Returns
{
"pass_policy_len":"int",
"pass_policy_num":"int",
"pass_policy_non_alpha_num":"int",
"pass_policy_alpha":"int",
"pass_policy_alpha_upper":"int",
"pass_policy_user_alias":"boolean",
"ok":"boolean"
}
2.69. pins.add
Pins an item.
Parameters
- token : Auth token
- global : if true, pin is global else private
- channel : ID of channel
- file : ID of file to pin
- file_comment : ID of file comment to pin
- ts : ID of object to pin
Returns
{
"ok":"boolean"
}
2.70. pins.list
Returns list of all pins or pins in a particular channel
Parameters
- token : Auth token
- channel : ID of channel
- include_public : If public pins should be included
- include_private : If private pins should be included
- search : Search only threads containing this string in the main message
- count : Number of files to return per page
- page : Page number to return
- descending : result sorting, default is true
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.71. pins.remove
Removes pin from item.
Parameters
- token : Auth token
- global : if true, pin is global else private
- channel : ID of channel
- file : ID of file to unpin
- file_comment : ID of file comment to unpin
- ts : ID of object to pin
Returns
{
"ok":"boolean"
}
2.72. reactions.add
Adds reaction on given message in given channnel
Parameters
- token : Auth token
- channel : ID of channel
- name : Reaction (emoji) name (thumbsup, like, heart ..)
- ts : ID of object
Returns
{
"ok":"boolean"
}
2.73. reactions.remove
Removes reaction from item
Parameters
- token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
- channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
- name : Reaction (emoji) name (thumbsup, like, heart ..)
- ts : ID of object
Returns
{
"ok":"boolean"
}
2.74. rtm.connect
Starts real time messaging session
Parameters
Returns
{
"url": "string",
"ok": "boolean"
}
2.75. rtm.start
Starts real time messaging session
Parameters
Returns
{
"url": "string",
"user": "TTeamchatUser",
"channels": "array of TTeamchatChannel",
"ok": "boolean"
}
2.76. search.users
Returns list of users based on parameters
Parameters
- token : Auth token
- channel : ID of channel
- users : IDs of users that are interesting for caller delimited by semicolon
- query : Query that allow complex search conditions
- email_or_name : String that should be search in email and name, only users with that search condition will be returned
- users_to_exclude : IDs of users that should not be returned delimited by semicolon
- active_only : If true, returns only active users
- count : Number of files to return per page
- page : Page number to return
Returns
{
"members":"array of TTeamchatUser",
"cache_ts":"string",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.77. shortUrl.links
proxy for clients/fooclient/links
Parameters
List thread comments
Parameters
- token : Auth token
- channel : ID of channel
- ts : thread ID
Returns
{
"messages":"array of TTeamchatMessageEvent",
"ok":"boolean"
}
2.79. threads.follow
Follow thread
Parameters
- token : Auth token
- channel : ID of channel
- ts : thread ID
Returns
2.80. threads.followed
Global function to list followed threads without comments
Parameters
- token : Auth token
- search : Search only threads containing this string in the main message
- count : Number of files to return per page
- page : Page number to return
- descending : result sorting, default is true
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.81. threads.list
List threads without comments
Parameters
- token : Auth token
- channel : ID of channel
- followed : If true, return only followed threads
- search : Search only threads containing this string in the main message
- count : Number of files to return per page
- page : Page number to return
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.82. threads.unfollow
Unfollow thread
Parameters
- token : Auth token
- channel : ID of channel
- ts : thread ID
Returns
2.83. threads.unreadCount
Return count of new threads or threads with new activity
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"count": "int",
"ok": "boolean"
}
2.84. threads.unreadList
List unread threads without comments
Parameters
- token : Auth token
- channel : ID of channel
- followed : If true, return only followed threads
- search : Search only threads containing this string in the main message
- count : Number of files to return per page
- page : Page number to return
Returns
{
"messages":"array of TTeamchatMessageEvent",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.85. time.now
Returns server unixtime
Parameters
Returns
{
"now": "int",
"ok": "boolean"
}
2.86. users.getNotificationsSettings
Get authorized user's email notification setting
Parameters
- token : Auth token
- channel : ID of channel
- type : Type of notification to be get - daily, mention, pin or upload
Returns
{
"subscribe":"boolean",
"ok":"boolean"
}
2.87. users.getPresence
Get user presence
Parameters
- token : Auth token
- channel : ID of channel
- user : User ID, if not present authenticated user is used
Returns
{
"online": "boolean",
"ok": "boolean"
}
2.88. users.identity
Returns info about currently authenticated user
Parameters
Returns
{
"user": "TTeamchatUser"
"ok": "boolean"
}
2.89. users.info
Returns info about selected user
Parameters
- token : Auth token
- user : User ID
Returns
{
"user": "TTeamchatUser"
"ok": "boolean"
}
2.90. users.list
Returns list of all users or users in a particular channel
Parameters
- token : Auth token
- channel : ID of channel
- users : IDs of users that are interesting for caller delimiter by semicolon
- active_only : If true, returns only active users
Returns
{
"members":"array of TTeamchatUser",
"cache_ts":"string",
"paging":"TTeamchatPaging",
"ok":"boolean"
}
2.91. users.setInfo
Sets authenticated user's details
Parameters
- token : Auth token
- firstname :
- middlename :
- surname :
- showas :
- nickname :
- company :
- title :
- suffix :
- description :
- gender :
- profession :
- job :
- assistant :
- manager :
- department :
- filename :
- content :
Returns
{
"vcard":"string",
"ok":"boolean"
}
2.92. users.setNotificationsSettings
Set authorized user's email notification setting
Parameters
- token : Auth token
- channel : ID of channel
- type : Type of notification to be set - daily, mention, pin or upload
- subscribe : True if selected should be subscribe, false if selected should be unsubscribed
Returns
{
"ok": "boolean"
}
2.93. users.setStatus
Sets authenticated user's status
Parameters
- token : Auth token
- channel : ID of channel
- status : offline|typing|commenting|online|background
Returns
{
"ok": "boolean"
}
2.94. users.setTyping
Let server know that authenticated user is typing in the channel
Parameters
- token : Auth token
- channel : ID of channel
Returns
{
"ok": "boolean"
}
2.95. version
Show version of server
Returns
{
"version": "string",
"ok": "boolean"
}