Für die Auswertung der Aktivitäten und die Besuche verwenden wir Cookies. Wir sammeln aber keine sensible oder private Daten.

ApiTeamChat Api

TeamChat API Reference

IceWarp provides real-time messaging API for external integration.

he 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

1.1. Getting Started

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

2. Methods

2.1. api.test

function for testing API, It will return every argument you supplied to it.

Returns

  {
     "args": {
        your arguments
     },
     "ok": true
  }
 

2.2. auth.revoke

Revokes an access token

Parameters
  • token : Auth token
Returns

 {
   "revoked": "true",
   "ok": true
 }
 

2.3. auth.test

Checks authentication and tells you who you are.

Returns

 {
    "user": "admin@icewarp.com",
    "user_id": "admin@icewarp.com",
    "url": "/teamchatapi/auth.test",
    "ok": true
 }
 

2.4. channels.atom.history

returns channel's history in https://tools.ietf.org/html/rfc4287

Parameters
  • token :
  • channel : Id of channel
Returns

2.5. channels.create

Creates new channel.

Parameters
  • token : security token
  • name : new channel
Returns

 {
   "channel":{
     "id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1QzRhNmE4MjE4MDAxNg==",
     "name":"new channel",
     "created":1489159009,
     "creator":"public-folders@icewarp.com",
     "is_archived":false,
     "is_member":true,
     "num_members":1,
     "members":[
       "member@icewarp.com"
     ]
   },
   "ok":true
 }
 

2.6. channels.history

returns history of given channel

Parameters
  • token : Auth token
  • channel : ID of channel
  • unreads : boolean, shows unread_count_display in response (optional)
  • count : number of messages to display (otpional, deafault = 100)
  • 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
Returns

 {
     "messages": [
                                    {...}
                                    ],
     "latest": "1487842678.048516",
     "oldest": "1487776212.046607",
     "has_more": false,
     "ok": true
 }
 
Abstract Class - see its descendants:
TTeamchatChannelsAtomHistory

2.7. channel.info

Returns information about the channel

Parameters
  • token : security token
  • channel : channel id
Returns

 {
   "channel":{
     "id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1QzRhNmE4MjE4MDAxNg==",
     "name":"new name",
     "created":1489159009,
     "creator":"public-folders@icewarp.com",
     "is_archived":false,
     "is_member":true,
     "num_members":1,
     "members":[
       "member@icewarp.com"
     ]
   },
   "ok":true
 }
 

2.9. channels.join

Joins account associated with a token to the channel

Parameters
  • token : security token
  • channel : channel id
Returns

 {
   "ok":true
 }
 

2.10. channels.kick

Removes user from the channel.

Parameters
  • token : security token
  • channel : channel id
  • user : email address
Returns

 {
   "ok":true
 }
 

2.11. channels.leave

Leaves account associated with a token to the channel

Parameters
  • token : security token
  • channel : channel id
Returns

 {
   "ok":true
 }
 

2.12. channels.list

Lists all channels assigned to the user, based on the supplied token.

Parameters
  • token : security token
Returns

{
  "channels":[
    {
      "id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0",
      "name":"TeamChat",
      "created":1488276009,
      "creator":"public-folders@icewarp.com",
      "is_archived":false,
      "is_member":true,
      "num_members":2,
      "members":[
        "somemember@icewarp.com",
        "other@icewarp.com"
      ]
    }
  ],
  "ok":true
 }
 

2.13. channels.rename

Renames channel

Parameters
  • token : security token
  • channel : channel id
  • name : new name
Returns

 {
   "channel":{
     "id":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1QzRhNmE4MjE4MDAxNg==",
     "name":"new name",
     "created":1489159009,
     "creator":"public-folders@icewarp.com",
     "is_archived":false,
     "is_member":true,
     "num_members":1,
     "members":[
       "member@icewarp.com"
     ]
   },
   "ok":true
 }
 

2.15. channels.setpurpose

Sets purpose of the channel.

Parameters
  • token : security token
  • purpose : This is the purpose of this channel
  • id : channel id
Returns

 {
  "purpose":"This is the purpose of this channel",
  "ok":true
 }
 

2.16. channels.settopic

Sets topic of the channel.

Parameters
  • token : security token
  • topic : This is the topic of this channel
  • id : channel id
Returns

 {
   "topic":"This is the topic of this channel",
   "ok":true
 }
 

2.18. chat.delete

delete specific message

Parameters
  • token : Auth token
  • channel : ID of channel
  • ts : timespamp of message being deleted
Returns

 {
     "ts": "1489314228.047812",
     "channel": "ZnVsbC1wcmVtaXNzaW9ucyU0MGRlam1lay5jb20mVGVhbUNoYXQlNUM0YTZjNTk3YzAwMWY",
     "ok": true
 }
 

2.19. chat.postMessage

Posts message to the given channel

Parameters
  • token : Auth token
  • channel : ID of channel
  • text : text of message
Returns

 {
     "ts": "1489314228.047812",
     "channel": "ZnVsbC1wcmVtaXNzaW9ucyU0MGRlam1lay5jb20mVGVhbUNoYXQlNUM0YTZjNTk3YzAwMWY",
     "message": {
         "type": "message",
         "user": "admin@icewarp.com",
         "text": "message text",
         "ts": "1489314228.047812",
         "is_stared": false
     },
     "ok": true
 }
 

2.21. chat.update

update specific message

Parameters
  • token : Auth token
  • ts : Timestamp of message to update
  • channel : ID of channel
  • text : new text
Returns

 {
     "ts": "1489314228.047812",
     "channel": "ZnVsbC1wcmVtaXNzaW9ucyU0MGRlam1lay5jb20mVGVhbUNoYXQlNUM0YTZjNTk3YzAwMWY",
     "text": "new text",
     "ok": true
 }
 

2.22. 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
  • avatarhash : special token which allows just to get avatar of one special email
  • email : email of the contact we want to get avatar of
  • 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.
Returns
  • image file (mimetype: image/jpeg, image/png)

2.23. files.comments.add

Add comment on file

Parameters
  • token : Auth token
  • file : ID of file
  • comment : text of the comment
Returns

 {
     "comment": {
         "id": "4a6d737001e2",
         "created": 1489411654,
         "timestamp": 1489411654,
         "user": "admin@icewarp.com",
         "comment": "comment on file",
         "channel": "",
         "is_intro": false
     },
     "ok": true
 }
 

2.24. files.comments.delete

Delete comment

Parameters
  • token : Auth token
  • file : ID of file
  • id : ID of comment
Returns

 {
     "ok": true
 }
 

2.25. files.comments.edit

Edit comment

Parameters
  • token : Auth token
  • file : ID of file
  • id : ID of comment
  • commant : new text of the comment
Returns

 {
     "comment": {
         "id": "4a6d737001e2",
         "created": 1489411654,
         "timestamp": 1489411830,
         "user": "admin@dejmek.com",
         "comment": "comment on file edited",
         "channel": "",
         "is_intro": false
     },
     "ok": true
 }
 

2.26. files.delete

delete file by ID

Parameters
  • token : Auth token
  • file : File ID
Returns

 {
     "ok": true
 }
 

2.27. files.download

downloads file

Parameters
  • ticket : ticket of file
Returns
  • file

2.28. files.edit

Prepares webdocuments session and returns info needed to start online editing in browser

Parameters
  • token : Auth token
  • id, timestamp : one of these is necessary to identify the file (unless you want to edit new empty file. In that case you need to specify doctype and folder )
  • deviceid : identifies the used device
  • mode : required editor mode (0=edit 1= join read 2= independent read)
  • 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 fallbak)
  • doctype : (o=text 1= spreadsheet 2= presentation)
Returns

 {
     "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
 }
 

2.29. files.empty

Downloads empty file by given file type

Parameters
  • filetype : type of file you want to get ('text','spreadsheet','presentation')
Returns
  • file

2.30. files.info

returns file detail

Parameters
  • token : Auth token
  • file : ID of file
  • count :
  • page :
Returns

 {
     "file": {
         "id": "4a6a875cae79",
         "name": "11439.png",
         "created": 1489161537,
         "timestamp": 1489161537,
         "title": "11439.png",
         "mimetype": "F",
         "filetype": ".png",
         "pretty_type": "Portable Network Graphics",
         "user": "admin@icewarp.com",
         "mode": "hosted",
         "editable": false,
         "is_external": false,
         "external_type": "",
         "username": "",
         "size": 2413299,
         "url_private": "https://",
         "url_private_download": "https://",
         "permalink": "https://",
         "permalink_public": "https://",
         "is_public": true,
         "public_url_shared": true,
         "display_as_bot": false,
         "comments_count": 0,
         "channels": [
             ""
         ],
         "initial_comment": {
             "id": "inicomid_4a6a875cae79",
             "created": 1489161537,
             "timestamp": 1489161537,
             "user": "admin@icewarp.com",
             "comment": "",
             "channel": "",
             "is_intro": true
         }
     },
     "paging": {
         "count": 0,
         "total": 0,
         "page": 1,
         "pages": 0
     },
     "ok": true
 }
 

2.31. files.list

Gets list of files on given channel, filtered by optional arguments

Parameters
  • token : Auth token
  • channel : ID of channel
  • user : ID of user, filter out files not uploaded by given user
  • ts_from : timestamp, filter out files created before given timestamp
  • ts_to : timestamp, filter out files created after given timestamp
  • count : number, number of files to return per page (default=100)
  • page : number, page number to return (default=1)
Returns

 {
     "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
 }
 

2.32. files.seteditingpermission

set editing premission for user

Parameters
  • token : Auth token
  • session_key : Editing session ID
  • user : User id/email
  • permission : 0= depNone,1= depRead, 2= depWrite, 3= depAdminister
Returns

 {
     "ok": true
 }
 

2.33. 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 (used when editing was started with nonexisting document)
Returns

 {
     "ok": true
 }
 

2.34. files.stopedit

stop editing document

Parameters
  • id, timestamp : one of these is necessary to identify the file
  • deviceid : identifies the used device

2.35. files.upload

Upload file to given channels

Parameters
  • token : Auth token
  • channels : comma separated list of channels
  • file : File contents via multipart/form-data. (If omitting this parameter, you must provide a content)
  • content : File contents via a POST variable. (If omitting this parameter, you must provide a file)
  • filename : new name of the file
Returns

 {
     "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
 }
 

2.37. im.close

Close active im channel

Parameters
  • token : Auth token
  • channel : ID of IM channel
Returns

 {
     "ok": true
 }
 

2.39. im.list

get list of active ims

Parameters
  • token : Auth token
Returns

 {
     "ims": [
         {
             "id": "DBWMGHFUSTVBC",
             "is_im": "true",
             "user": "test@icewarp.com",
             "is_user_deleted": "false",
             "created": 1489410868
         }
     ],
     "ok": true
 }
 

2.40. im.open

Opens direct channel to another user.

Parameters
  • token : Auth token
  • channel : ID of channel
  • user : ID/Email of user
  • return_im : if true whole IM channel object will be returned in response as channel property
Returns

 {
     "id": "DBWMGHFUSTVBC",
     "already_open": "true",
     "channel": {
         "id": "dGVzdC1ncnVwJTQwZGVqbWVrLmNvbSZUZWFtQ2hhdCU1QzRhNTY4MTQ2YjVmMQ==",
         "name": "test",
         "created": 1487776212,
         "creator": "test-grup@icewarp.com",
         "is_archived": false,
         "is_member": true,
         "num_members": 2,
         "members": [
             "admin@icewarp.com",
             "test@icewarp.com"
         ]
     },
     "ok": true
 }
 

2.41. items.info

returns info about given item

Parameters
  • token : Auth token
  • channel : ID of channel where is item located
  • ts : ts of item
Returns

 {
     "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
 }
 

2.43. 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
Returns

 {
   "realm":"realm",
   "qop":"auth",
   "nonce":"c05999c2a652f836750e7d45ca3b8ed2ad11ec752f381e0ff414ba5c5456ba61",
   "algorithm":"MD5-Sess",
   "method":"authenticate",
   "authorized":"false",
   "ok":true
 }
 

 {
   "authorized":"true",
   "token":"xoxp-44e14e77c260e58b4c5174e79ee05c7cfa5fffb4174e55cf46390e41f2dad209",
   "ok":true
 }
 

2.44. iwauthentication.logout

Deauthorizes token

Parameters
  • token : authorizationToken
Returns

 {
   "ok": true
 }
 

2.45. 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":"true"
   "token":"xoxp-44e14e77c260e58b4c5174e79ee05c7cfa5fffb4174e55cf46390e41f2dad209",
   "ok":true
 }
 

2.47. pins.add

Pins item.

Parameters
  • token : security token
  • global : if true, pin is global
  • channel : channel id
  • file : file name
  • file_comment : id of file comment
  • timestamp : time of item
Returns

 {
   "ok": "true"
 }
 

2.49. pins.list

Lists all pins in the channel.

Parameters
  • token : security token
  • channel : channel id
Returns

{
  "items":[
    {
      "type":"message",
      "user":"member@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":"member@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":"member@icewarp.com",
          "comment":"",
          "channel":"cHVibGljLWZvbGRlcnMlNDB0LmNvbSZUZWFtQ2hhdCU1Q1RlYW1DaGF0",
          "is_intro":true
        }
      }
    }
  ],
  "ok":true
 }
 

2.50. pins.remove

Removes pin from item.

Parameters
  • token : security token
  • channel : channel id
  • file : file name
  • file_comment : id of file comment
  • timestamp : time of item
Returns

 {
   "ok": "true"
 }
 

2.51. reactions.add

add reaction on given message in given channnel

Parameters
  • token : Auth token
  • channel : ID of channel
  • timestamp : timestamp of message
  • name : name of reaction (thumbsup, angry, laughing, ...)
Returns

 {
     "ok": true
 }
 

2.53. reactions.get

get reactions on specific item

Parameters
  • token : Auth token
  • channel : ID of channel
  • timestamp : ts of message
Returns

 {
     "type": "message",
     "reactions": [
         {
             "name": "thumbsup",
             "count": 1,
             "users": [
                 "admin@icewarp.com"
             ]
         },
         {
             "name": "disappointed",
             "count": 1,
             "users": [
                 "test@icewarp.com"
             ]
         }
     ],
     "ok": true
 }
 

2.54. reactions.list

get list of reactions in given channel

Parameters
  • token : Auth token
  • channel : Id of channel
  • user : id of user, show reactions from this user (default: authenticated user)
  • count : number of items on page
  • page : specific page number
Returns

 {
     "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
 }
 

2.55. reactions.remove

remove reaction from item

Parameters
  • token : Auth token
  • channel : id of channel
  • timestamp : ts of item
Returns

 {
     "ok": true
 }
 

2.56. rtm.start

Start real time messaging session

Returns

 {
     "url": "ws://your address/rtm/xoxp-61d869c74cb4e2a2b62870c1dd64355e47e0bd0cd5a7b828ed92c69cf5270954",
     "ok": true
 }
 

2.57. search.all

search in files and messages of given channel

Parameters
  • token : Auth token
  • channel : ID of channel
  • query : search query
Returns

 {
     "query": "test",
     "messages": {
         "total": 4,
         "paging": {
             "count": 4,
             "total": 4,
             "page": 1,
             "pages": 1
         },
         "pagination": {
             "total_count": 4,
             "page": 1,
             "per_page": 20,
             "page_count": 1,
             "first": 1,
             "last": 4
         },
         "matches": [
                                    {...},
                                    {...},
                                    {...},
                                    {...}
                                    ]
     },
     "files": {
         "total": 4,
         "paging": {
             "count": 4,
             "total": 4,
             "page": 1,
             "pages": 1
         },
         "pagination": {
             "total_count": 4,
             "page": 1,
             "per_page": 20,
             "page_count": 1,
             "first": 1,
             "last": 4
         },
         "matches": [
                                    {...},
                                    {...},
                                    {...},
                                    {...}
                                    ]
     },
     "ok": true
 }
 

2.58. search.files

search in files of given channel

Parameters
  • token : Auth token
  • channel : ID of channel
  • query : search query
Returns

 {
     "query": "test",
     "files": {
         "total": 4,
         "paging": {
             "count": 4,
             "total": 4,
             "page": 1,
             "pages": 1
         },
         "pagination": {
             "total_count": 4,
             "page": 1,
             "per_page": 20,
             "page_count": 1,
             "first": 1,
             "last": 4
         },
         "matches": [
                                    {...},
                                    {...},
                                    {...},
                                    {...}
                                    ]
     },
     "ok": true
 }
 

2.60. search.messages

search in messages of given channel

Parameters
  • token : Auth token
  • channel : ID of channel
  • query : search query
Returns

 {
     "query": "test",
     "messages": {
         "total": 4,
         "paging": {
             "count": 4,
             "total": 4,
             "page": 1,
             "pages": 1
         },
         "pagination": {
             "total_count": 4,
             "page": 1,
             "per_page": 20,
             "page_count": 1,
             "first": 1,
             "last": 4
         },
         "matches": [
                                    {...},
                                    {...},
                                    {...},
                                    {...}
                                    ]
     },
     "ok": true
 }
 

2.62. users.getPresence

get users presence on given channel

Parameters
  • token : Auth token
  • channel : ID of channel
Returns

 {
     "presence": "active",
     "last_activity": 1489410930,
     "online": "true",
     "connection_count": "1",
     "ok": true
 }
 

2.63. users.identity

Returns user_object of currently authenticated user

Parameters
  • token : Auth token
Returns

 {
     "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
 }
 

2.64. users.info

returns user_object by given user ID

Parameters
  • token : Auth token
  • user : User ID/Email
Returns

 {
     "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
 }
 

2.65. users.list

Returns list of users filtered by optional arguments

Parameters
  • token : Auth token
  • channel : ID of channel
Returns

 {
     "members": [
         { user_object }
     ],
     "cache_ts": "1489405126.000369",
     "ok": true
 }
 

2.66. users.setActive

Let server know that authenticated user is active

Parameters
  • token : Auth token
  • channel : ID of channel
Returns

 {
     "ok": true
 }
 

2.67. users.setPresence

Sets user's presence

Parameters
  • token : Auth token
  • channel : ID of channel
  • presence : away/auto
Returns

 {
     "ok": true
 }
 
Contact us
CAPTCHA Image Reload Image
'

Kontaktieren Sie uns