Wir verwenden Cookies, um sicherzustellen, dass wir Ihnen die bestmögliche Erfahrung auf unserer Website geben. Wenn Sie Ihren Besuch auf der Website fortsetzen, stimmen Sie der Verwendung der Cookies zu. (Weitere Informationen)

ApiTeamChat Api

TeamChat API Reference

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

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 supply to it.

Parameters
  • token : Auth token
Returns

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

2.2. auth.revoke

Revokes an access token

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

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

2.3. auth.test

Checks authentication token and tells you who you are.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

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

2.4. channels.atom.history

Returns history of given channel in rfc4287

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

2.5. channels.clone

Clones channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel to be cloned(required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

 {
   "ok":true
 }
 

2.6. channels.create

Creates a channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • name : Name of the channel (required)
  • group_folder_name : Name of the group where channel should be created (optional)
Returns

 {
   "ok":true
 }
 

2.7. channels.delete

Deletes channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : New channel
Returns

 {
   "ok":true
 }
 

2.8. channels.getNotificationsSettings

Returns if channel is subscribed by authorized user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

{
   "subscribe":false,
   "ok":true
}
 

2.9. channels.replies

Retrieve a thread of messages posted to a channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • thread_ts : ID of thread (required)(e.g. 1525337020.000060)
Returns

//   "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
//}
// 
Abstract Class - see its descendants:
TTeamchatChannelsAtomHistory

2.10. channels.info

Returns information about the channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.11. channels.invite

Invite user to the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • user : User ID (required)(e.g. user@icewarp.com)
Returns

 {
   "ok":true
 }
 

2.12. channels.join

Makes this channel active for the autheticated user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

 {
   "ok":true
 }
 

2.13. channels.kick

Removes user from the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • user : User ID (required)(e.g. user@icewarp.com)
Returns

 {
   "ok":true
 }
 

2.14. channels.leave

Makes this channel inactive for the autheticated user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

 {
   "ok":true
 }
 

2.15. channels.list

Lists all channels visible to the authorized user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

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

2.16. channels.rename

Renames channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • name : New name (required)
Returns

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

2.19. channels.getNotificationsSettings

Returns if channel is subscribed by authorized user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • subscribe : True if channel should be subscribe, false if channel should be unsubscribed (required)
Returns

{
   "ok":true
}
 

2.20. channels.setpurpose

Sets purpose of the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • purpose : Purpose of the channel (required)(e.g. This is the purpose of this channel)
  • id : Channel ID (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.21. channels.settopic

Sets topic of the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • topic : This is the topic of this channel (required)(e.g. This is the topic of this channel)
  • id : Channel ID (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.23. channels.userPermissions

Returns permissions of user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • user : User ID, authorized user by default (optional)(e.g. user@icewarp.com)
Returns

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

2.24. chat.delete

Deletes a message

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • ts : ID of message to delete (required)(e.g. 1516105757.000718)
Returns

{
   "ts": "1528449570.000077",
   "channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
   "text": "new message",
   "ok": true
}
 

2.25. chat.postMessage

Posts message to the given channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • text : Text of the message (required)
  • ts : ID of object which should be commented (optional)(e.g. 1516105757.000718)
Returns

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

2.27. chat.update

Update text of a message

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • ts : ID of message to update (required)(e.g. 1516105757.000718)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • text : New text (required)
Returns

{
   "ts": "1528449570.000077",
   "channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
   "text": "new message",
   "ok": true
}
 

2.28. events.create

Creates a new event in the channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • start : Start of the event (required)(e.g. 1528802875)
  • end : End of the event (required)(e.g. 1528876800)
  • title : Title of the event (optional)(e.g. My meeting)
  • location : Location of the event (optional)(e.g. Prague)
  • note : Event note (optional)(e.g. We will talk about important stuff)
  • tzid : Timezone ID (optional)
  • all_day : True if event should be all day, default is false (optional)
  • rcrdayrepetition : Event will be repeated every nth day (optional)(e.g. 1)
  • rcrweekrepetition : Event will be repeated every nth week (optional)(e.g. 2)
  • rcrmonthrepetition : Event will be repeated every nth month (optional)(e.g. 3)
  • rcryearrepetition : Event will be repeated every nth year (optional)(e.g. 1)
  • rcrdayofweeknumber : Days of week for that the event will be repeated, it is binary flag number (optional)(e.g. 62)
  • rcrweekofmonthnumber : Week of month for that the event will be repeated (optional)(e.g. 3)
  • rcrmonthofyearnumber : Month of year for that the event will be repeated (optional)(e.g. 7)
  • rcrenddate : End day of repetition, unix timestamp - only day is extracted out of it (optional)(e.g. 1528876800)
  • rcrcount : Count of repetitions (optional)(e.g. 10)
Returns

 {
     "ok": true
 }
 

2.29. events.delete

Deletes an event

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • ts : ID of event to delete (required)(e.g. 1528804526.000483)
Returns

 {
     "ok": true
 }
 

2.30. events.edit

Updates selected attributes of event

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • ts : ID of event to update (required)(e.g. 1528804526.000483)
  • start : Start of the event (optional)(e.g. 1528802875)
  • end : End of the event (optional)(e.g. 1528876800)
  • title : Title of the event (optional)(e.g. My meeting)
  • location : Location of the event (optional)(e.g. Prague)
  • note : Event note (optional)(e.g. We will talk about important stuff)
  • tzid : Timezone ID (optional)
  • all_day : True if event should be all day, default is false (optional)
  • rcrdayrepetition : Event will be repeated every nth day (optional)(e.g. 1)
  • rcrweekrepetition : Event will be repeated every nth week (optional)(e.g. 2)
  • rcrmonthrepetition : Event will be repeated every nth month (optional)(e.g. 3)
  • rcryearrepetition : Event will be repeated every nth year (optional)(e.g. 1)
  • rcrdayofweeknumber : Days of week for that the event will be repeated, it is binary flag number (optional)(e.g. 62)
  • rcrweekofmonthnumber : Week of month for that the event will be repeated (optional)(e.g. 3)
  • rcrmonthofyearnumber : Month of year for that the event will be repeated (optional)(e.g. 7)
  • rcrenddate : End day of repetition, unix timestamp - only day is extracted out of it (optional)(e.g. 1528876800)
  • rcrcount : Count of repetitions (optional)(e.g. 10)
Returns

 {
     "ok": true
 }
 

2.31. events.list

Lists all events in the channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.32. 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 (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • 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 (optional)
  • resize : If true then avatar will be resized (optional)
  • width,height : Integer. If all theree values are set (resize,width,height), the image is resized into .jpg file before downloading (optional)
  • skin : Name of the skin - it is used for obtaining face placeholder when the avatar is not found (optional)
Returns
  • image file (mimetype: image/jpeg, image/png)

2.33. files.comments.add

Adds comment to an existing file

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • file : ID of commented file (required)(e.g. 4cc68e2f237e)
  • comment : Text of the comment (required)
Returns

{
   "comment":{
      "id":"4cc86a85005a",
      "created":1528456812,
      "timestamp":1528456812,
      "user":"ondra@ondrovo.cz",
      "comment":"filecom",
      "channel":"",
      "is_intro":false
   },
   "ok":true
}
 

2.34. files.comments.delete

Deletes an existing file comment

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • file : ID of commented file (required)(e.g. 4cc68e2f237e)
  • id : ID of comment (required)(e.g. 4cc86a85005a)
Returns

 {
     "ok": true
 }
 

2.35. files.comments.edit

Edit file comment

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • file : ID of commented file (required)(e.g. 4cc68e2f237e)
  • id : ID of comment (required)(e.g. 4cc86a85005a)
  • comment : New text of the comment (required)
Returns

{
   "comment":{
      "id":"4cc86a85005a",
      "created":1528456812,
      "timestamp":1528456812,
      "user":"ondra@ondrovo.cz",
      "comment":"filecom",
      "channel":"",
      "is_intro":false
   },
   "ok":true
}
 

2.36. files.delete

Deletes a file

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • file : ID of commented file (required)(e.g. 4cc68e2f237e)
Returns

 {
     "ok": true
 }
 

2.37. files.download

Downloads file

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • ticket : Ticket of file (required)
Returns
  • file

2.38. files.edit

Starts editing session on given document

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • id : ID of file to edit (required)
  • deviceid : ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)
  • mode : Editor mode (0=edit 1= join read 2= independent read), default is 2 (optional)
  • attid : Filename or index of the file - used only if the file is event attachment(optional)(e.g. attachment1.png)
  • 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 (optional)
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.39. files.empty

Downloads empty file by given file type

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • filetype : Type of file you want to get ('text','spreadsheet','presentation')(required)
Returns
  • file

2.40. files.info

Returns details about file

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • file : ID of file (required)(e.g. 4cc68e2f237e)
Returns

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

2.41. files.list

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

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • user : ID of user, filter out files not uploaded by given user (optional)
  • ts_from : Timestamp, filter out files created before given timestamp (optional)
  • ts_to : Timestamp, filter out files created after given timestamp (optional)
  • count : Number of files to return per page, default=100 (optional)
  • page : Page number to return, default=1 (optional)
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.42. files.setEditingPermission

Set editing premission for user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • user : User ID (required)(e.g. chulio@ondrovo.cz)
  • session_key : Editing session ID (required)
  • permission : 0= depNone,1= depRead, 2= depWrite, 3= depAdminister (required)
Returns

 {
     "ok": true
 }
 

2.43. files.setEditingProperties

Sets document properties, right now can be only used for changing filename of empty document

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • session_key : Editing session ID (required)
  • filename : New filename of document (optional)
Returns

 {
     "ok": true
 }
 

2.44. files.stopedit

Stops editing session on given document

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • id : ID of file to edit (required)
  • deviceid : ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)
  • attid : Filename or index of the file - used only if the file is event attachment(optional)(e.g. attachment1.png)

2.45. files.upload

Uploads file to given channels

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channels : Comma separated list of channels (required)
  • file : File contents via multipart/form-data. (optional, If omitting this parameter, you must provide a content)
  • content : File contents via a POST variable.(optional, If omitting this parameter, you must provide a file)
  • filename : New name of the file (optional)
  • filetype : Type of the file, if not present filetype is recognized from extension (optional)
  • initial_comment : Initial comment of the file (optional)
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
 }
 
Abstract Class - see its descendants:
TTeamchatUsersSetInfo

2.46. groups.clone

Clones group

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel to be cloned (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

 {
   "ok":true
 }
 

2.47. groups.create

Creates a group = private channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • name : Name of the group (required)
  • group_folder_name : Name of the group where group should be created (optional)
Returns

 {
   "ok":true
 }
 

2.49. items.info

Returns info about given item

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • ts : ID of item (required)(e.g. 1516105757.000718)
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.51. 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.52. iwauthentication.logout

Deauthorizes token

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

 {
   "ok": true
 }
 

2.53. 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.54. mentions.list

Lists all mentions in the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)

2.56. notifications.register

Register device for Google or Apple notifications

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • device : Device ID (required)
  • type : Google or apple (required)
  • user : User ID, default is authorized user (optional)(e.g. user@icewarp.com)
  • custom_id : Custom ID to identify registration (optional)
  • sound : Name of notification sound (optional)
Returns

{
   "ok":true
}
 

2.57. notifications.register

Deletes all notification registrations which fullfil parameters

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • user : User ID (optional)(e.g. user@icewarp.com)
  • device : Device ID (optional)
  • type : Google or apple (optional)
  • custom_id : Custom ID to identify registration (optional)
Returns

{
   "ok":true
}
 

2.58. pins.add

Pins an item.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • global : if true, pin is global, default is false = private (required)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • file : ID of file to pin (optional)(e.g. 4ca3564f0066)
  • file_comment : ID of file comment to pin (optional)(e.g. 4ccc5839016f)
  • timestamp : ID of object to pin (optional)(e.g. 1526371234.008570)
Returns

 {
   "ok": "true"
 }
 

2.60. pins.list

Lists all pins in the channel.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.61. pins.remove

Removes pin from item.

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • global : if true, pin is global, default is false = private (required)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • file : ID of file to unpin (optional)(e.g. 4ca3564f0066)
  • file_comment : ID of file comment to unpin (optional)(e.g. 4ccc5839016f)
  • timestamp : ID of object to unpin (optional)(e.g. 1526371234.008570)
Returns

 {
   "ok": "true"
 }
 

2.62. reactions.add

Adds reaction on given message in given channnel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • name : Reaction (emoji) name (thumbsup, like, heart ..) (required)
  • file : ID of file (optional)(e.g. 4ca3564f0066)
  • file_comment : ID of file comment (optional)(e.g. 4ccc5839016f)
  • timestamp : ID of object (optional)(e.g. 1526371234.008570)
Returns

 {
     "ok": true
 }
 

2.64. reactions.get

Get reactions on specific item

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • file : ID of file (optional)(e.g. 4ca3564f0066)
  • file_comment : ID of file comment (optional)(e.g. 4ccc5839016f)
  • timestamp : ID of object (optional)(e.g. 1526371234.008570)
Returns

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

2.65. reactions.list

Gets list of reactions made by a user in a given channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • user : ID of user, show reactions from this user, default is authenticated user (optional)(e.g. user@icewarp.com)
  • count : Number of files to return per page, default=100 (optional)
  • page : Page number to return, default=1 (optional)
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.66. 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 ..) (required)
  • file : ID of file to unpin (optional)(e.g. 4ca3564f0066)
  • file_comment : ID of file comment to unpin (optional)(e.g. 4ccc5839016f)
  • timestamp : ID of object to unpin (optional)(e.g. 1526371234.008570)
Returns

 {
     "ok": true
 }
 

2.68. rtm.start

Starts real time messaging session

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

 {
     "url": "ws://your address/rtm/xoxp-61d869c74cb4e2a2b62870c1dd64355e47e0bd0cd5a7b828ed92c69cf5270954",
     "self": {
        "id": "U023BECGF",
        "name": "bobby",
        "prefs": {
            ...
        },
        "created": 1402463766,
        "manual_presence": "active"
     },
     "users": [ ... ],
     "channels": [ ... ],
     "ok": true,
 }
 

2.70. search.all

Searches for messages and files matching a query

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • query : Search query (required)(e.g. from:me before:yesterday)
Returns

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

2.74. users.getNotificationsSettings

Get authorized user's email notification setting

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • type : Type of notification to be get - daily, mention, pin or upload (required)
Returns

{
   "subscribe":false,
   "ok":true
}
 

2.75. users.getPresence

Get user presence

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • user : User ID, if not present authenticated user is used (optional)(e.g. admin@icewarp.com)
Returns

 {
     "presence": "away",
     "ok": true
 }
 

2.76. users.identity

Returns info about currently authenticated user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
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.77. users.info

Returns info about selected user

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • user : User ID (required)(e.g. admin@icewarp.com)
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 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
 }
 

2.78. users.list

Returns list of all users or users in a particular channel

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (optional)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
Returns

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

2.79. users.setActive

Let server know that authenticated user is active

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
Returns

 {
     "ok": true
 }
 

2.80. users.setInfo

Sets authenticated user's details

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • firstname : (optional)(e.g. John)
  • middlename : (optional)(e.g. Joe)
  • surname : (optional)(e.g. Newman)
  • showas : (optional)(e.g. J.Newman)
  • nickname : (optional)(e.g. Joe)
  • company : (optional)(e.g. IceWarp)
  • title : (optional)(e.g. MBA)
  • description : (optional)
  • gender : (optional)
  • profession : (optional)(e.g. HR Director)
  • department : (optional)(e.g. HR)
  • filename : (optional)
  • content : (optional)
Returns

{
   "vcard":"BEGIN:VCARD VERSION:4.0 PRODID:-//IceWarp//IceWarp Server ... END:VCARD ",
   "ok":true
}

2.81. users.setNotificationsSettings

Set authorized user's email notification setting

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • channel : ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
  • type : Type of notification to be set - daily, mention, pin or upload (required)
  • subscribe : True if selected should be subscribe, false if selected should be unsubscribed (required)
Returns

{
   "ok":true
}
 

2.82. users.setPresence

Sets authenticated user's presence

Parameters
  • token : Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
  • presence : away/auto (required)
Returns

 {
     "ok": true
 }
 

Footer text here

Footer article 1 text here, go to header

Contact us
CAPTCHA Image Reload Image
'

Kontaktieren Sie uns