TeamChat API (1.0.0)

Download OpenAPI specification:Download

API for TeamChat and common endpoints

Common

Show version of server

Responses

Response samples

200
401
404

Content type

application/json

{"version": "13.1.0.0 (2021-03-10)",
"id": "24213sdafasdfsadf234234sadf",
"ok": true
}

Checks authentication token and tells you who you are.

Request Body schema: application/json

Parameters for auth.test

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"user": "[email protected]",
"user_id": "4ebd61e43361",
"url": "/teamchatapi/auth.test",
"ok": true
}

Revokes an access token

Request Body schema: application/json

Parameters for auth.revoke

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

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

Function for testing API, It will return every argument you supply to it.

Responses

Response samples

200
401
404

Content type

application/json

{"args": {"tzid": "Europe/Amsterdam",
"token": "xoxp-4ed56c99e6862776fc52a6be85a908d1aeaa07b05b59471331e783433df6e28c",
"evn_id": "asd",
"name": "nahravkateamchat"
},
"version": "13.1.0.0 (2021-03-10)",
"authschemes": {"plain_disabled": false,
"plain": true,
"login": true,
"digestmd5": true,
"crammd5": true,
"ntlm": false,
"gssapi": false
},
"ok": true
}

Performs plain text authentication against the IceWarp server.

Request Body schema: application/json

Parameters for iwauthentication.login.plain

username required	string username of the user you want to authenticate
password required	string password of the user above
external_deviceid	string deviceid for push

Responses

Request samples

Payload

Content type

application/json

{"username": "user-id-12345",
"password": "sample_value",
"external_deviceid": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

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

Performs external OTP authentication against the IceWarp server.

Request Body schema: application/json

Parameters for iwauthentication.login.external

email required	string email of the user you want to authenticate
code required	string OTP code of the user above
external_deviceid	string deviceid for push

Responses

Request samples

Payload

Content type

application/json

{"email": "sample_value",
"code": "sample_value",
"external_deviceid": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

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

Performs plain text authentication against the IceWarp server. Used by QR code app authentication.

Request Body schema: application/json

Parameters for iwauthentication.getLogin

email required	string username of the user you want to authenticate
secret required	string password of the user above

Responses

Request samples

Payload

Content type

application/json

{"email ": "sample_value",
"secret": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Performs plain text authentication against the IceWarp server.

Request Body schema: application/json

Parameters for iwauthentication.getLoginSuccess

email

required

string

username of the user you want to authenticate

Responses

Request samples

Payload

Content type

application/json

{"email ": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Performs digest authentication against the IceWarp server. It is a two phase iteration operation.

Request Body schema: application/json

Parameters for iwauthentication.login.digest

username required	string username of the user you want to authenticate
realm required	string value returned in the first iteration response
nonce required	string value returned in the first iteration response
qop required	string value returned in the first iteration response
algorithm required	string value returned in the first iteration response
method required	string value returned in the first iteration response
nc required	string nonce count
cnonce required	string client nonce
response required	string calculated digest
uri required	string uri of the request
external_deviceid	string deviceid for push

Responses

Request samples

Payload

Content type

application/json

{"username": "user-id-12345",
"realm": "sample_value",
"nonce": "sample_value",
"qop": "sample_value",
"algorithm": "sample_value",
"method": "sample_value",
"nc": "sample_value",
"cnonce": "sample_value",
"response": "sample_value",
"uri": "sample_value",
"external_deviceid": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

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

Deauthorizes token

Request Body schema: application/json

Parameters for iwauthentication.logout

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Creates a link preview job

Request Body schema: application/json

Parameters for jobs.linkpreview

token required	string Auth token
url required	string URL to preview
id	string ID to send back in the RTM message

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"url": "https://....",
"id": 1234
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Returns information about multiple file items

Request Body schema: application/json

Parameters for multifiles.info

token required	string Auth token
list required	string List of items

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"list": "[{\"folder\":\"Documents\", \"items\":[\"64c8eae40010\", \"aaabbb\", \"ccdccd\"]},{\"folder\":\"Documents\", \"items\":[\"4567abcd\", \"xxxbbb\", \"ffdffd\"]}]"
}

Response samples

200
401
404

Content type

application/json

{"list": [{"evn_id": "64c8eae40010",
"evncomplete": "",
"evn_created": "",
"evntitle": "",
"evnlocation": "",
"evn_modified": "",
"evnrid": "",
"evnsharetype": "",
"evndescformat": "",
"evntype": ""
}
],
"ok": true
}

Get item attachments

Request Body schema: application/json

Parameters for items.getAttachments

token required	string Auth token
ts	string ID of file to download
id	string ID of item to download
channel	string ID of channel
folder	string folder path

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"ts": "1571913844.000347",
"id": "54eab70b009b",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"folder": "new.cz\\TeamChat\\556d3e2d008b"
}

Response samples

200
401
404

Content type

application/json

{"attachments": [{"name": "IMG_20221113_125906.jpg",
"type": "F",
"time": 1668547675,
"desc": "IMG_20221113_125906.jpg",
"params": "mimetype=image%2Fjpeg",
"width": 4000,
"height": 2248
},
{"name": "THUMB.jpg",
"type": "T",
"time": 1669203778,
"desc": "THUMB.jpg",
"params": "mimetype=image/jpeg",
"width": 154,
"height": 275
},
{"name": "MTHUMB.jpg",
"type": "T",
"time": 1669203780,
"desc": "MTHUMB.jpg",
"params": "mimetype=image/jpeg",
"width": 309,
"height": 551
},
{"name": "HTHUMB.jpg",
"type": "T",
"time": 1669203780,
"desc": "HTHUMB.jpg",
"params": "mimetype=image/jpeg",
"width": 619,
"height": 1103
}
],
"ok": true
}

Downloads events, tasks or notes

Request Body schema: application/json

Parameters for gw.download

token required	string Auth token
ticket required	string Ticket of file

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"ticket": "sample_value"
}

Response samples

200
401
404

Content type

application/json

null

Download avatar of given internal or external contact. If external contact is requested, it is obtained from point of view of the caller

Request Body schema: application/json

Parameters for files.avatar

token required	string Auth token
internal	string 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	string If true then avatar will be resized
width,height	string Integer. If all theree values are set (resize,width,height), the image is resized into .jpg file before downloading
skin	string Name of the skin - it is used for obtaining face placeholder when the avatar is not found
error_when_empty	boolean Default: false If true, error is returned when avatar is not set

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"internal": "sample_value",
"resize": "sample_value",
"width,height": "sample-id-12345",
"skin": "sample_value",
"error_when_empty": false
}

Response samples

200
401
404

Content type

application/json

null

Creates invitation ( ticket ) for anonymous users to be able download item as vCalendar or vContact

Request Body schema: application/json

Parameters for gw.invite

token required	string Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
id required	string ID of item to invite (required)
deviceid required	string ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)
editable	string Rights for item editing; 0 or 1
password	string Password protected - value ( optional )
expire	string Expiration of this invitation ( optional )
url_type	string ticket - internal server ticket / cloud - cloud URL

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-sample-token-12345",
"id": "sample-id-12345",
"deviceid": "sample-id-12345",
"editable": "sample_value",
"password": "sample_value",
"expire": "sample_value",
"url_type": "cloud"
}

Response samples

200
401
404

Content type

application/json

{"error": 0,
"inviteticket": "https://192.168.12.162/teamchatapi/gw.download?ticket=eJxNybsNgDAMBcBt3CHZxI.Ewitkh3wMQhRIhP0FJdfebtAEaEgML7RZvh4f1CzT.FUXum2aRaOCY1Jyo.P7WmLAyqygbkKnucZQUWVpLxscFtM_",
"ok": true
}

Deletes invitation for item

Request Body schema: application/json

Parameters for gw.uninvite

token required	string Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
id required	string ID of item to invite (required)
deviceid required	string ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-sample-token-12345",
"id": "sample-id-12345",
"deviceid": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"error": 0,
"ok": true
}

Manipulates an event or conference

Request Body schema: application/json

Parameters for events.do

token required	string Auth token
channel	string ID of channel, should be present events and not for conferences
evnid	string ID of event to delete
item required	string vCal or EAS
parameters required	string format which is sent in 'item' and action to do

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"evnid": "511f5639016d",
"item": "sample_value",
"parameters": "rfc6638=&action=edit"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Manipulates an event or conference

Request Body schema: application/json

Parameters for events.add

token required	string Auth token
channel	string ID of channel, should be present events and not for conferences
evnid	string ID of event to update
item required	string vCal or EAS

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"evnid": "511f5639016d",
"item": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an event or conference

Request Body schema: application/json

Parameters for events.delete

token required	string Auth token
channel	string ID of channel, should be present events and not for conferences
evnid required	string ID of event to delete
exception_date	string exception Julian date

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"evnid": "511f5639016d",
"exception_date": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Reply an event or conference

Request Body schema: application/json

Parameters for events.reply

token required	string Auth token
channel	string ID of channel, should be present events and not for conferences
evnid required	string ID of event to reply
exception_date	string exception Julian date
status required	string ACCEPTED\|TENTATIVE\|DECLINED

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"evnid": "511f5639016d",
"exception_date": "sample_value",
"status": "ACCEPTED"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Return vCal object of an event or conference

Request Body schema: application/json

Parameters for events.get

token required	string Auth token
evnid required	string ID of event
channel	string ID of channel, should be present events and not for conferences
exception_date	string date to specify exception in reccurence pattern

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"evnid": "511f5639016d",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"exception_date": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"vcalendar": "BEGIN:VCALENDAR VERSION:2.0 PRODID:-//IceWarp//IceWarp Server 13.1.0.0 (2020-03-10)//EN BEGIN:VTIMEZONE TZID:Europe/Amsterdam BEGIN:STANDARD TZOFFSETFROM:+0200 TZOFFSETTO:+0100 TZNAME:CET DTSTART:19701025T030000 RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=10;BYDAY=-1SU END:STANDARD BEGIN:DAYLIGHT TZOFFSETFROM:+0100 TZOFFSETTO:+0200 TZNAME:CEST DTSTART:19700329T020000 RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=3;BYDAY=-1SU END:DAYLIGHT END:VTIMEZONE BEGIN:VEVENT DESCRIPTION:1. Please join my online meeting.\n\nhttps://192.168.12.231/conference/851530360\n\nGoogle Chrome is recommended for the best experience.\n\n2. Use your microph one and speakers (VoIP) - a headset is recommended.\n----------- SUMMARY:huja UID:51649b3b002c X-SERVER-UID:51649b3b002c X-ICEWARP-MEETING:[email protected] ORGANIZER;CN=A:mailto:a@f DTSTART;TZID=Europe/Amsterdam:20201104T210000 DTEND;TZID=Europe/Amsterdam:20201104T213000 CREATED:20201104T182555Z LAST-MODIFIED:20201104T182555ZDTSTAMP:20201104T182555Z PRIORITY:0 SEQUENCE:0 CLASS:PUBLIC X-MICROSOFT-CDO-BUSYSTATUS:busy TRANSP:OPAQUE END:VEVENT END:VCALENDAR ",
"ok": true
}

Return list of all possible errors

Request Body schema: application/json

Parameters for documentation.errors

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"channel_not_found": "Channel does not exist or insufficient permissions to work with the channel",
"message_not_found": "Message does not exist or insufficient permissions to work with the message",
"file_not_found": "File does not exist or insufficient permissions to work with the file",
"user_not_found": "Account does not exist or it is not an user account but a group account",
"too_much_items": "Too much items in result (caller responsibility)",
"invalid_credentials": "Invalid credentials (caller responsibility)",
"missing_token": "Missing token parameter = not authorized (caller responsibility)",
"invalid_token": "Invalid token parameter = not authorized (caller responsibility)",
"missing_argument": "Missing required parameter (caller responsibility)",
"invalid_argument": "Invalid parameter value (caller responsibility)",
"invalid_argument_combination": "Optional parameters do not make valid combination (caller responsibility)",
"already_exists": "Cannot create the object, already exists (caller responsibility)",
"no_permission": "Insufficient permissions to perform the action",
"unexpected_error": "Unexpected error in a method, it should never happen (server responsibility)",
"method_not_exist": "Method does not exist (caller responsibility)",
"general_error": "General error launching a method, it should never happen (server responsibility)",
"system_busy": "There is no capacity to serve the request, server may be freezed (server responsibility)",
"teamchat_not_initialized": "Server is not initialized yet - try later (server responsibility)",
"teamchat_not_enabled": "TeamChat is not enabled - configuration of the server must be changed (server responsibility)",
"conferences_not_enabled": "Conferences are not enabled - configuration of the server must be changed (server responsibility)",
"search_unknown_field": "Unsupported field in search query",
"search_expected_expression": "Invalid search query syntax: expected expression",
"search_missing_in_clause": "Invalid search query syntax: missing in clause",
"search_other": "Invalid search query syntax",
"ok": true
}

Returns server unixtime

Request Body schema: application/json

Parameters for time.now

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"now": 1571913652,
"ok": true
}

proxy for clients/fooclient/links

Request Body schema: application/json

Parameters for shortUrl.links

token required	string Auth token
smarts required	string ID of short URL

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"smarts": "SXnqbvLVh"
}

Response samples

200
401
404

Content type

application/json

null

Returns info about given item

Request Body schema: application/json

Parameters for items.info

token required	string Auth token
channel	string ID of channel
folder	string Instead of channel you can use a folder id
ts required	string ID of item
id	string GW ID of item instead of TS
request_last_comment	boolean Default: false request last comment
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"folder": "sample_value",
"ts": "1571913844.000347",
"id": "g23423423",
"request_last_comment": false,
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"message": {"type": "message",
"user": "u@d",
"user_name": "U",
"text": "hello world",
"is_code_block": false,
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"attachments": [ ],
"ts": "1571913844.000347",
"created": 1571913844
},
"ok": true
}

Returns info about selected user

Request Body schema: application/json

Parameters for users.info

token required	string Auth token
user required	string User ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"user": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"user": {"id": "[email protected]",
"name": "u1",
"real_name": "sfgfsdg",
"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": "Africa/Ceuta",
"tz_label": "Central Europe Standard Time",
"tz_offset": 7200,
"profile": {"first_name": "sfgfsdg",
"last_name": "",
"real_name": "sfgfsdg",
"real_name_normalized": "sfgfsdg",
"email": "[email protected]",
"image_24": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1=1=24=24",
"image_32": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1=1=32=32",
"image_48": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1=1=48=48",
"image_72": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1=1=72=72",
"image_192": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1=1=192=192",
"image_512": "https://192.168.12.157/teamchatapi/files.avatar?avatarhash=7859d2c307279920d1a10af27380620485406d2e=u1%40new.cz=1",
"avatar_hash": "-1"
},
"presence": {"online": false
},
"conference_type": "basic",
"license_type": "standard",
"is_conference_allowed": true,
"is_recording_allowed": false,
"is_teamchat_enabled": true,
"is_webdocs_enabled": true,
"conference_param_encrypted": "e1vmNSMKc6ElB7vx00X+ijR40KHvj9Dac75/ro4UC+u2OE3uSLvLtK+LeaDXLsE2GLZ0VSxwXodhCPuZCTIvHUnr7mjAFFM9I1sUgzC5xo9Yf9tfNN2nDROrnyoSwK3n+r8kGaRq5Pdvjr9Hz8w6qhoODeWxc0Gq+NB7Exl9WMDqUEjyoG6Uf+FaQCkirlzkKZJ2rkAv3UoIHV34hC2/SGuI/1rMHbAU7B+192V2FN0cmy1CyyRBt/hxMeQ8gYipQxQkYjYZ/YaGlsDW4X/izgb9R/u5juUk8VAxSzeGFt8Ym5aKIHG83nQLpLZTeN+PDaO/zxvsrYTbyDSbQ44Vhw==|E/nz7zFWkH/R9eYdEq9IVeTDE1MEs7JXdkTB2SaZU/jGUr68gh2KwCW4AooTIOnK5aQ9aPFwnyVmQ6XOrRqcDB8kHf9tGa0G0MoDD5wIP+TT0jMrKq55QBq3erCRZXlUTucBZaXgJjmAdsSw5g6nmCf69eiuz2VrI9P9CdjZCVri/aLzRmBro/6UEkqjyYTicuo/Ver2rfaQWOcUts290M6D3cUoCz6AJzkszLrSkvhLZp3H6kTBUW9GMqGCEBqLfYo1mFD/1YHCx30OgJ9+/OUWHVSTQ3iBvpXbduLIPBun70tQxzlx5O0x36WEnjgac43gDYnuRookjdl7W0uN0Wrq/pfSoPRKGHvum9218xrMle0+wZExWlD17G8uIsl4",
"collaboration_api_url": "https://192.168.12.157/collaboration/",
"admin_emails": ["[email protected]"
]
},
"ok": true
}

Returns info about currently authenticated user

Request Body schema: application/json

Parameters for users.identity

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"user": {"id": "[email protected]",
"name": "u1",
"real_name": "Ondra Novy",
"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": "Africa/Ceuta",
"tz_label": "Central Europe Standard Time",
"tz_offset": 7200,
"profile": {"first_name": "Ondra",
"last_name": "Novy",
"real_name": "Ondra Novy",
"real_name_normalized": "Ondra Novy",
"email": "[email protected]",
"image_24": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1resize=1width=24height=24",
"image_32": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1resize=1width=32height=32",
"image_48": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1resize=1width=48height=48",
"image_72": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1resize=1width=72height=72",
"image_192": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1resize=1width=192height=192",
"image_512": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=d0eadc3028218aafdc7b18f37f9f19d85e703414email=u%40dinternal=1",
"avatar_hash": "-1"
},
"conference_type": "basic",
"is_conference_allowed": true,
"is_recording_allowed": true,
"is_teamchat_enabled": true,
"is_webdocs_enabled": true,
"conference_param_encrypted": "JLp24EiuTy09dp74va4vq5fXPHbW9eAZ454ATW8LCdX7gI2ZMfIWPlPeCzWXrE5uophDyD3FQhLXanYynMxZP0M4KaP5ExF4ZYxIY9sFskWMpQgvo67Kk7EcRPZxtlQ8ARVH35u32rurlcQFKmlCJAmhefwqAg4ZpHTaRvDH4+jgqBhjRALajvwmAdAQqUvSNWcZkwTF4YNAbyFx0Q8WOLf9/vJHcfjXyoVutO4eNQ+oDjarXAOO45c+WOneF7DzaW0QMVyBBUy8uoWjtjjX32ArTwtqs9jxABIX8cg53rN5KsDzkRER9/F1wva8HBLSdCY8B7vRu6EZpWMKdrqVmw==|4PhAn5G6wg+c67+QqarE74vuHVal7+8UE++Bp9Oxgi1IPtyvneW+IdpZ1Js3rVUUYAALX7/9VeWKXYb63YHpIlZlHpkdXkIvBbDbK6fgOLq6Nj3gMdZr8DwJWGzEnp4atpN+SyVJwtMNXbehZkaBrNKt11mmD6KbA/AxKTX7CIeSmTapbvZIeYW8ZPjhPNhcnNSIH0PFZLXiODY0p7RHcLzbavLyNy7Ugp9hYvN6gZZLN8fl/8Tbr75JqvJa5/qrXfzatuzAmGB4Xe+uxFEIi7FAxmTbyulLuTWIFtw0rKhzqHJXUqPvnSMXzUjeaIQ95bVcgPUyfAyVFQCCm6H1eug3XnHz8f5ygBIY6ksEvNWIfQKDxThNPVkzvU8ZeonDgMDHwLPH/bk=",
"admin_emails": ["[email protected]"
]
},
"ok": true
}

Uploads file to given folder

Request Body schema: application/json

Parameters for filesCenter.upload

token required	string Auth token
folder	string Default is @@upload@@
file	string File contents via multipart/form-data. (If omitting this parameter, you must provide a content)
content	string File contents via a POST variable. (If omitting this parameter, you must provide a file)
content_is_link	string File or content is a link and should be treated as such (as a document link)
link_size	string File size when content is used
filename	string New name of the file
filetype	string Type of the file, if not present filetype is recognized from extension

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "Documents",
"file": "sample_value",
"content": "sample_value",
"content_is_link": true,
"link_size": "sample_value",
"filename": "Sample Name",
"filetype": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"evn_id": "5646430b010a",
"filename": "file_dup(4).txt",
"ok": true
}

Sets authenticated user's details

Request Body schema: application/json

Parameters for users.setInfo

token required	string Auth token
vcard	string
firstname	string
middlename	string
surname	string
showas	string
nickname	string
company	string
title	string
suffix	string
description	string
gender	string
profession	string
job	string
assistant	string
manager	string
department	string
filename	string
content	string

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"vcard": "BEGIN:VCARD ....",
"firstname": "John",
"middlename": "Joe",
"surname": "Newman",
"showas": "J.Newman",
"nickname": "Joe",
"company": "IceWarp",
"title": "MBA",
"suffix": "Prof.",
"description": "sample_value",
"gender": "sample_value",
"profession": "HR Director",
"job": "sample_value",
"assistant": "sample_value",
"manager": "sample_value",
"department": "HR",
"filename": "Sample Name",
"content": "sample_value"
}

Response samples

200
401
404

Content type

application/json

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

Get user's vcard

Request Body schema: application/json

Parameters for users.getvcard

token required	string Auth token
email	string If set this user's vcard will be returned, otherwise my vcard will be returned

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"email": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

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

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

Request Body schema: application/json

Parameters for files.list

token required	string Auth token
channel	string ID of channel
folder	string Instead of channel you can use a folder id
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
sort	string Sort by a non default field
descending	string result sorting, default is true

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"folder": "sample_value",
"count": 100,
"page": 1,
"search": "sample_value",
"comment_search": false,
"sort": "sample_value",
"descending": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "Z3J1cGElNDBuZXcuY3omVGVhbUNoYXQlNUM1Mzc3OWExMjAwODE=====",
"user": "[email protected]",
"text": "file",
"subtype": "file",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1637691406.000170",
"is_followed": false,
"file_subtype": "plain",
"from_parsed": [ ],
"to_parsed": [ ],
"cc_parsed": [ ],
"bcc_parsed": [ ],
"mail_attachments": [ ],
"id": "53779a1700aa",
"name": "super screen.png",
"created": 1637691407,
"timestamp": 1637691407,
"title": "super screen.png",
"mimetype": "image/png",
"filetype": ".png",
"pretty_type": "Portable Network Graphics",
"size": 1207304,
"width": 715,
"height": 1385,
"url_private": "https://192.168.12.159/teamchatapi/super%2520screen.png?override_method=files.downloadticket=eJwtyzEOwjAMQNHT1BtgxwluBk.d2LmAmzoFIaoqgfuDBOvX.6sm5jllJsSyQNWr23O62WtIU2KRbBQQR4KiF.g,PFb8pgxND4GixEBCCK5w1,8iiGan,t69DQF7ae7bcd9WeOiSzxwFK80fztohJw__t",
"low_thumb": {"url": "https://192.168.12.159/teamchatapi/THUMB.jpg?override_method=files.downloadticket=eJwtyzEOgzAMQNHT1FvBTjAmgxdYYOgGBzBpoC1CQpT7i0pl,Xp,VvZ.5OAJMT5h0j7Z2rzsuHHDXiQYOcSKIGoH3z.uJvylALveHRVSOBJCSApvvRZBNMv7dnjU2WebYdGRYiotsoUToMEd9w__teditcounter=0",
"status": "exists",
"width": 310,
"height": 600
},
"medium_thumb": {"url": "https://192.168.12.159/teamchatapi/MTHUMB.jpg?override_method=files.downloadticket=eJwty7sOgkAQRuGncTp1,l0mwxbTSKMFHT7AsLJ4iQkB3j.aQHvyndEkxl5SBHN.ULFu8G,z9PUgjUTV5AjMNSjbjZYN14X,KdFsx4BKqwAF02D0sn1RZvdz213v7eX0nkb6WMmC3iHIP73aHgw_t",
"status": "exists",
"width": 619,
"height": 1200
},
"high_thumb": {"url": "https://192.168.12.159/teamchatapi/HTHUMB.jpg?override_method=files.downloadticket=eJwtyz0OwjAMQOHT4A2wk7qOBy,NUga2cgA39AcQUtVyf4FU1qfvTcYx9qyREMsdRusGf.fZPwfOHEXUKSAmgmIX2HacRvwlhdWOgSqpAgkhDAYP.y.C6H5uu,Z2bU7PZYKXca1ae0l9.AK6Oh2.t",
"status": "exists",
"width": 715,
"height": 1385
}
}
],
"paging": {"count": 100,
"total": 1,
"page": 1,
"pages": 1
},
"has_more": false,
"ok": true
}

TeamChat

Lists all channels visible to the authorized user

Request Body schema: application/json

Parameters for channels.list

token required	string Auth token
include_unread_count	boolean Default: false If true, info about count of unread messages in channel will be included
include_permissions	boolean Default: false If true, info about caller permission for channel will be included
collection_type	string 0 - show all channel, 1 - only active channels, 2 - only inactive channels, 3 - only channels with unread messages
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"include_unread_count": false,
"include_permissions": false,
"collection_type": "sample_value",
"warning": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"channels": [{"id": "aW50ZXJuYWwlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGM4YjRiYjgwMDVj",
"name": "CHANNEL2222",
"created": 1523431788,
"creator": "[email protected]",
"is_member": true,
"group_folder_name": "[email protected]",
"is_active": true,
"num_members": 3,
"num_members_display": 3,
"members": [{"name": "[email protected]"
},
{"name": "[email protected]"
},
{"name": "[email protected]"
}
]
}
],
"ok": true
}

Returns if channel is subscribed by authorized user

Request Body schema: application/json

Parameters for channels.getNotificationsSettings

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

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

Set channel subscription of authorized user

Request Body schema: application/json

Parameters for channels.setNotificationsSettings

token required	string Auth token
channel required	string ID of channel
subscribe required	string True if channel should be subscribe, false if channel should be unsubscribed

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"subscribe": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Set channel subscription of authorized user

Request Body schema: application/json

Parameters for channels.setLastSeenId

token required	string Auth token
channel required	string ID of channel
ts	string ts to set
id	string ID to set

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1526371234.008570",
"id": "555806c70065"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Returns if channel is subscribed by authorized user

Request Body schema: application/json

Parameters for channels.getAutoFollow

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

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

Set channel subscription of authorized user

Request Body schema: application/json

Parameters for channels.setAutoFollow

token required	string Auth token
channel required	string ID of channel
autofollow required	string True if channel should be autofollowed

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"autofollow": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Sets purpose of the channel.

Request Body schema: application/json

Parameters for channels.setpurpose

token required	string Auth token
purpose required	string Purpose of the channel
id required	string Channel ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"purpose": "This is the purpose of this channel",
"id": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

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

Removes user from the channel.

Request Body schema: application/json

Parameters for channels.kick

token required	string Auth token
channel required	string ID of channel
user required	string User ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"user": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Invite user to the channel.

Request Body schema: application/json

Parameters for channels.invite

token required	string Auth token
channel required	string ID of channel
user required	string User ID
is_admin	string Will set the user as moderator if true
comment	string Reason of invitation

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"user": "[email protected]",
"is_admin": true,
"comment": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Set/unset user as admin.

Request Body schema: application/json

Parameters for channels.setadmin

token required	string Auth token
channel required	string ID of channel
user required	string User ID
is_admin required	string Will set the user as moderator if true otherwise will remove

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"user": "[email protected]",
"is_admin": true
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Sets topic of the channel.

Request Body schema: application/json

Parameters for channels.settopic

token required	string Auth token
topic required	string This is the topic of this channel
id required	string Channel ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"topic": "This is the topic of this channel",
"id": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

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

Pins an item.

Request Body schema: application/json

Parameters for pins.add

token required	string Auth token
global required	boolean Default: false if true, pin is global else private
channel required	string ID of channel
file	string ID of file to pin
file_comment	string ID of file comment to pin
ts	string ID of object to pin

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"global": false,
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"file": "4ca3564f0066",
"file_comment": "4ccc5839016f",
"ts": "1526371234.008570"
}

Response samples

200
401
404

Content type

application/json

{"ok": "true"
}

Removes pin from item.

Request Body schema: application/json

Parameters for pins.remove

token required	string Auth token
global required	boolean Default: false if true, pin is global else private
channel required	string ID of channel
file	string ID of file to unpin
file_comment	string ID of file comment to unpin
ts	string ID of object to pin

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"global": false,
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"file": "4ca3564f0066",
"file_comment": "4ccc5839016f",
"ts": "1526371234.008570"
}

Response samples

200
401
404

Content type

application/json

{"ok": "true"
}

Returns list of all pins or pins in a particular channel

Request Body schema: application/json

Parameters for pins.list

token required	string Auth token
channel required	string ID of channel
include_public	boolean Default: true If public pins should be included
include_private	boolean Default: true If private pins should be included
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
sort	string Sort by a non default field
descending	string result sorting, default is true

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"include_public": true,
"include_private": true,
"search": "sample_value",
"comment_search": false,
"count": 100,
"page": 1,
"sort": "sample_value",
"descending": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHVibGljLWZvbGRlcnMlNDBuZXcuY3omVGVhbUNoYXQlNUM1MzcyODNhYzA3MTU",
"user": "[email protected]",
"text": "1. Please join my online meeting.<br> <br> https://192.168.12.159/conference/693432118<br> <br> Google Chrome is recommended for the best experience.<br> <br> 2. Use your microphone and speakers (VoIP) - a headset is recommended.<br> -----------<br> <div><br></div>",
"subtype": "conference",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": ["cHVibGljLWZvbGRlcnMlNDBuZXcuY3omVGVhbUNoYXQlNUM1MzcyODNhYzA3MTU"
],
"privately_pinned_when": 1637249421,
"reactions": [ ],
"created": 1637249409,
"is_followed": false,
"title": "private conf",
"location": "",
"start_date_time": 1784758620,
"end_date_time": 1637249400,
"my_status": "A",
"ts": "1637249414.001999",
"accepted_participants_count": 1,
"conference": {"meeting_id": "693432118",
"meeting_url": "https://192.168.12.159/conference/693432118",
"title": "private conf",
"organizer_parsed": [{"email": "[email protected]",
"name": "khuh"
}
],
"has_password": true,
"password": "123"
},
"attendees": [{"email": "[email protected]",
"name": "Vera Nova",
"status": "",
"is_moderator": false
},
{"email": "[email protected]",
"name": "khuh",
"status": "A",
"is_moderator": false
}
]
}
],
"paging": {"count": 100,
"total": 1,
"page": 1,
"pages": 1
},
"has_more": false,
"ok": true
}

Lists all messages in the channel where authorized user is mentioned

Request Body schema: application/json

Parameters for mentions.list

token required	string Auth token
channel required	string ID of channel
count	integer Default: 100 Number of files to return per page
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
page	integer Default: 1 Page number to return
sort	string Sort by a non default field
descending	string result sorting, default is true

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"count": 100,
"search": "sample_value",
"comment_search": false,
"page": 1,
"sort": "sample_value",
"descending": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "Z3J1cGElNDBuZXcuY3omVGVhbUNoYXQlNUM1Mzc3OTMxODAyOTY=====",
"user": "[email protected]",
"text": "ahoj @[[email protected]]",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1637688316.000729",
"created": 1637688317,
"mentioned_by": "[email protected]",
"is_followed": false
}
],
"paging": {"count": 100,
"total": 1,
"page": 1,
"pages": 1
},
"has_more": false,
"ok": true
}

Creates a channel

Request Body schema: application/json

Parameters for channels.create

token required	string Auth token
name required	string Name of the channel
group_folder_name	string Name of the group where channel should be created
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "Sample Name",
"group_folder_name": "Sample Name",
"exclude_members": true,
"include_permissions": false,
"warning": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmNTc3Mjk2MDAzMg==",
"name": "channelscreate",
"created": 1571833245,
"creator": "a@d",
"is_member": true,
"group_email": "foo@d",
"group_folder_name": "Foo",
"is_active": true,
"num_members": 2,
"num_members_display": 2,
"members": [{"name": "a@d"
},
{"name": "u@d"
}
]
},
"ok": true
}

Creates a group = private channel

Request Body schema: application/json

Parameters for groups.create

token required	string Auth token
name required	string Name of the group
users_to_invite	string IDs of users that will be invited to group after creation; list delimited by semicolon
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "Sample Name",
"users_to_invite": "[email protected];[email protected]",
"warning": "sample_value",
"exclude_members": true,
"include_permissions": false
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "cHJpdmF0ZV9kJTQwJTIzJTIzaW50ZXJuYWxzZXJ2aWNlZG9tYWluLmljZXdhcnAuY29tJTIzJTIzJlRlYW1DaGF0JTVDNGY1NzcyNWEwMDI0",
"name": "groupscreate",
"created": 1571833132,
"creator": "a@d",
"is_member": true,
"group_email": "private_d@##internalservicedomain.icewarp.com##",
"group_folder_name": "d",
"is_active": true,
"num_members": 1,
"num_members_display": 1,
"members": [{"name": "a@d"
}
]
},
"ok": true
}

Clones channel

Request Body schema: application/json

Parameters for channels.clone

token required	string Auth token
channel required	string ID of channel
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"exclude_members": true,
"include_permissions": false,
"warning": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmNTc3MmU2MDA0YQ==",
"name": "channelscreate - clone",
"created": 1571833394,
"creator": "a@d",
"is_member": true,
"group_email": "foo@d",
"group_folder_name": "Foo",
"is_active": true,
"num_members": 2,
"num_members_display": 2,
"members": [{"name": "a@d"
},
{"name": "u@d"
}
]
},
"ok": true
}

Clones group

Request Body schema: application/json

Parameters for groups.clone

token required	string Auth token
channel required	string ID of channel
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"warning": "sample_value",
"exclude_members": true,
"include_permissions": false
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "cHJpdmF0ZV9kJTQwJTIzJTIzaW50ZXJuYWxzZXJ2aWNlZG9tYWluLmljZXdhcnAuY29tJTIzJTIzJlRlYW1DaGF0JTVDNGY1NzczNzkwMDcy",
"name": "groupscreate - clone",
"created": 1571833671,
"creator": "a@d",
"is_member": true,
"group_email": "private_d@##internalservicedomain.icewarp.com##",
"group_folder_name": "d",
"is_active": true,
"num_members": 1,
"num_members_display": 1,
"members": [{"name": "a@d"
}
]
},
"ok": true
}

Deletes channel

Request Body schema: application/json

Parameters for channels.delete

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Renames channel

Request Body schema: application/json

Parameters for channels.rename

token required	string Auth token
channel required	string ID of channel
name required	string New name
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"name": "Sample Name",
"exclude_members": true,
"include_permissions": false,
"warning": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "cHJpdmF0ZV9kJTQwJTIzJTIzaW50ZXJuYWxzZXJ2aWNlZG9tYWluLmljZXdhcnAuY29tJTIzJTIzJlRlYW1DaGF0JTVDNGY1NzczNWEwMDU4",
"name": "newgroupscreate",
"created": 1571833613,
"creator": "a@d",
"is_member": true,
"group_email": "private_d@##internalservicedomain.icewarp.com##",
"group_folder_name": "d",
"is_active": true,
"num_members": 1,
"num_members_display": 1,
"members": [{"name": "a@d"
}
]
},
"ok": true
}

Remove channel from list of channels

Request Body schema: application/json

Parameters for channels.exit

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Returns permissions of the authenticated user for channel folder

Request Body schema: application/json

Parameters for folders.userPermissions

token required	string Auth token
folder required	string folder email

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "public-folders@d"
}

Response samples

200
401
404

Content type

application/json

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

Returns permissions of the authenticated user for channel

Request Body schema: application/json

Parameters for channels.userPermissions

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

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

Returns information about the channel

Request Body schema: application/json

Parameters for channels.info

token required	string Auth token
channel required	string ID of channel
warning	string if true, warning:'member_list_truncated' is present in channel object when there is more members than 300, but truncation occurs
exclude_members	boolean Default: true If true, members of channel will be missing
include_permissions	boolean Default: false If true, info about caller permission for channel will be included

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"warning": "sample_value",
"exclude_members": true,
"include_permissions": false
}

Response samples

200
401
404

Content type

application/json

{"channel": {"id": "cHJpdmF0ZV9kJTQwJTIzJTIzaW50ZXJuYWxzZXJ2aWNlZG9tYWluLmljZXdhcnAuY29tJTIzJTIzJlRlYW1DaGF0JTVDNGY1NzczNWEwMDU4",
"name": "newgroupscreate",
"created": 1571833613,
"creator": "a@d",
"is_member": true,
"group_email": "private_d@##internalservicedomain.icewarp.com##",
"group_folder_name": "d",
"is_active": true,
"num_members": 1,
"num_members_display": 1,
"members": [{"name": "a@d"
}
]
},
"ok": true
}

Adds reaction on given message in given channnel

Request Body schema: application/json

Parameters for reactions.add

token required	string Auth token
channel required	string ID of channel
name required	string Reaction (emoji) name (thumbsup, like, heart ..)
ts required	string ID of object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"name": "Sample Name",
"ts": "1526371234.008570"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Removes reaction from item

Request Body schema: application/json

Parameters for reactions.remove

token required	string Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
channel required	string ID of channel (required)(e.g. cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0)
name required	string Reaction (emoji) name (thumbsup, like, heart ..)
ts required	string ID of object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-sample-token-12345",
"channel": "channel-id-12345",
"name": "Sample Name",
"ts": "1526371234.008570"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Downloads file

Request Body schema: application/json

Parameters for files.download

token required	string Auth token
ticket required	string Ticket of file
thumbnail	boolean Default: false Request the lowest resolution of the image (if we are not getting a thunmbnail already)
password	string The password for checkiteminviterrights if available
disposition	string Preferred Content-Disposition header to return
filename	string Preferred filename to return
att	string att to request from mail
partid	string partid to request from mail
return_web_error	string If true, in case of error web page with error message will be returned
resize	boolean Default: false Request a resize of the image
width	string Resize width
height	string Resize height

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"ticket": "sample_value",
"thumbnail": false,
"password": "sample_value",
"disposition": "sample_value",
"filename": "Sample Name",
"att": "sample_value",
"partid": "sample-id-12345",
"return_web_error": "sample_value",
"resize": false,
"width": "sample-id-12345",
"height": "sample_value"
}

Response samples

200
401
404

Content type

application/json

null

Downloads file by id

Request Body schema: application/json

Parameters for files.downloadById

token required	string Auth token
ts	string ID of file to download
id	string ID of item to download
name	string name of attachment to download, if blank the primary attachment/file will be used
channel	string ID of channel, should be present events and not for conferences
folder	string Instead of channel you can use a folder id
return_web_error	boolean Default: true If true, in case of error web page with error message will be returned

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"ts": "1571913844.000347",
"id": "54eab70b009b",
"name": "0682.jpg",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"folder": "sample_value",
"return_web_error": true
}

Response samples

200
401
404

Content type

application/json

null

Downloads empty file by given file type

Request Body schema: application/json

Parameters for files.empty

token required	string Auth token
filetype required	string Type of file you want to get ('text','spreadsheet','presentation')

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"filetype": "sample_value"
}

Response samples

200
401
404

Content type

application/json

null

Creates empty file by given file type

Request Body schema: application/json

Parameters for files.createEmpty

token required	string Auth token
channel required	string ID of channel
filetype required	string Type of file you want to get ('text','spreadsheet','presentation')
name required	string Name of created file
initial_comment	string Initial comment of the file
ts	string ID of object which should be commented

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"filetype": "sample_value",
"name": "newdoc.docx",
"initial_comment": "sample_value",
"ts": "1516105757.000718"
}

Response samples

200
401
404

Content type

application/json

null

Starts editing session on given document

Request Body schema: application/json

Parameters for files.edit

token required	string Auth token
id required	string ID of file to edit
deviceid required	string ID of device, choosed by client
mode	integer Default: 2 Editor mode (0=edit 1= join read 2= independent read)
attid	string Filename or index of the file - used only if the file is event attachment
fallback	string if the editor can not be opened in the requested mode, allow to fallback to another mode, 0= fallback to join edit or independent read, 1= fallback to join read, 2= no fallback
permissions	string JSON permissions object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "sample-id-12345",
"deviceid": "sample-id-12345",
"mode": 2,
"attid": "attachment1.png",
"fallback": "sample_value",
"permissions": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"data": {"documentType": "text",
"document": {"fileType": "docx",
"key": "4a6d80d8001f76d1443d",
"title": "HG JSON API.docx",
"url": "https://domain/teamchatapi/HG%2520JSON%2520API.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
}

Stops editing session on given document

Request Body schema: application/json

Parameters for files.stopedit

token required	string Auth token
id	string ID of file to stop edit
ticket	string ticket of file to stop edit
deviceid required	string ID of device, choosed by client
attid	string Filename or index of the file - used only if the file is event attachment

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "sample-id-12345",
"ticket": "sample_value",
"deviceid": "sample-id-12345",
"attid": "attachment1.png"
}

Response samples

200
401
404

Content type

application/json

null

Set editing premission for user

Request Body schema: application/json

Parameters for files.setEditingPermission

token required	string Auth token
user required	string User ID
session_key required	string Editing session ID
permission required	string 0= depNone,1= depRead, 2= depWrite, 3= depAdminister

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"user": "[email protected]",
"session_key": "sample_value",
"permission": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

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

Request Body schema: application/json

Parameters for files.setEditingProperties

token required	string Auth token
session_key required	string Editing session ID
filename	string New filename of document

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"session_key": "sample_value",
"filename": "Sample Name"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Creates invitation ( ticket ) for anonymous users to be able join collaboration editing

Request Body schema: application/json

Parameters for files.invite

token required	string Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
ts	string ts to set
id	string ID of file to invite (required)
deviceid required	string ID of device, choosed by client,
folder	string Folder id
editable	string Rights for document editing; 0 or 1
password	string Password if protected
disable_download	string Disable download
expire	string Expiration of this invitation
url_type	string ticket - internal server ticket / cloud - cloud URL

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-sample-token-12345",
"ts": "1526371234.008570",
"id": "sample-id-12345",
"deviceid": "IceWarpChulio123Unique",
"folder": "sample_value",
"editable": "sample_value",
"password": "sample_value",
"disable_download": true,
"expire": "sample_value",
"url_type": "cloud"
}

Response samples

200
401
404

Content type

application/json

{"data": {"documentType": "text",
"document": {"fileType": "docx",
"key": "4a6d80d8001f76d1443d",
"title": "HG JSON API.docx",
"url": "https://domain/teamchatapi/HG%2520JSON%2520API.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
}

Deletes invitation for collaboration editing

Request Body schema: application/json

Parameters for files.uninvite

token required	string Auth token (required)(e.g. xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df)
id required	string ID of file to invite (required)
deviceid required	string ID of device, choosed by client, (required)(e.g. IceWarpChulio123Unique)

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-sample-token-12345",
"id": "sample-id-12345",
"deviceid": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"data": {"documentType": "text",
"document": {"fileType": "docx",
"key": "4a6d80d8001f76d1443d",
"title": "HG JSON API.docx",
"url": "https://domain/teamchatapi/HG%2520JSON%2520API.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
}

Checks if file exists

Request Body schema: application/json

Parameters for files.exists

token required	string Auth token
ticket required	string Ticket of file

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"ticket": "sample_value"
}

Response samples

200
401
404

Content type

application/json

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

Download a thumbnail or return info about an item's thumbnails

Request Body schema: application/json

Parameters for files.thumbnail

folder	string Folder id
channel	string Channel id
item	string Item id
list	string A JSON list of item IDs
download	string If download parameter is passed, thumbnail is downloaded directly
type	string high, medium, low

Responses

Request samples

Payload

Content type

application/json

{"folder": "Downloads",
"channel": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"item": "g23234234",
"list": "[\"g2342342\", \"g2134213423\"]",
"download": true,
"type": "medium"
}

Response samples

200
401
404

Content type

application/json

{"thumbnails": [{"item": "g2k932i3499f",
"status": "exists",
"name": "THUMB.png",
"url": "https://server.icewarp.com/teamchatapi/files.thumbnail?token=xoxp-d21c4ac78981c7f57006323cb4e751b9091653be1d57418a9a61066d0594d58c=Documents=g2k932i3499f=1=low",
"size": 29781,
"created": 1746168618,
"width": 276,
"height": 391,
"mimetype": "image/png"
},
{"item": "aaa",
"status": "not_exists",
"ok": false,
"error": "not_found"
}
],
"ok": true
}

Returns the list information of all attachments

Request Body schema: application/json

Parameters for files.attachments

folder required	string Folder id
id required	string Item id

Responses

Request samples

Payload

Content type

application/json

{"folder": "sample_value",
"id": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"ok": true,
"attachments": [{"name": "my_resume.docx",
"url": "https://10.0.0.25/teamchatapi/my_resume.docx?override_method=files.download=eJxNy0sOQDAQANDbzA6doS2L2YhIN3YcwDQqiE987s,S.uWNrLXSinpRlAsErnb,rMN2X.C5huvHVuDkiDCzGaEpLAwM0.eEuaD,OiaudV1TxvMxwsKUmj6k6IO8e2MbbQ__t",
"created": 1234567890
},
{"name": "HTHUMB.jpg",
"url": "https://10.0.0.25/teamchatapi/HTHUMB.jpg?override_method=files.download=eJxNy0sOQDAQANDbzA6doS2L2YhIN3YcwDQqiE987s,S.uWNrLXSinpRlAsErnb,rMN2X.C5huvHVuDkiDCzGaEpLAwM0.eEuaD,OiaudV1TxvMxwsKUmj6k6IO8e2MbbQ__t",
"created": 1234567890,
"width": 595,
"height": 842
}
]
}

Returns informations about ticket

Request Body schema: application/json

Parameters for files.invite.info

ticket required	string Ticket of file
password	string Password if protected

Responses

Request samples

Payload

Content type

application/json

{"ticket": "sample_value",
"password": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"DocName": "!MERCH BABYBENZO ONLINE! Album TRAPPIN LONELY vychází 29.5.22 - 0:00 na všech streamovacích",
"DocEditable": false,
"WebDocumentsEnabled": true,
"DocIssuer": "sfgfsdg",
"DocIssuerEmail": "[email protected]",
"DocAvatarToken": "7859d2c307279920d1a10af27380620485406d2e",
"DocExpiration": "0",
"DocPassword": false,
"DocDisableDownload": false,
"DocSize": 2134234,
"error": "",
"ok": true
}

Return past events in the room

Request Body schema: application/json

Parameters for events.history

token required	string Auth token
channel required	string ID of channel, should be present events and not for conferences

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHVibGljLWZvbGRlcnMlNDBuZXcuY3omVGVhbUNoYXQlNUM1MzZhNzQzMTAwMjc",
"user": "[email protected]",
"text": "divbr/div",
"subtype": "appointment",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"created": 1638526489,
"is_followed": false,
"title": "future event",
"location": "",
"start_date_time": 1788476400,
"end_date_time": 1640975400,
"my_status": "",
"ts": "1638526488.000020",
"accepted_participants_count": 0,
"attendees": [ ]
}
],
"ok": true
}

Return upcoming events in the room

Request Body schema: application/json

Parameters for events.upcoming

token required	string Auth token
channel required	string ID of channel, should be present events and not for conferences

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHVibGljLWZvbGRlcnMlNDBuZXcuY3omVGVhbUNoYXQlNUM1MzZhNzQzMTAwMjc",
"user": "[email protected]",
"text": "divbr/div",
"subtype": "appointment",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"created": 1638526489,
"is_followed": false,
"title": "future event",
"location": "",
"start_date_time": 1788476400,
"end_date_time": 1640975400,
"my_status": "",
"ts": "1638526488.000020",
"accepted_participants_count": 0,
"attendees": [ ]
}
],
"ok": true
}

Enable guest account and set password

Request Body schema: application/json

Parameters for activate.guest

token required	string Auth token
account required	string Guest account
password required	string New password to be set for the guest account
hash required	string Security hash
auth_type	string 0 - plain, 1 - RSA

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"account": 10,
"password": "sample_value",
"hash": "sample_value",
"auth_type": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Returns server password policy

Responses

Response samples

200
401
404

Content type

application/json

{"pass_policy_len": 6,
"pass_policy_num": 1,
"pass_policy_non_alpha_num": 0,
"pass_policy_alpha": 1,
"pass_policy_alpha_upper": 0,
"pass_policy_user_alias": true,
"ok": true
}

Returns list of users based on parameters

Request Body schema: application/json

Parameters for search.users

token required	string Auth token
channel required	string ID of channel
users	string IDs of users that are interesting for caller delimited by semicolon
query	string Query that allow complex search conditions
email_or_name	string String that should be search in email and name, only users with that search condition will be returned
users_to_exclude	string IDs of users that should not be returned delimited by semicolon
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"users": "[email protected];[email protected]",
"query": "[John in:real_name]",
"email_or_name": "Ant",
"users_to_exclude": "[email protected];[email protected]",
"count": 100,
"page": 1
}

Response samples

200
401
404

Content type

application/json

{"members": [{"id": "[email protected]",
"name": "a1",
"real_name": "Adam Nový",
"is_guest": false,
"is_admin": false,
"profile": {"first_name": "Adam",
"last_name": "Nový",
"real_name": "Adam Nový",
"real_name_normalized": "Adam Nový",
"email": "[email protected]",
"image_24": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=24=24",
"image_32": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=32=32",
"image_48": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=48=48",
"image_72": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=72=72",
"image_192": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=192=192",
"image_512": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1",
"avatar_hash": "-1"
},
"presence": {"online": false
}
}
],
"cache_ts": "1663248398.000334",
"paging": {"count": 1,
"total": 1,
"page": 1,
"pages": 1
},
"ok": true
}

Posts code block to the given channel

Request Body schema: application/json

Parameters for chat.postCodeBlock

token required	string Auth token
channel required	string ID of channel
text required	string Code block of the message
language	string Specify language of the code block
username	string Impersonate as user if sufficient permissions
ts	string ID of object which should be commented

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"text": "sample_value",
"language": "sample_value",
"username": "user-id-12345",
"ts": "1516105757.000718"
}

Response samples

200
401
404

Content type

application/json

{"ts": "1575893432.000189",
"channel": "cHVibGljLWZvbGRlcnMlNDBkJlRlYW1DaGF0JTVDNGY3NDUwY2UwMDI3",
"message": {"type": "message",
"user": "u@d",
"user_name": "U",
"text": "a=b c=d",
"subtype": "code_block",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1575893432.000189",
"created": 1575893433,
"language": "java"
},
"ok": true
}

Posts message to the given channel

Request Body schema: application/json

Parameters for chat.postMessage

token required	string Auth token
channel required	string ID of channel
text required	string Text of the message
username	string Impersonate as user if sufficient permissions
ts	string ID of object which should be commented
linkinfo	string Link info (JSON object) for the URL above
quoted_id	string Quick reply quoted ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"text": "sample_value",
"username": "user-id-12345",
"ts": "1516105757.000718",
"linkinfo": "sample_value",
"quoted_id": "sample-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"ts": "1571916484.000496",
"channel": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmNTg2OWFiMDE5Ng==============",
"message": {"type": "message",
"user": "a@d",
"user_name": "U",
"text": "message",
"is_code_block": false,
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"attachments": [ ],
"ts": "1571916484.000496",
"created": 1571916485
},
"ok": true
}

Update code block code and language

Request Body schema: application/json

Parameters for chat.updateCodeBlock

token required	string Auth token
channel required	string ID of channel
ts required	string ID of message to update
text required	string New code
username	string Impersonate as user if sufficient permissions
language	string New language

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1516105757.000718",
"text": "sample_value",
"username": "user-id-12345",
"language": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ts": "1575893126.000161",
"channel": "cHVibGljLWZvbGRlcnMlNDBkJlRlYW1DaGF0JTVDNGY3NDUwY2UwMDI3",
"text": "``` cpp ab cd ```",
"message": {"type": "message",
"user": "u@d",
"text": "ab cd ",
"subtype": "code_block",
"edited": {"user": "u@d",
"ts": 1575893587
},
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1575893126.000161",
"created": 1575893126,
"language": "cpp"
},
"ok": true
}

Update text of a message

Request Body schema: application/json

Parameters for chat.update

token required	string Auth token
channel required	string ID of channel
ts required	string ID of message to update
text required	string New text
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1516105757.000718",
"text": "sample_value",
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"ts": "1571916484.000496",
"channel": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmNTg2OWFiMDE5Ng==============",
"text": "message",
"message": {"type": "message",
"user": "a@d",
"text": "message",
"is_code_block": false,
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"attachments": [ ],
"ts": "1571916484.000496",
"created": 1571916485
},
"ok": true
}

Deletes a message

Request Body schema: application/json

Parameters for chat.delete

token required	string Auth token
channel required	string ID of channel
ts required	string ID of message to delete
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1516105757.000718",
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"ts": "1571916484.000496",
"channel": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmNTg2OWFiMDE5Ng==============",
"ok": true
}

Returns list of all users or users in a particular channel

Request Body schema: application/json

Parameters for users.list

token required	string Auth token
channel	string ID of channel
users	string IDs of users that are interesting for caller delimiter by semicolon
active_only	boolean Default: false If true, returns only active users

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"users": "[email protected];[email protected]",
"active_only": false
}

Response samples

200
401
404

Content type

application/json

{"members": [{"id": "[email protected]",
"name": "a1",
"real_name": "Adam Nový",
"is_guest": false,
"is_admin": false,
"profile": {"first_name": "Adam",
"last_name": "Nový",
"real_name": "Adam Nový",
"real_name_normalized": "Adam Nový",
"email": "[email protected]",
"image_24": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=24=24",
"image_32": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=32=32",
"image_48": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=48=48",
"image_72": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=72=72",
"image_192": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1=1=192=192",
"image_512": "https://192.168.12.109/teamchatapi/files.avatar?avatarhash=4c4fb11f571b72fb155cb143f3db520ff9597d40=a1%40new.cz=1",
"avatar_hash": "-1"
},
"presence": {"online": false
}
}
],
"cache_ts": "1663248398.000334",
"paging": {"count": 1,
"total": 1,
"page": 1,
"pages": 1
},
"ok": true
}

Get authorized user's email notification setting

Request Body schema: application/json

Parameters for users.getNotificationsSettings

token required	string Auth token
channel required	string ID of channel
type required	string Type of notification to be get - daily, mention, pin or upload

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"type": "sample_value"
}

Response samples

200
401
404

Content type

application/json

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

Set authorized user's email notification setting

Request Body schema: application/json

Parameters for users.setNotificationsSettings

token required	string Auth token
channel required	string ID of channel
type required	string Type of notification to be set - daily, mention, pin or upload
subscribe required	string True if selected should be subscribe, false if selected should be unsubscribed

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"type": "sample_value",
"subscribe": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Sets authenticated user's status

Request Body schema: application/json

Parameters for users.setStatus

token required	string Auth token
channel	string ID of channel
status required	string offline\|typing\|commenting\|online\|background\|dnd\|away
status_param	string Custom status message
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"status": "sample_value",
"status_param": "Lets talk",
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Let server know that authenticated user is typing in the channel

Request Body schema: application/json

Parameters for users.setTyping

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Get user presence

Request Body schema: application/json

Parameters for users.getPresence

token required	string Auth token
channel	string ID of channel
user	string User ID, if not present authenticated user is used
users	string IDs of users to get the presence of

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"user": "[email protected]",
"users": "[email protected];[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"online": true,
"status": "online",
"ok": true,
"user": "[email protected]"
}

Makes this channel inactive for the autheticated user

Request Body schema: application/json

Parameters for channels.leave

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Makes this channel active for the autheticated user

Request Body schema: application/json

Parameters for channels.join

token required	string Auth token
channel required	string ID of channel

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

List threads without comments

Request Body schema: application/json

Parameters for threads.list

token required	string Auth token
channel required	string ID of channel
followed	boolean Default: false If true, return only followed threads
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
count	integer Default: 100 Number of files to return per page
sort	string Sort by a non default field
page	integer Default: 1 Page number to return

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"followed": false,
"search": "sample_value",
"comment_search": false,
"count": 100,
"sort": "sample_value",
"page": 1
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ou",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652283274.000033",
"created": 1652283275,
"is_followed": true,
"last_comment": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ou5",
"thread_ts": "1652283274.000033",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652721004.000033",
"created": 1652721004,
"is_followed": false
}
},
{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ah",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652258612.000095",
"created": 1652258612,
"is_followed": true,
"last_comment": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "hth",
"thread_ts": "1652258612.000095",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652718674.000093",
"created": 1652718674,
"is_followed": false
}
}
],
"paging": {"count": 100,
"total": 2,
"page": 1,
"pages": 1
},
"has_more": false,
"lasttimestamp": 1652721940,
"ok": true
}

List unread threads without comments

Request Body schema: application/json

Parameters for threads.unreadList

token required	string Auth token
channel required	string ID of channel
followed	boolean Default: false If true, return only followed threads
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
lasttimestamp	string Last seen timestamp to determine unseen messages
count	integer Default: 100 Number of files to return per page
sort	string Sort by a non default field
page	integer Default: 1 Page number to return

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"followed": false,
"search": "sample_value",
"comment_search": false,
"lasttimestamp": 1652258586,
"count": 100,
"sort": "sample_value",
"page": 1
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ou",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652283274.000033",
"created": 1652283275,
"is_followed": true,
"last_comment": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ou5",
"thread_ts": "1652283274.000033",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652721004.000033",
"created": 1652721004,
"is_followed": false
}
},
{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ah",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652258612.000095",
"created": 1652258612,
"is_followed": true,
"last_comment": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "hth",
"thread_ts": "1652258612.000095",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652718674.000093",
"created": 1652718674,
"is_followed": false
}
}
],
"paging": {"count": 100,
"total": 2,
"page": 1,
"pages": 1
},
"has_more": false,
"lasttimestamp": 1652721940,
"ok": true
}

List all messages except thread comments

Request Body schema: application/json

Parameters for channels.historyNoComments

token required	string Auth token
channel required	string ID of channel
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
latest	string Timestamp, end of the time range for filtering messages
oldest	string Timestamp, start of the time range for filtering messages
before	string ID, filter messages before this id
after	string ID, filter messages after this id
inclusive	string Boolean, include messages = latest \| oldest timestamp
descending	string result sorting, default is true
sort	string Sort by a non default field
set_read	string set channel as read, default is true

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"search": "sample_value",
"comment_search": false,
"count": 100,
"page": 1,
"latest": "sample_value",
"oldest": "sample_value",
"before": "sample_value",
"after": "sample_value",
"inclusive": "sample_value",
"descending": "sample_value",
"sort": "sample_value",
"set_read": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ggg",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"ts": "1652721848.000024",
"created": 1652721848,
"is_followed": false
},
{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "aha",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652718606.000072",
"created": 1652718607,
"is_followed": true
}
],
"paging": {"count": 100,
"total": 2,
"page": 1,
"pages": 1
},
"has_more": false,
"lasttimestamp": 1652721940,
"ok": true
}

Create a new channel poll

Request Body schema: application/json

Parameters for polls.add

token required	string Auth token
channel required	string ID of channel
question required	string The poll question
answers required	string The poll answers as JSON string array

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"question": "Some question?",
"answers": "[\"Not good\", \"Very good\", \"Poor\"]"
}

Response samples

200
401
404

Content type

application/json

{"message": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ggg",
"subtype": "poll",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"ts": "1652721848.000024",
"created": 1652721848,
"is_followed": false
},
"ok": true,
"ts": "2131231"
}

Edit a channel poll

Request Body schema: application/json

Parameters for polls.edit

token required	string Auth token
channel required	string ID of channel
ts required	string TS of item to be edited
question required	string The poll question
answers required	string The poll answers as JSON string array

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "12q321334123",
"question": "Some question?",
"answers": "[\"Not good\", \"Very good\", \"Poor\"]"
}

Response samples

200
401
404

Content type

application/json

{"message": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI",
"user": "[email protected]",
"text": "ggg",
"subtype": "poll",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"ts": "1652721848.000024",
"created": 1652721848,
"is_followed": false
},
"ok": true,
"ts": "2131231"
}

Create a new poll vote

Request Body schema: application/json

Parameters for polls.setVote

token required	string Auth token
channel required	string ID of channel
ts required	string Poll TS
answer required	string Poll answer index (0..count - 1), -1 removes the poll

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1571913844.000347",
"answer": 1
}

Response samples

200
401
404

Content type

application/json

null

Global function to list followed threads without comments

Request Body schema: application/json

Parameters for followed.list

token required	string Auth token
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
sort	string Sort by a non default field
descending	string result sorting, default is true

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"search": "sample_value",
"comment_search": false,
"count": 100,
"page": 1,
"sort": "sample_value",
"descending": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI=",
"user": "[email protected]",
"text": "aha",
"thread_ts": "",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652718606.000072",
"created": 1652718607,
"is_followed": false,
"last_comment": {"type": "message",
"channel": "cHJpdmF0ZV9uZXcuY3olNDAlMjMlMjNpbnRlcm5hbHNlcnZpY2Vkb21haW4uaWNld2FycC5jb20lMjMlMjMmVGVhbUNoYXQlNUM1NDg1NTRkMDAwYmI=",
"user": "[email protected]",
"text": "aha5",
"thread_ts": "1652718606.000072",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1652721918.000044",
"created": 1652721919,
"is_followed": false
}
}
],
"paging": {"count": 100,
"total": 1,
"page": 1,
"pages": 1
},
"has_more": false,
"ok": true
}

Return count of new threads or threads with new activity

Request Body schema: application/json

Parameters for threads.unreadCount

token required	string Auth token
channel required	string ID of channel
lasttimestamp	string Last seen timestamp to determine unseen messages

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"lasttimestamp": 1652258586
}

Response samples

200
401
404

Content type

application/json

{"count": 2,
"ok": true
}

List thread comments

Request Body schema: application/json

Parameters for threads.comments

token required	string Auth token
channel required	string ID of channel
ts required	string thread ID
search	string Search only threads containing this string in the main message
comment_search	boolean Default: false Search also in comments
count	integer Default: 100 Number of files to return per page
sort	string Sort by a non default field
page	integer Default: 1 Page number to return

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1571913844.000347",
"search": "sample_value",
"comment_search": false,
"count": 100,
"sort": "sample_value",
"page": 1
}

Response samples

200
401
404

Content type

application/json

{"messages": [{"type": "message",
"channel": "Z3J1cGElNDBuZXcuY3omVGVhbUNoYXQlNUM1Mzc3OTY4ZjAwMjY=====",
"user": "[email protected]",
"text": "comment",
"thread_ts": "1637689956.000067",
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"ts": "1637689962.000081",
"created": 1637689963,
"is_followed": false
}
],
"ok": true
}

Follow thread

Request Body schema: application/json

Parameters for threads.follow

token required	string Auth token
channel required	string ID of channel
ts required	string thread ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1571913844.000347"
}

Response samples

200
401
404

Content type

application/json

null

Unfollow thread

Request Body schema: application/json

Parameters for threads.unfollow

token required	string Auth token
channel required	string ID of channel
ts required	string thread ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"ts": "1571913844.000347"
}

Response samples

200
401
404

Content type

application/json

null

Uploads file to given channels

Request Body schema: application/json

Parameters for files.upload

token required	string Auth token
channels required	string Comma separated list of channels
file	string File contents via multipart/form-data. (If omitting this parameter, you must provide a content)
content	string File contents via a POST variable. (If omitting this parameter, you must provide a file)
filename	string New name of the file
content_is_link	string File or content is a link and should be treated as such (as a document link)
link_size	string File size when content is used
link_folder	string Folder id when creating a document link
link_item	string Item id when creating a document link
move_link_item	string When using the link_item we can instruct the API to move the actual attachment and not creating a link. Like a temporary file upload
filetype	string Type of the file, if not present filetype is recognized from extension
initial_comment	string Initial comment of the file
username	string Impersonate as user if sufficient permissions
quoted_id	string Quick reply quoted ID
ts	string ID of object which should be commented
url_type	string ticket - internal server ticket / cloud - cloud URL

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channels": "channel-id-12345",
"file": "sample_value",
"content": "sample_value",
"filename": "Sample Name",
"content_is_link": true,
"link_size": "sample_value",
"link_folder": "sample_value",
"link_item": "sample_value",
"move_link_item": true,
"filetype": "sample_value",
"initial_comment": "sample_value",
"username": "user-id-12345",
"quoted_id": "sample-id-12345",
"ts": "1516105757.000718",
"url_type": "cloud"
}

Response samples

200
401
404

Content type

application/json

{"message": {"type": "message",
"channel": "Zm9vJTQwZCZUZWFtQ2hhdCU1QzRmMzI1YjE0MDAyZQ",
"user": "a@d",
"text": "Fotky",
"subtype": "file",
"is_code_block": false,
"reply_count": 0,
"pinned_to": [ ],
"privately_pinned_to": [ ],
"reactions": [ ],
"mentions": [ ],
"attachments": [ ],
"ts": "1571918332.000545",
"file_subtype": "plain",
"to_parsed": [ ],
"cc_parsed": [ ],
"bcc_parsed": [ ],
"mail_attachments": [ ],
"id": "4f586f5a0221",
"name": "tisa.zip",
"created": 1571918333,
"timestamp": 1571918333,
"title": "tisa.zip",
"mimetype": "application/octet-stream",
"filetype": ".zip",
"pretty_type": "ZIP compression",
"size": 4,
"url_private": "https://192.168.1.26/teamchatapi/tisa.zip?override_method=files.downloadticket=eJwNyzEOwjAMAMDX4I1iJ3ZSBk.d2PsB13UgQkio7cTr6X73VA4v92BHFISmc9hnetlxkYlbTrIQI6YA1wfsJ17WQsE5F4JNr4m4smAdGUKhKzcZS5NzkN.Ovtvw6194q7hXk7Ia,wHbUB8Fteditcounter=0"
},
"ok": true
}

Uploads a mail to a given channel

Request Body schema: application/json

Parameters for files.uploadmail

token required	string Auth token
file	string Mail contents via multipart/form-data. (If omitting this parameter, you must provide a mailbox and uid)
mailbox	string Mailbox (IMAP folder) name
uid	string UID of the message
initial_comment	string Initial comment of the mail

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"file": "sample_value",
"mailbox": "sample_value",
"uid": "sample-id-12345",
"initial_comment": "sample_value"
}

Response samples

200
401
404

Content type

application/json

null

Starts real time messaging session

Request Body schema: application/json

Parameters for rtm.start

token required	string Auth token
return_conversations	string If true then conversations.list will be returned in the response
superior	string If true then admin rights are required and RTM will monitor all messages from the system

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"return_conversations": true,
"superior": true
}

Response samples

200
401
404

Content type

application/json

{"url": "ws://192.168.1.26/rtm/xoxp-746df20fa2dd7de8fdc5f2efd0d31abbaa6d8074e6e88743a0e77f680c85d5de",
"user": {"id": "a@d",
"name": "a",
"real_name": "A",
"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": "Europe/Amsterdam",
"tz_label": "Central Europe Standard Time",
"tz_offset": 7200,
"profile": {"first_name": "A",
"last_name": "",
"real_name": "A",
"real_name_normalized": "A",
"email": "a@d",
"image_24": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1resize=1width=24height=24",
"image_32": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1resize=1width=32height=32",
"image_48": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1resize=1width=48height=48",
"image_72": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1resize=1width=72height=72",
"image_192": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1resize=1width=192height=192",
"image_512": "https://192.168.1.26/teamchatapi/files.avatar?avatarhash=e97f699699b0717111f6b2e6793f41417bcc5a1bemail=a%40dinternal=1",
"avatar_hash": "-1"
},
"presence": {"online": false
}
},
"channels": [{"id": "cHJpdmF0ZV9kJTQwJTIzJTIzaW50ZXJuYWxzZXJ2aWNlZG9tYWluLmljZXdhcnAuY29tJTIzJTIzJlRlYW1DaGF0JTVDNGYxYTc4ZjQwMTFl",
"name": "aaa",
"created": 1566824865,
"creator": "a@d",
"is_member": true,
"group_email": "private_d@##internalservicedomain.icewarp.com##",
"group_folder_name": "d",
"is_active": true,
"num_members": 2,
"num_members_display": 2,
"members": [{"name": "a@d"
},
{"name": "u@d"
}
]
}
],
"ok": true
}

Starts real time messaging session

Request Body schema: application/json

Parameters for rtm.connect

token required	string Auth token
return_conversations	string If true then conversations.list will be returned in the response
return_user	string If true then user info will be returned
return_channels	string If true then channels.info will be returned

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"return_conversations": true,
"return_user": true,
"return_channels": true
}

Response samples

200
401
404

Content type

application/json

{"url": "ws://192.168.1.26/rtm/xoxp-8eb9c005bc6c47126ef634eaa4182813e630137adefebd5512192a0491b2d6a7",
"ok": true
}

Lists all user's conversations

Request Body schema: application/json

Parameters for conversations.list

token required	string Auth token
count	string Number of files to return per page
page	string Page number to return

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"count": 10,
"page": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"conversations": [{"participants": [{"email": "[email protected]",
"name": "Maria",
"ownerid": "g1ehhq4dh008",
"status": "offline",
"status_param": ""
}
],
"timestamp": 1732716945,
"last_seen": "1732716778.33554442",
"unread_count": 0,
"id": "dXNlcmNoYXRfc2VydmljZSZnMWZkcHRidHIwMDE=",
"display": ""
},
{"participants": [{"email": "[email protected]",
"name": "",
"ownerid": "g1fdsp1gl001",
"status": "offline",
"status_param": ""
}
],
"timestamp": 1732716945,
"last_seen": "0.000000",
"unread_count": 0,
"id": "dXNlcmNoYXRfc2VydmljZSZnMWZkc3AxZ3AwMDM=",
"display": ""
}
],
"paging": {"count": 2,
"total": 2,
"page": 1,
"pages": 1
},
"ok": true
}

Returns conversation info

Request Body schema: application/json

Parameters for conversations.info

token required	string Auth token
conversation required	string Conversation id
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"conversation": 32321421341242136,
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

null

Create a new conversation

Request Body schema: application/json

Parameters for conversations.create

token required	string Auth token
emails required	string List of emails separated by semi-colon
display	string name your roster conversation
username	string Impersonate as user if sufficient permissions

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"emails": "[email protected]",
"display": "John",
"username": "user-id-12345"
}

Response samples

200
401
404

Content type

application/json

null

Delete a conversation

Request Body schema: application/json

Parameters for conversations.delete

token required	string Auth token
conversation required	string Conversation id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"conversation": 1234
}

Response samples

200
401
404

Content type

application/json

null

List conversation messages

Request Body schema: application/json

Parameters for conversations.historyNoComments

token required	string Auth token
conversation required	string Conversation id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"conversation": 1234
}

Response samples

200
401
404

Content type

application/json

null

Register device for Google or Apple notifications

Request Body schema: application/json

Parameters for notifications.register

token required	string Auth token
device required	string Device ID
type required	string Google or apple
app	string ID to determine app notifications license
sound	string Name of notification sound
message_preview	boolean Default: true If notification preview should be shown
key	string Encryption key
cipher	string Encryption cipher
imei	string Imei

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"device": "sample_value",
"type": "sample_value",
"app": "sample_value",
"sound": "sample_value",
"message_preview": true,
"key": "sample_value",
"cipher": "sample_value",
"imei": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Deletes all notification registrations which fullfil parameters

Request Body schema: application/json

Parameters for notifications.unregister

token required	string Auth token
device	string Device ID
app	string ID to determine app notifications license

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"device": "sample_value",
"app": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Set badge count to 0 of all registrations fullfills parameters condition

Request Body schema: application/json

Parameters for notifications.resetBadge

token required	string Auth token
device	string Device ID
app	string ID to determine app notifications license

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"device": "sample_value",
"app": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Receive a remote file via HTTP

Request Body schema: application/json

Parameters for http.download

token required	string Auth token
url required	string URL

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"url": "sample_value"
}

Response samples

200
401
404

Content type

application/json

null

Conference

List conferences of given type - History or Upcoming

Request Body schema: application/json

Parameters for conferences.list

token required	string Auth token
type required	string 0 - History, 1 - Upcoming
count	integer Default: 100 Number of files to return per page; applies only for type=0 (History)
page	integer Default: 1 Page number to return; applies only for type=0 (History)
days_future	integer Default: 92 How many days in future should be Upcoming conferences listed; applies only for type=1 (Upcoming)
days_future_since	integer Default: 0 How many days in future should be Upcoming conferences listed Since; applies only for type=1 (Upcoming)
day_since	string Default is today; julian time day since item should be listed, should be taken from continue_since (Upcoming)

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"type": 1,
"count": 100,
"page": 1,
"days_future": 92,
"days_future_since": 0,
"day_since": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"conferences": [{"evnid": "51236d7600f4",
"title": "upcoming",
"start_date_time": 1597836600,
"end_date_time": 1597838400,
"organizer": "         A          a@f",
"organizer_parsed": [{"email": "a@f",
"name": "A"
}
],
"created": 1597663661,
"modified": 1597663661,
"meeting_id": "753241617",
"meeting_url": "https://192.168.12.204/conference/753241617",
"note": "1. Please join my online meeting. https://192.168.12.204/conference/753241617 Google Chrome is recommended for accessing the online conference. 2. Use your microphone and speakers (VoIP) - a headset is recommended. ----------- note 2",
"server": "192.168.12.199",
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/6078a47d8e7660b8ef66dc5d",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/public/rooms/6078a47d8e7660b8ef66dc5d"
}
],
"ok": true
}

Starts meeting

Request Body schema: application/json

Parameters for conferences.meetNow

token required	string Auth token
name required	string Name of the event
password	string Meeting password
autorecording	string Conference should be recorded right after start
autolobby	string Conference should be lobby right after start
meeting_language	string Meeting language
recording_followup	string Recording followup

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "My meeting",
"password": 1234,
"autorecording": true,
"autolobby": true,
"meeting_language": "de",
"recording_followup": true
}

Response samples

200
401
404

Content type

application/json

{"conference": {"evnid": "51236d7600f4",
"title": "scheduled",
"start_date_time": 1599133380,
"end_date_time": 1599135180,
"organizer": "A a@f",
"organizer_parsed": [{"email": "a@f",
"name": "A"
}
],
"created": 1599133426,
"modified": 1599133426,
"meeting_id": "265360120",
"meeting_url": "https://192.168.12.204/conference/265360120",
"note": "a href=https://192.168.12.251/conference/265360120Conference link/a",
"server": "",
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/6078a47d8e7660b8ef66dc5d",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/public/rooms/6078a47d8e7660b8ef66dc5d"
},
"ok": true
}

Create corresponding info when user is joined to existing meeting on remote server

Request Body schema: application/json

Parameters for conferences.remoteJoined

token required	string Auth token
meeting_id required	string ID of the meeting with remote host
meeting_url required	string Url to join the meeting
organizer required	string email of organizer on the remote server
organizer_name	string name of organizer on the remote server
title required	string Title of the meeting on the remote server
recordings_uri required	string A recording service url
recordings_api_uri required	string A recording service url

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"meeting_id": "[email protected]",
"meeting_url": "sample_value",
"organizer": "[email protected]",
"organizer_name": "John Doe",
"title": "My meeting",
"recordings_uri": "sample_value",
"recordings_api_uri": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"conference": {"meeting_id": "123456789",
"meeting_url": "",
"title": "The meeting7",
"start_date_time": 1614682500,
"end_date_time": 1614684300,
"organizer_parsed": [{"email": "[email protected]",
"name": "Jan Remote"
}
],
"has_password": false,
"password": "",
"evnid": "52625eee014e",
"created": 1614682529,
"modified": 1614682529,
"note": "a href=https://192.168.12.251/conference/265360120Conference link/a",
"server": "remote.com",
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/6078a47d8e7660b8ef66dc5d",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/public/rooms/6078a47d8e7660b8ef66dc5d"
},
"ok": true
}

Create corresponding info when user is joined to existing meeting

Request Body schema: application/json

Parameters for conferences.joined

token required	string Auth token
meeting_id required	string ID of the meeting
tzid	string Timezone ID

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"meeting_id": 420304195,
"tzid": "Europe/Amsterdam"
}

Response samples

200
401
404

Content type

application/json

{"conference": {"meeting_id": "329427256",
"meeting_url": "https://192.168.12.189/conference/329427256",
"title": "sfdsf",
"start_date_time": 1614780000,
"end_date_time": 1614781800,
"organizer_parsed": [{"email": "[email protected]",
"name": "Jan Novak"
}
],
"has_password": false,
"password": "",
"evnid": "526378046844",
"created": 1614780009,
"modified": 1614780009,
"note": "1. Please join my online meeting.br br https://192.168.12.189/conference/329427256br br Google Chrome is recommended for the best experience.br br 2. Use your microphone and speakers (VoIP) - a headset is recommended.",
"server": "",
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/6078a47d8e7660b8ef66dc5d",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/public/rooms/6078a47d8e7660b8ef66dc5d"
},
"ok": true
}

Starts meeting without authentication

Request Body schema: application/json

Parameters for conferences.meetFree

name required	string Name of the event
password	string Meeting password
autorecording	string Conference should be recorded right after start
autolobby	string Conference should be lobby right after start

Responses

Request samples

Payload

Content type

application/json

{"name": "My meeting",
"password": 1234,
"autorecording": true,
"autolobby": true
}

Response samples

200
401
404

Content type

application/json

{"conference": {"meeting_id": "420304195",
"meeting_url": "https://192.168.12.231/conference/420304195",
"title": "meetfree",
"organizer": "",
"password": "secret"
},
"ok": true
}

Check if password for conference is correct (case sensitive)

Request Body schema: application/json

Parameters for conferences.checkPassword

meeting_id required	string ID of the meeting
password required	string Meeting password
token	string Auth token

Responses

Request samples

Payload

Content type

application/json

{"meeting_id": 420304195,
"password": "secret",
"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

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

Get info about meeting

Request Body schema: application/json

Parameters for conferences.info

meeting_id required	string ID of the meeting
token	string Auth token

Responses

Request samples

Payload

Content type

application/json

{"meeting_id": 420304195,
"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"conference": {"meeting_id": "584355239",
"meeting_url": "https://192.168.2.173/conference/584355239",
"title": "kour",
"start_date_time": 0,
"end_date_time": 0,
"organizer_parsed": [{"email": "[email protected]",
"name": "Ondra Novy"
}
],
"has_password": false,
"password": "",
"dynamic_link": "https://teamchatmobile.page.link/?link=https%3A%2F%2F192.168.2.173%2Fconference%2F584355239%3Fmeeting_id%3D584355239%26conference_url%3Dhttps%253A%252F%252F192.168.2.173%252Fconference%252F%26teamchatapi_url%3Dhttps%253A%252F%252F192.168.2.173%252Fteamchatapi%252Fisi=1252689833ibi=com.icewarp.teamchatMobileapn=com.icewarp.teamchatmobileafl=https://play.google.com/store/apps/details?id=com.icewarp.teamchatmobileofl=https%3A%2F%2F192.168.2.173%2Fconference%2F584355239%23desktop%3D1",
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/613877347e9339b9d2e14b22",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/api/v1/public/rooms/613877347e9339b9d2e14b22",
"remote": false
},
"ok": false
}

Get jitsi jwt

Request Body schema: application/json

Parameters for conferences.jwt

meeting_id required	string ID of the meeting
username	string user email
password	string meeting password
token	string Auth token

Responses

Request samples

Payload

Content type

application/json

{"meeting_id": 420304195,
"username": "[email protected]",
"password": "secret",
"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"jwt": {"jwt": "ezdWIiOiJjb25mZXJlbmNlLmljZXdhcnAuY29tIiwicmoZTEEJkFZlIX_1VAlNPGstNIlHKrT7KLmxkGx6ZqYSYIwseKCuZcpVS73hY",
"room_name": "[email protected]_ca0b915be2e8934bf61e2b2e681f22bd52425bb90309bcaf7bcd7f8b8bf0e53b",
"subject": "dneska planovana",
"server": "https://jwt.stage.conference.icewarp.com"
},
"ok": true
}

List all recordings for given conference

Request Body schema: application/json

Parameters for conferences.recordingList

token required	string Auth token
evn_id required	string id of conference

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"evn_id": "52325460002a"
}

Response samples

200
401
404

Content type

application/json

{"conference": {"meeting_id": "539015832",
"meeting_url": "https://192.168.12.149/conference/539015832",
"title": "Upcoming conference name",
"start_date_time": 1628154660,
"end_date_time": 1628156460,
"organizer_parsed": [{"email": "[email protected]",
"name": "Ondra Novy"
}
],
"has_password": false,
"password": "",
"evnid": "5305596c002b",
"created": 1628154685,
"modified": 1628169342,
"note": "https://192.168.12.149/conference/539015832",
"server": "",
"auto_recording": false,
"auto_lobby": false,
"recording_uri": "https://recordings.stage.conference.icewarp.com/room/610bab3c7e9339b9d2e12d41",
"recording_api_uri": "https://recordings.stage.conference.icewarp.com/api/v1/public/rooms/610bab3c7e9339b9d2e12d41",
"recording_is_available": true,
"recording_count": 1,
"recordings": [{"room_name": "539015832_192.168.12.149_84258dedd4e1a559f5d517cf5923bf23af2d3bc7",
"recording_url": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/9bhwGT7UUvmksJ1rjq235oTE0zOMXxBm_2021-08-05-09-11-54.mp4",
"expire_at": 1630833124,
"thumbnail_url": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/p8jTXcMXMfFGyEv0YWq0jDnwN2KL0Qck.jpg",
"thumbnail_url_origin": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/mcCc2XszgZ2PplT7jq8BpsucSs0JKGdC.jpg",
"thumbnail_url_mid": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/GZ3XcCt2COBHMhdC1O9O4aINFFbNwuAu.jpg",
"thumbnail_url_low": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/p8jTXcMXMfFGyEv0YWq0jDnwN2KL0Qck.jpg",
"thumbnail_url_blur": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/tPmldPuBjKrI9PZnLd5e5GzO5USP3u5w.jpg",
"recording_length": 4,
"playlist": "https://datstore.stage.recordings.icewarp.com/YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt/W3GAuMkCMvUKRYtTEICnDkdd51MGfhX9.m3u8",
"record_id": "YTK0cF7zMS7aWAIQnOpHCzF5ISHi8yFt"
}
]
},
"ok": true
}

GroupWare

List available shared accounts and public groups

Request Body schema: application/json

Parameters for groups.list

token

required

string

Auth token

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

200
401
404

Content type

application/json

{"groups": [{ }
],
"ok": true
}

Returns the folder id for a virtual folder list

Request Body schema: application/json

Parameters for folders.getvirtual

token required	string Auth token
folders required	string JSON folder list

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folders": "['g23423423','g32423423']"
}

Response samples

200
401
404

Content type

application/json

{"folder_id": "string",
"ok": true
}

List tags

Request Body schema: application/json

Parameters for tags.list

token required	string Auth token
folder	string Folder ID, use blank for global tags or folder tags if set
channel	string Use channel instead of folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0"
}

Response samples

200
401
404

Content type

application/json

{"tags": ["string"
],
"ok": true
}

List folders for me or other groups

Request Body schema: application/json

Parameters for files.folders.list

token required	string Auth token
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with
level	string Level type, "one" - one level, "*" - all levels
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "Documents",
"level": "one",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folders": [{ }
],
"ok": true
}

Get information about a folder

Request Body schema: application/json

Parameters for files.folders.info

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Create a new folder

Request Body schema: application/json

Parameters for files.folders.create

token required	string Auth token
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "NewFolder",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "g24234234"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Delete a folder

Request Body schema: application/json

Parameters for files.folders.delete

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Rename a folder

Request Body schema: application/json

Parameters for files.folders.rename

token required	string Auth token
id required	string Folder ID
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"name": "New name",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Move a folder to a different level

Request Body schema: application/json

Parameters for files.folders.move

token required	string Auth token
id required	string Folder ID
parent	string New parent folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"parent": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Edit item attachments

Request Body schema: application/json

Parameters for files.attachments.edit

token required	string Auth token
folder	string Folder ID
id required	string Item id
attachment_id required	string Attachment id
filename	string New filename
description	string New description

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"attachment_id": "name.txt",
"filename": "new.txt",
"description": "New file"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add an ACL item

Request Body schema: application/json

Parameters for files.acl.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user
permissions required	string JSON permission object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]",
"permissions": "{\"Admin\": true ...}"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an ACL item

Request Body schema: application/json

Parameters for files.acl.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

List a particular item

Request Body schema: application/json

Parameters for files.info

token required	string Auth token
folder required	string Folder ID
id required	string Item id
return_versit	integer Default: 1 Return versit
return_attachments	integer Default: 1 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"return_versit": 1,
"return_attachments": 1
}

Response samples

200
401
404

Content type

application/json

{"item": { },
"versit": "string",
"ok": true
}

List items

Request Body schema: application/json

Parameters for files.list2

token required	string Auth token
folder required	string Folder ID
descending	string result sorting, default is true
search	string Search syntax
sort	string Sort by a non default field
before	string ID, filter messages before this id
after	string ID, filter messages after this id
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
return_versit	integer Default: 0 Return versit
return_attachments	integer Default: 0 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"descending": "sample_value",
"search": "sample_value",
"sort": "sample_value",
"before": "sample_value",
"after": "sample_value",
"count": 100,
"page": 1,
"return_versit": 0,
"return_attachments": 0
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Count items

Request Body schema: application/json

Parameters for files.count

token required	string Auth token
folder required	string Folder ID
search	string Search syntax
before	string ID, filter messages before this id
after	string ID, filter messages after this id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"search": "sample_value",
"before": "sample_value",
"after": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"count": 0,
"ok": true
}

Move an item to another folder

Request Body schema: application/json

Parameters for files.move

token required	string Auth token
folder	string Source folder ID
channel	string Use source channel instead of group
id required	string Item id
list	string List of items
dest_folder	string Destination folder ID
dest_group	string Destination group
dest_channel	string Use destination channel instead of group
all_items	string Copy all items in the folder. In such case the response.items will not contain the complete list.

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"dest_folder": "g23423423",
"dest_group": "[email protected]",
"dest_channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Add a new item

Request Body schema: application/json

Parameters for files.edit2

token required	string Auth token
folder required	string Folder ID
id required	string Item id
subject	string Subject
body	string Body
is_html	string Is body html
versit	string vNote or other representation of the object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"subject": "title",
"body": "some body",
"is_html": true,
"versit": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Copy an item to another folder

Request Body schema: application/json

Parameters for files.copy

token required	string Auth token
folder	string Source folder ID
channel	string Use source channel instead of group
id required	string Item id
list	string List of items
dest_folder	string Destination folder ID
dest_group	string Destination group
dest_channel	string Use destination channel instead of group
propose_filename	string Check destination and propose new filename
all_items	string Copy all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"dest_folder": "g23423423",
"dest_group": "[email protected]",
"dest_channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"propose_filename": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Delete an item from folder

Request Body schema: application/json

Parameters for files.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
list	string List of items
no_recovery	string If true, items will not be moved to Trash and be deleted right away
all_items	string Delete all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"no_recovery": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Restore a deleted item from trash to its original folder

Request Body schema: application/json

Parameters for files.restore

token required	string Auth token
id required	string Item id
list	string List of items
folder	string Optional destination folder to restore to

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"folder": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

List file revisions

Request Body schema: application/json

Parameters for files.revision.list

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"revisions": [{ }
],
"ok": true
}

Create a new file revision

Request Body schema: application/json

Parameters for files.revision.create

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
comment	string Comment

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"comment": "Some comment"
}

Response samples

200
401
404

Content type

application/json

{"revision": { },
"ok": true
}

Delete a file revision

Request Body schema: application/json

Parameters for files.revision.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
revision_id required	string Item id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"revision_id": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Edit a file revision

Request Body schema: application/json

Parameters for files.revision.edit

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
revision_id required	string Item id
comment	string Comment

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"revision_id": "g23423423",
"comment": "Some comment"
}

Response samples

200
401
404

Content type

application/json

{"revision": { },
"ok": true
}

Revert a file revision

Request Body schema: application/json

Parameters for files.revision.revert

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
revision_id required	string Item id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"revision_id": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add an item tag

Request Body schema: application/json

Parameters for files.tags.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an item tag

Request Body schema: application/json

Parameters for files.tags.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

List folders for me or other groups

Request Body schema: application/json

Parameters for notes.folders.list

token required	string Auth token
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with
level	string Level type, "one" - one level, "*" - all levels
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "Documents",
"level": "one",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folders": [{ }
],
"ok": true
}

Get information about a folder

Request Body schema: application/json

Parameters for notes.folders.info

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Create a new folder

Request Body schema: application/json

Parameters for notes.folders.create

token required	string Auth token
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "NewFolder",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "g24234234"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Delete a folder

Request Body schema: application/json

Parameters for notes.folders.delete

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Rename a folder

Request Body schema: application/json

Parameters for notes.folders.rename

token required	string Auth token
id required	string Folder ID
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"name": "New name",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Move a folder to a different level

Request Body schema: application/json

Parameters for notes.folders.move

token required	string Auth token
id required	string Folder ID
parent	string New parent folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"parent": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

List items

Request Body schema: application/json

Parameters for notes.list

token required	string Auth token
folder required	string Folder ID
descending	string result sorting, default is true
search	string Search syntax
sort	string Sort by a non default field
before	string ID, filter messages before this id
after	string ID, filter messages after this id
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
return_versit	integer Default: 0 Return versit
return_attachments	integer Default: 0 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"descending": "sample_value",
"search": "sample_value",
"sort": "sample_value",
"before": "sample_value",
"after": "sample_value",
"count": 100,
"page": 1,
"return_versit": 0,
"return_attachments": 0
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Count items

Request Body schema: application/json

Parameters for notes.count

token required	string Auth token
folder required	string Folder ID
search	string Search syntax
before	string ID, filter messages before this id
after	string ID, filter messages after this id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"search": "sample_value",
"before": "sample_value",
"after": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"count": 0,
"ok": true
}

List a particular item

Request Body schema: application/json

Parameters for notes.info

token required	string Auth token
folder required	string Folder ID
id required	string Item id
return_versit	integer Default: 1 Return versit
return_attachments	integer Default: 1 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"return_versit": 1,
"return_attachments": 1
}

Response samples

200
401
404

Content type

application/json

{"item": { },
"versit": "string",
"ok": true
}

Add a new item

Request Body schema: application/json

Parameters for notes.add

token required	string Auth token
folder required	string Folder ID
subject	string Subject
body	string Body
is_html	string Is body html
versit	string vNote or other representation of the object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"subject": "title",
"body": "some body",
"is_html": true,
"versit": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add a new item

Request Body schema: application/json

Parameters for notes.edit

token required	string Auth token
folder required	string Folder ID
id required	string Item id
subject	string Subject
body	string Body
is_html	string Is body html
versit	string vNote or other representation of the object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"subject": "title",
"body": "some body",
"is_html": true,
"versit": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Copy an item to another folder

Request Body schema: application/json

Parameters for notes.copy

token required	string Auth token
folder	string Source folder ID
channel	string Use source channel instead of group
id required	string Item id
list	string List of items
dest_folder	string Destination folder ID
dest_group	string Destination group
dest_channel	string Use destination channel instead of group
propose_filename	string Check destination and propose new filename
all_items	string Copy all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"dest_folder": "g23423423",
"dest_group": "[email protected]",
"dest_channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"propose_filename": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Delete an item from folder

Request Body schema: application/json

Parameters for notes.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
list	string List of items
no_recovery	string If true, items will not be moved to Trash and be deleted right away
all_items	string Delete all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"no_recovery": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Restore a deleted item from trash to its original folder

Request Body schema: application/json

Parameters for notes.restore

token required	string Auth token
id required	string Item id
list	string List of items
folder	string Optional destination folder to restore to

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"folder": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Add an item tag

Request Body schema: application/json

Parameters for notes.tags.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an item tag

Request Body schema: application/json

Parameters for notes.tags.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add item attachments

Request Body schema: application/json

Parameters for notes.attachments.add

token required	string Auth token
folder	string Folder ID
id required	string Item id
file_copy	string Instead of moving the uploaded file it will preserve it and the content will be copied
link_upload_items required	string List of link items in the Upload folder to be added as attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"file_copy": 1,
"link_upload_items": "[\"g23423423\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Edit item attachments

Request Body schema: application/json

Parameters for notes.attachments.edit

token required	string Auth token
folder	string Folder ID
id required	string Item id
attachment_id required	string Attachment id
filename	string New filename
description	string New description

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"attachment_id": "name.txt",
"filename": "new.txt",
"description": "New file"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete item attachments

Request Body schema: application/json

Parameters for notes.attachments.delete

token required	string Auth token
folder	string Folder ID
id required	string Item id
attachment_ids required	string List of attachment ids to be deleted

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"attachment_ids": "[\"g23423423\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add an ACL item

Request Body schema: application/json

Parameters for notes.acl.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user
permissions required	string JSON permission object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]",
"permissions": "{\"Admin\": true ...}"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an ACL item

Request Body schema: application/json

Parameters for notes.acl.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

List folders for me or other groups

Request Body schema: application/json

Parameters for tasks.folders.list

token required	string Auth token
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with
level	string Level type, "one" - one level, "*" - all levels
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "Documents",
"level": "one",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folders": [{ }
],
"ok": true
}

Get information about a folder

Request Body schema: application/json

Parameters for tasks.folders.info

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with
list_acl	boolean Default: false Include ACL of members of the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"list_acl": false
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Create a new folder

Request Body schema: application/json

Parameters for tasks.folders.create

token required	string Auth token
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with
parent	string Parent folder to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"name": "NewFolder",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]",
"parent": "g24234234"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Delete a folder

Request Body schema: application/json

Parameters for tasks.folders.delete

token required	string Auth token
id required	string Folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g32243234",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Rename a folder

Request Body schema: application/json

Parameters for tasks.folders.rename

token required	string Auth token
id required	string Folder ID
name required	string New folder name
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"name": "New name",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

Move a folder to a different level

Request Body schema: application/json

Parameters for tasks.folders.move

token required	string Auth token
id required	string Folder ID
parent	string New parent folder ID
channel	string Use channel instead of folder
group	string Group to work with

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"parent": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"group": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"folder": { },
"ok": true
}

List items

Request Body schema: application/json

Parameters for tasks.list

token required	string Auth token
folder required	string Folder ID
descending	string result sorting, default is true
search	string Search syntax
sort	string Sort by a non default field
before	string ID, filter messages before this id
after	string ID, filter messages after this id
count	integer Default: 100 Number of files to return per page
page	integer Default: 1 Page number to return
return_versit	integer Default: 0 Return versit
return_attachments	integer Default: 0 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"descending": "sample_value",
"search": "sample_value",
"sort": "sample_value",
"before": "sample_value",
"after": "sample_value",
"count": 100,
"page": 1,
"return_versit": 0,
"return_attachments": 0
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Count items

Request Body schema: application/json

Parameters for tasks.count

token required	string Auth token
folder required	string Folder ID
search	string Search syntax
before	string ID, filter messages before this id
after	string ID, filter messages after this id

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"search": "sample_value",
"before": "sample_value",
"after": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"count": 0,
"ok": true
}

List a particular item

Request Body schema: application/json

Parameters for tasks.info

token required	string Auth token
folder required	string Folder ID
id required	string Item id
return_versit	integer Default: 1 Return versit
return_attachments	integer Default: 1 Return Attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"return_versit": 1,
"return_attachments": 1
}

Response samples

200
401
404

Content type

application/json

{"item": { },
"versit": "string",
"ok": true
}

Add a new item

Request Body schema: application/json

Parameters for tasks.add

token required	string Auth token
folder required	string Folder ID
subject	string Subject
body	string Body
is_html	string Is body html
versit	string vNote or other representation of the object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"subject": "title",
"body": "some body",
"is_html": true,
"versit": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add a new item

Request Body schema: application/json

Parameters for tasks.edit

token required	string Auth token
folder required	string Folder ID
id required	string Item id
subject	string Subject
body	string Body
is_html	string Is body html
versit	string vNote or other representation of the object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"subject": "title",
"body": "some body",
"is_html": true,
"versit": "sample_value"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Copy an item to another folder

Request Body schema: application/json

Parameters for tasks.copy

token required	string Auth token
folder	string Source folder ID
channel	string Use source channel instead of group
id required	string Item id
list	string List of items
dest_folder	string Destination folder ID
dest_group	string Destination group
dest_channel	string Use destination channel instead of group
propose_filename	string Check destination and propose new filename
all_items	string Copy all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"dest_folder": "g23423423",
"dest_group": "[email protected]",
"dest_channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"propose_filename": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Delete an item from folder

Request Body schema: application/json

Parameters for tasks.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
id required	string Item id
list	string List of items
no_recovery	string If true, items will not be moved to Trash and be deleted right away
all_items	string Delete all items in the folder

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"no_recovery": true,
"all_items": true
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Restore a deleted item from trash to its original folder

Request Body schema: application/json

Parameters for tasks.restore

token required	string Auth token
id required	string Item id
list	string List of items
folder	string Optional destination folder to restore to

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"id": "g23423423",
"list": "[\"g23423423\", \"g22321342\"]",
"folder": "g23423423"
}

Response samples

200
401
404

Content type

application/json

{"items": [{ }
],
"ok": true
}

Add an item tag

Request Body schema: application/json

Parameters for tasks.tags.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an item tag

Request Body schema: application/json

Parameters for tasks.tags.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
tag required	string Item id
tags	string JSON list of tags instead of tag property

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"tag": "tag1",
"tags": "[\"tag1\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add item attachments

Request Body schema: application/json

Parameters for tasks.attachments.add

token required	string Auth token
folder	string Folder ID
id required	string Item id
file_copy	string Instead of moving the uploaded file it will preserve it and the content will be copied
link_upload_items required	string List of link items in the Upload folder to be added as attachments

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"file_copy": 1,
"link_upload_items": "[\"g23423423\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Edit item attachments

Request Body schema: application/json

Parameters for tasks.attachments.edit

token required	string Auth token
folder	string Folder ID
id required	string Item id
attachment_id required	string Attachment id
filename	string New filename
description	string New description

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"attachment_id": "name.txt",
"filename": "new.txt",
"description": "New file"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete item attachments

Request Body schema: application/json

Parameters for tasks.attachments.delete

token required	string Auth token
folder	string Folder ID
id required	string Item id
attachment_ids required	string List of attachment ids to be deleted

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"id": "g23423423",
"attachment_ids": "[\"g23423423\"]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Add an ACL item

Request Body schema: application/json

Parameters for tasks.acl.add

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user
permissions required	string JSON permission object

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]",
"permissions": "{\"Admin\": true ...}"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}

Delete an ACL item

Request Body schema: application/json

Parameters for tasks.acl.delete

token required	string Auth token
folder	string Folder ID
channel	string Use channel instead of folder
email required	string Email of the user

Responses

Request samples

Payload

Content type

application/json

{"token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
"folder": "g23423423",
"channel": "cHVibGljLWZvbGRlcnMlNDBvbmRyb3ZvLmN6JlRlYW1DaGF0JTVDNGMzMTdhZmEyMzk0",
"email": "[email protected]"
}

Response samples

200
401
404

Content type

application/json

{"ok": true
}