The TeamChat platform is completely ready to integrate with third party applications using its application programming interface for developers, offering extended functionality for teams. See Getting Started section
IceWarp TeamChat API requires installed IceWarp server with control service running. TeamChat API can be accessed on /api/api-teamchat and the available methods are described below
Function for testing API, It will return every argument you supply to it.
{
"args": {
your arguments
},
"ok": true
}
Revokes an access token
{
"revoked": "true",
"ok": true
}
Checks authentication token and tells you who you are.
{
"user": "admin@icewarp.com",
"user_id": "admin@icewarp.com",
"url": "/teamchatapi/auth.test",
"ok": true
}
Returns history of given channel in rfc4287
Clones channel
{
"ok":true
}
Creates a channel
{
"ok":true
}
Deletes channel
{
"ok":true
}
Returns if channel is subscribed by authorized user
{
"subscribe":false,
"ok":true
}
Retrieve a thread of messages posted to a channel.
// "messages": [
// {
// "type": "message",
// "user": "beta@rhel7.gettest.com",
// "text": "Hello :)",
// "is_stared": false,
// "subtype": "message_comment",
// "ts": "1516195206.000463",
// "comment": {
// "id": "5a5f4d8601cf",
// "created": 1516195207,
// "timestamp": 1516195207,
// "user": "beta@rhel7.gettest.com",
// "comment": "Hello :)",
// "channel": "Z3JvdXAxJTQwcmhlbDcuZ2V0dGVzdC5jb20mVGVhbUNoYXQlNUM1YTVkZWZkODAyODQ",
// "is_intro": false
// },
// "fs_intro": false,
// "message": {
// "type": "message",
// "ts": "1516117587.001236"
// }
// }
// ],
// "has_more": true,
// "latest": "0.000000",
// "oldest": "0.000000",
// "ok": true
//}
//
Returns information about the channel
{
"channel":{
"id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1QzRhNmE4MjE4MDAxNg==",
"name":"new name",
"created":1489159009,
"creator":"public-folders@icewarp.com",
"is_archived":false,
"is_member":true,
"num_members":1,
"members":[
"user@icewarp.com"
]
},
"ok":true
}
Invite user to the channel.
{
"ok":true
}
Makes this channel active for the autheticated user
{
"ok":true
}
Removes user from the channel.
{
"ok":true
}
Makes this channel inactive for the autheticated user
{
"ok":true
}
Lists all channels visible to the authorized user
{
"channels":[
{
"id":"aW50ZXJuYWwlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGM4YjRiYjgwMDVj",
"name":"CHANNEL2222",
"created":1523431788,
"creator":"ondra@ondrovo.cz",
"is_archived":false,
"is_member":true,
"group_folder_name":"internal@ondrovo.cz",
"is_active":true,
"num_members":4,
"members":[
{
"name":"admin@ondrovo.cz",
"role":"member"
},
{
"name":"auto@ondrovo.cz",
"role":"member"
},
{
"name":"ondra@ondrovo.cz",
"role":"administrator"
}
],
}
],
"ok":true
}
Renames channel
{
"channel":{
"id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1QzRhNmE4MjE4MDAxNg==",
"name":"new name",
"created":1489159009,
"creator":"public-folders@icewarp.com",
"is_archived":false,
"is_member":true,
"num_members":1,
"members":[
"user@icewarp.com"
]
},
"ok":true
}
Returns if channel is subscribed by authorized user
{
"ok":true
}
Sets purpose of the channel.
{
"purpose":"This is the purpose of this channel",
"ok":true
}
Sets topic of the channel.
{
"topic":"This is the topic of this channel",
"ok":true
}
Returns permissions of user
{
"permissions":{
"items_read":true,
"items_write":true,
"items_modify":true,
"items_delete":true,
"items_edit_documents":true,
"folder_read":true,
"folder_write":true,
"folder_rename":true,
"folder_delete":true,
"administration_invite":true,
"administration_kick":true,
"administration_administer":true
},
"ok":true
}
Deletes a message
{
"ts": "1528449570.000077",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"text": "new message",
"ok": true
}
Posts message to the given channel
{
"ts":"1528449570.000077",
"channel":"cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"message":{
"type":"message",
"user":"ondra@ondrovo.cz",
"text":"message",
"is_stared":false,
"subtype":"message_comment",
"ts":"1528449570.000077",
"comment":{
"id":"4cc85a6f004d",
"created":1528449572,
"timestamp":1528449572,
"user":"ondra@ondrovo.cz",
"comment":"message",
"channel":"cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"is_intro":false
},
"fs_intro":false,
"message":{
"type":"message",
"ts":"1528373270.000074"
}
},
"ok":true
}
Update text of a message
{
"ts": "1528449570.000077",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"text": "new message",
"ok": true
}
Creates a new event in the channel
{
"ok": true
}
Deletes an event
{
"ok": true
}
Updates selected attributes of event
{
"ok": true
}
Lists all events in the channel
{
"events":[
{
"title":"New Appointment",
"note":"",
"location":"",
"start_date_time":1528761600,
"end_date_time":1528848000,
"my_status":"A",
"ts":"1528804526.000483",
"accepted_participants_count":1
}
],
"ok":true
}
Download avatar of given internal or external contact. If external contact is requested, it is obtained from point of view of the caller
Adds comment to an existing file
{
"comment":{
"id":"4cc86a85005a",
"created":1528456812,
"timestamp":1528456812,
"user":"ondra@ondrovo.cz",
"comment":"filecom",
"channel":"",
"is_intro":false
},
"ok":true
}
Deletes an existing file comment
{
"ok": true
}
Edit file comment
{
"comment":{
"id":"4cc86a85005a",
"created":1528456812,
"timestamp":1528456812,
"user":"ondra@ondrovo.cz",
"comment":"filecom",
"channel":"",
"is_intro":false
},
"ok":true
}
Deletes a file
{
"ok": true
}
Downloads file
Starts editing session on given document
{
"data": {
"documentType": "text",
"document": {
"fileType": "docx",
"key": "4a6d80d8001f76d1443d",
"title": "HG JSON API.docx",
"url": "https://domain/teamchatapi/HG%20JSON%20API.docx?override_method=files.download&ticket=eJxLtzVJNEsxTzUyMDAxT1JLsw1JTcx1zkgsUTV1hjHVkm091YptTSwsDE1TLZOME41S1YpsdY0MTcxNTA3MLUzUUm3VMsEGWRgYGxgAlel7uKsaGXgF.,sBKccAT72U,OQKtWxbE5MU0zRjy.TEJAAU.SFIt"
},
"editorConfig": {
"mode": "edit",
"callbackUrl": "https://192.168.6.135/.well-known/icewarp-officecallback/455B1DEF-49BB97B2-7A427F-1CA90A7D",
"user": {
"firstname": "Admin",
"id": "48815e9b3a2e123",
"lastname": ""
}
}
},
"mode": 0,
"key": "4a6d80d8001f76d1443d",
"ok": true
}
Downloads empty file by given file type
Returns details about file
{
"file":{
"id":"4cc68e2f237e",
"name":"dfdsfds.docx",
"created":1528300171,
"timestamp":1528300171,
"title":"dfdsfds.docx",
"mimetype":"application/octet-stream",
"filetype":"",
"pretty_type":"Microsoft Word Open XML Document",
"user":"admin@ondrovo.cz",
"mode":"hosted",
"editable":false,
"is_external":false,
"external_type":"",
"username":"",
"size":8465,
"url_private":"https://192.168.22.52/teamchatapi/dfdsfds.docx?override_method=files.download&ticket=eJwtyjsOAjEMRdHV4A5IXpxf4WoqejbgSWJACCHNULB8UiDd7tybcAsuryiAG2RyHfpa7vo5xGWKz2qKUJmaXGj,z6UDPtImR3jOHF0uTEPoMb2lMmAIqZ679X126u,2padU1ByS2hp,UYAgRA__t&editcounter=1",
"url_private_download":"https://192.168.22.52/teamchatapi/dfdsfds.docx?override_method=files.download&ticket=eJwtyjsOAjEMRdHV4A5IXpxf4WoqejbgSWJACCHNULB8UiDd7tybcAsuryiAG2RyHfpa7vo5xGWKz2qKUJmaXGj,z6UDPtImR3jOHF0uTEPoMb2lMmAIqZ679X126u,2padU1ByS2hp,UYAgRA__t&editcounter=1",
"permalink":"https://192.168.22.52/teamchatapi/dfdsfds.docx?override_method=files.download&ticket=eJwtyjsOAjEMRdHV4A5IXpxf4WoqejbgSWJACCHNULB8UiDd7tybcAsuryiAG2RyHfpa7vo5xGWKz2qKUJmaXGj,z6UDPtImR3jOHF0uTEPoMb2lMmAIqZ679X126u,2padU1ByS2hp,UYAgRA__t&editcounter=1",
"permalink_public":"https://192.168.22.52/teamchatapi/dfdsfds.docx?override_method=files.download&ticket=eJwtyjsOAjEMRdHV4A5IXpxf4WoqejbgSWJACCHNULB8UiDd7tybcAsuryiAG2RyHfpa7vo5xGWKz2qKUJmaXGj,z6UDPtImR3jOHF0uTEPoMb2lMmAIqZ679X126u,2padU1ByS2hp,UYAgRA__t&editcounter=1",
"is_public":true,
"public_url_shared":true,
"display_as_bot":false,
"comments_count":1,
"channels":[
""
],
"initial_comment":{
"id":"inicomid_4cc68e2f2369",
"created":1528300171,
"timestamp":1528300171,
"user":"admin@ondrovo.cz",
"comment":"",
"channel":"",
"is_intro":true
}
},
"comments":[
{
"id":"4cc86a85005a",
"created":1528456812,
"timestamp":1528457503,
"user":"ondra@ondrovo.cz",
"comment":"filecom",
"channel":"",
"is_intro":false
}
],
"paging":{
"count":100,
"total":1,
"page":1,
"pages":1
},
"ok":true
}
Gets list of files on given channel, filtered by optional arguments
{
"files": [
{
"id": "4a6a875cae79",
"name": "11439.png",
"created": 1489161537,
"timestamp": 1489161537,
"title": "11439.png",
"mimetype": "",
"filetype": ".png",
"pretty_type": "Portable Network Graphics",
"user": "admin@icewarp.com",
"mode": "hosted",
"editable": false,
"is_external": false,
"external_type": "",
"username": "",
"size": 0,
"url_private": "https://",
"url_private_download": "https://",
"permalink": "https://",
"permalink_public": "",
"is_public": true,
"public_url_shared": true,
"display_as_bot": false,
"comments_count": 0,
"channels": [
"dGVzdC1ncnVwJTQwZGVqbWVrLmNvbSZUZWFtQ2hhdCU1QzRhNTc4MjE5YWIxZA"
],
"initial_comment": {
"id": "inicomid_4a6a875cae79",
"created": 1489161537,
"timestamp": 1489161537,
"user": "admin@icewarp.com",
"comment": "",
"channel": "dGVzdC1ncnVwJTQwZGVqbWVrLmNvbSZUZWFtQ2hhdCU1QzRhNTc4MjE5YWIxZA",
"is_intro": true
}
}
],
"paging": {
"count": 1,
"total": 1,
"page": 1,
"pages": 1
},
"ok": true
}
Set editing premission for user
{
"ok": true
}
Sets document properties, right now can be only used for changing filename of empty document
{
"ok": true
}
Stops editing session on given document
Uploads file to given channels
{
"file": {
"id": "4a6d88e601b6",
"name": "test",
"created": 1489421232,
"timestamp": 1489421232,
"title": "test",
"mimetype": "F",
"filetype": "",
"pretty_type": "file .",
"user": "admin@icewarp.com",
"mode": "hosted",
"editable": false,
"is_external": false,
"external_type": "",
"username": "",
"size": 21,
"url_private": "https://domain/teamchatapi/test?override_method=files.download&ticket=eJw1zDsOgCAMANDT2M0I2EIdOjm5e4GC9RPjotw,JiZub3qboMYlWXAOU4ZVZtNr3LU2NP6EIhM8gsyebMi9BoNb2uAxIbnECCZwfBGzRedz7Ko9FU6hhdaoxTS,P2geQw__t&editcounter=0",
"url_private_download": "https://domain/teamchatapi/test?override_method=files.download&ticket=eJw1zDsOgCAMANDT2M0I2EIdOjm5e4GC9RPjotw,JiZub3qboMYlWXAOU4ZVZtNr3LU2NP6EIhM8gsyebMi9BoNb2uAxIbnECCZwfBGzRedz7Ko9FU6hhdaoxTS,P2geQw__t&editcounter=0",
"permalink": "https://domain/teamchatapi/test?override_method=files.download&ticket=eJw1zDsOgCAMANDT2M0I2EIdOjm5e4GC9RPjotw,JiZub3qboMYlWXAOU4ZVZtNr3LU2NP6EIhM8gsyebMi9BoNb2uAxIbnECCZwfBGzRedz7Ko9FU6hhdaoxTS,P2geQw__t&editcounter=0",
"permalink_public": "https://domain/teamchatapi/test?override_method=files.download&ticket=eJw1zDsOgCAMANDT2M0I2EIdOjm5e4GC9RPjotw,JiZub3qboMYlWXAOU4ZVZtNr3LU2NP6EIhM8gsyebMi9BoNb2uAxIbnECCZwfBGzRedz7Ko9FU6hhdaoxTS,P2geQw__t&editcounter=0",
"is_public": true,
"public_url_shared": true,
"display_as_bot": false,
"comments_count": 0,
"channels": [
"bmV3LWdyb3VwJTQwZGVqbWVrLmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0"
],
"initial_comment": {
"id": "inicomid_4a6d88e601b6",
"created": 1489421232,
"timestamp": 1489421232,
"user": "admin@icewarp.com",
"comment": "",
"channel": "bmV3LWdyb3VwJTQwZGVqbWVrLmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0",
"is_intro": true
}
},
"ok": true
}
Clones group
{
"ok":true
}
Creates a group = private channel
{
"ok":true
}
Returns info about given item
{
"message": {
"type": "message",
"user": "admin@icewarp.com",
"text": "test",
"ts": "1489417914.000079",
"is_stared": false
},
"paging": {
"count": 0,
"total": 0,
"page": 1,
"pages": 0
},
"ok": true
}
Performs digest authentication against the IceWarp server. It is a two phase iteration operation.
{
"realm":"realm",
"qop":"auth",
"nonce":"c05999c2a652f836750e7d45ca3b8ed2ad11ec752f381e0ff414ba5c5456ba61",
"algorithm":"MD5-Sess",
"method":"authenticate",
"authorized":"false",
"ok":true
}
{
"authorized":"true",
"token":"xoxp-44e14e77c260e58b4c5174e79ee05c7cfa5fffb4174e55cf46390e41f2dad209",
"ok":true
}
Deauthorizes token
{
"ok": true
}
Performs plain text authentication against the IceWarp server.
{
"authorized":"true"
"token":"xoxp-44e14e77c260e58b4c5174e79ee05c7cfa5fffb4174e55cf46390e41f2dad209",
"ok":true
}
Lists all mentions in the channel.
Register device for Google or Apple notifications
{
"ok":true
}
Deletes all notification registrations which fullfil parameters
{
"ok":true
}
Pins an item.
{
"ok": "true"
}
Lists all pins in the channel.
{
"items":[
{
"type":"message",
"user":"user@icewarp.com",
"ts":"1490004760.000165",
"is_stared":false,
"subtype":"file_share",
"file":{
"id":"4a74599400a5",
"name":"file.txt",
"created":1490004761,
"timestamp":1490004761,
"title":"file.txt",
"mimetype":"",
"filetype":".txt",
"pretty_type":"file .txt",
"user":"user@icewarp.com",
"mode":"hosted",
"editable":false,
"is_external":false,
"external_type":"",
"username":"",
"size":0,
"url_private":"https:\/\/icewarp.com\/teamchatapi\/IsNum.sln?override_method=files.download&ticket=eJw1ijESgzAMBF.DOohsJGwXqqhoUvEBjWJIJkCByf,jhup2Z28VUjaOWGcxWGTOuo9vvRoebwSTCUo9DhoyM6J7wSmtdxSIMUSCLPCpvWpKhKj8mMrzt3dlO.ArqTdPhpHdH92gHr0_t&editcounter=0",
"url_private_download":"https:\/\/icewarp.com\/teamchatapi\/IsNum.sln?override_method=files.download&ticket=eJw1ijESgzAMBF.DOohsJGwXqqhoUvEBjWJIJkCByf,jhup2Z28VUjaOWGcxWGTOuo9vvRoebwSTCUo9DhoyM6J7wSmtdxSIMUSCLPCpvWpKhKj8mMrzt3dlO.ArqTdPhpHdH92gHr0_t&editcounter=0",
"permalink":"https:\/\/icewarp\/teamchatapi\/IsNum.sln?override_method=files.download&ticket=eJw1ijESgzAMBF.DOohsJGwXqqhoUvEBjWJIJkCByf,jhup2Z28VUjaOWGcxWGTOuo9vvRoebwSTCUo9DhoyM6J7wSmtdxSIMUSCLPCpvWpKhKj8mMrzt3dlO.ArqTdPhpHdH92gHr0_t&editcounter=0",
"permalink_public":"https:\/\/icewarp.com\/teamchatapi\/IsNum.sln?override_method=files.download&ticket=eJw1ijESgzAMBF.DOohsJGwXqqhoUvEBjWJIJkCByf,jhup2Z28VUjaOWGcxWGTOuo9vvRoebwSTCUo9DhoyM6J7wSmtdxSIMUSCLPCpvWpKhKj8mMrzt3dlO.ArqTdPhpHdH92gHr0_t&editcounter=0",
"is_public":true,
"public_url_shared":true,
"display_as_bot":false,
"comments_count":0,
"channels":[
"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0"
],
"initial_comment":{
"id":"inicomid_4a74599400a5",
"created":1490004761,
"timestamp":1490004761,
"user":"user@icewarp.com",
"comment":"",
"channel":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0",
"is_intro":true
}
}
}
],
"ok":true
}
Removes pin from item.
{
"ok": "true"
}
Adds reaction on given message in given channnel
{
"ok": true
}
Get reactions on specific item
{
"type": "message",
"reactions": [
{
"name": "thumbsup",
"count": 1,
"users": [
"admin@icewarp.com"
]
},
{
"name": "disappointed",
"count": 1,
"users": [
"test@icewarp.com"
]
}
],
"ok": true
}
Gets list of reactions made by a user in a given channel
{
"items": [
{
"type": "message",
"channel": "ZnVsbC1wcmVtaXNzaW9ucyU0MGRlam1lay5jb20mVGVhbUNoYXQlNUM0YTRlODM0ZmFkMjI=",
"message": {
"type": "message",
"user": "admin@icewarp.com",
....
"reactions": [
{
"name": "disappointed",
"count": 1,
"users": [
"admin@icewarp.com"
]
},
{
"name": "thumbsup",
"count": 1
}
],
"attachments": [...]
}
}
],
"paging": {
"count": 1,
"total": 3,
"page": 2,
"pages": 3
},
"ok": true
}
Removes reaction from item
{
"ok": true
}
Starts real time messaging session
{
"url": "ws://your address/rtm/xoxp-61d869c74cb4e2a2b62870c1dd64355e47e0bd0cd5a7b828ed92c69cf5270954",
"self": {
"id": "U023BECGF",
"name": "bobby",
"prefs": {
...
},
"created": 1402463766,
"manual_presence": "active"
},
"users": [ ... ],
"channels": [ ... ],
"ok": true,
}
Searches for messages and files matching a query
// "query":"from:me before:yesterday",
// "messages":{
// "total":88,
// "paging":{
// "count":11,
// "total":88,
// "page":1,
// "pages":5
// },
// "pagination":{
// "total_count":88,
// "page":1,
// "per_page":20,
// "page_count":5,
// "first":1,
// "last":11
// },
// "matches":[
// {
// "type":"message",
// "user":"ondra@ondrovo.cz",
// "text":"Appointment shared (Title=New Appointment, Start=2018.05.09 16:00, End=2018.05.09 16:30)",
// "is_stared":false,
// "subtype":"appointment_share",
// "ts":"1525875048.004175",
// "appointment":{
// "title":"New Appointment",
// "note":"",
// "location":"",
// "start_date_time":1525874400,
// "end_date_time":1525876200,
// "my_status":"A",
// "ts":"1525875048.004106",
// "accepted_participants_count":1
// },
// "previous_2":{
// "type":"message",
// "user":"ondra@ondrovo.cz",
// "text":"Appointment shared (Title=New Appointment, Start=2018.05.12 16:00, End=2018.05.12 16:30)",
// "is_stared":false,
// "subtype":"appointment_share",
// "ts":"1525874918.003731",
// "appointment":{
// "title":"New Appointment",
// "note":"",
// "location":"",
// "start_date_time":1526133600,
// "end_date_time":1526135400,
// "my_status":"A",
// "ts":"1525874918.003677",
// "accepted_participants_count":1
// }
// },
// "next_2":{
// "type":"message",
// "user":"ondra@ondrovo.cz",
// "text":"Appointment shared (Title=New Appointment, Start=2018.05.16 16:00, End=2018.05.16 16:30)",
// "is_stared":false,
// "subtype":"appointment_share",
// "ts":"1525875166.004600",
// "appointment":{
// "title":"New Appointment",
// "note":"",
// "location":"",
// "start_date_time":1526479200,
// "end_date_time":1526481000,
// "my_status":"A",
// "ts":"1525875166.004538",
// "accepted_participants_count":1
// }
// }
// }
// ],
//
// },
// "ok":true
//}
//
Get authorized user's email notification setting
{
"subscribe":false,
"ok":true
}
Get user presence
{
"presence": "away",
"ok": true
}
Returns info about currently authenticated user
{
"user": {
"id": "admin@icewarp.com",
"name": "admin",
"real_name": "Admin",
"deleted": false,
"color": "e7392d",
"is_admin": true,
"is_owner": false,
"is_primary_owner": false,
"is_restricted": false,
"is_ultra_restricted": false,
"has_files": true,
"is_bot": false,
"tz": "Europe/Amsterdam",
"tz_label": "Central European Time",
"tz_offset": 3600,
"profile": {
"first_name": "Admin",
"last_name": "",
"real_name": "Admin",
"real_name_normalized": "Admin",
"email": "admin@icewarp.com",
"image_24": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=24&height=24",
"image_32": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=32&height=32",
"image_48": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=48&height=48",
"image_72": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=72&height=72",
"image_192": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=192&height=192",
"image_512": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1",
"avatar_hash": "1248683088"
}
},
"ok": true
}
Returns info about selected user
{
"user": {
"id": "admin@icewarp.com",
"name": "admin",
"real_name": "Admin",
"deleted": false,
"color": "e7392d",
"is_admin": true,
"is_owner": false,
"is_primary_owner": false,
"is_restricted": false,
"is_ultra_restricted": false,
"has_files": true,
"is_bot": false,
"tz": "Europe/Amsterdam",
"tz_label": "Central Europe Standard Time",
"tz_offset": 3600,
"profile": {
"first_name": "Admin",
"last_name": "",
"real_name": "Admin",
"real_name_normalized": "Admin",
"email": "admin@icewarp.com",
"image_24": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=24&height=24",
"image_32": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=32&height=32",
"image_48": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=48&height=48",
"image_72": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=72&height=72",
"image_192": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1&resize=1&width=192&height=192",
"image_512": "https://domain/teamchatapi/files.avatar?avatarhash=1e9175ee16106b8a3b60eb3b21f8d0d21b54afd7&email=admin%40dejmek.com&internal=1",
"avatar_hash": "1248683088"
}
},
"ok": true
}
Returns list of all users or users in a particular channel
{
"members":[
{
"id":"abcd@ondrovo.cz",
"name":"abcd",
"real_name":"Abcd",
"deleted":false,
"color":"e7392d",
"is_guest":false,
"is_admin":false,
"is_owner":false,
"is_primary_owner":false,
"is_restricted":false,
"is_ultra_restricted":false,
"has_files":true,
"is_bot":false,
"tz":"",
"tz_label":"Central Europe Standard Time",
"tz_offset":7200,
"profile":{
"first_name":"Abcd",
"last_name":"",
"real_name":"Abcd",
"real_name_normalized":"Abcd",
"email":"abcd@ondrovo.cz",
"image_24":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1&resize=1&width=24&height=24",
"image_32":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1&resize=1&width=32&height=32",
"image_48":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1&resize=1&width=48&height=48",
"image_72":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1&resize=1&width=72&height=72",
"image_192":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1&resize=1&width=192&height=192",
"image_512":"https://192.168.22.52/teamchatapi/files.avatar?avatarhash=be2f0e2e751c0a7fe6a0635ac540661ae69f7423&email=abcd%40ondrovo.cz&internal=1",
"avatar_hash":"-1"
},
"presence":{
"presence":"away"
}
}
],
"cache_ts":"1528447266.000980",
"ok":true
}
Let server know that authenticated user is active
{
"ok": true
}
Sets authenticated user's details
{
"vcard":"BEGIN:VCARD VERSION:4.0 PRODID:-//IceWarp//IceWarp Server ... END:VCARD ",
"ok":true
}
Set authorized user's email notification setting
{
"ok":true
}
Sets authenticated user's presence
{
"ok": true
}