WApi Interface

---

auth.user.Login

Used to login a user and retrieve an access token

The account must be valid and the user must be activated

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_name - string Optional: ""

Body Data:

• list_projects - bool Optional: false
• projects_auth - bool Optional: true
• projects_stats - bool Optional: false
• projects_tasks_stats - bool Optional: false
• projects_users - bool Optional: false
• manual - bool Optional: false
• token - string Optional: ""
• fetch_pwd_sha - bool Optional: false

Output:

• user - User
• account - Account
• projects - LIST of Project - can be null
• need_update - bool
• need_double_authentification - bool - can be null

Example:

{
    "header": {
        "target": "auth.user.Login",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {
            "list_projects": true,
            "projects_auth": true,
            "projects_stats": true,
            "projects_tasks_stats": true,
            "projects_users": true,
            "manual": true,
            "token": "some text",
            "fetch_pwd_sha": true
        }
    }
}

---

auth.user.Logout

Used to logout a user

keep_self removes all sessions of the user except this one
kill_all removes all the sessions of the user, including this one
both set to false only remove this session
both set to true throws a 400

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• keep_self - bool Optional: false
• kill_all - bool Optional: false

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.user.Logout",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "keep_self": true,
            "kill_all": true
        }
    }
}

---

activity.event.ExportAsCSV

export the list of activity events in a CSV file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id_list - int list

Body Data:

• min_date - datetime Optional: null
• max_date - datetime Optional: null
• type_list - int list Optional: []
• csv_delimiter - string Optional: ";"
• csv_enclosure - string Optional: """
• user_id_list - int list Optional: []
• filter - string Optional: ""
• with_account_event - bool Optional: false

Output:

• success - bool

Example:

{
    "header": {
        "target": "activity.event.ExportAsCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "type_list": [
                12345,
                12346
            ],
            "csv_delimiter": "some text",
            "csv_enclosure": "some text",
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true
        }
    }
}

---

activity.event.GetList

Get a list of activity events

Get a list of activity events based on the given parameters

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id_list - int list

Body Data:

• min_date - datetime Optional: null
• max_date - datetime Optional: null
• limit - int Optional: 100
• user_id_list - int list Optional: []
• filter - string Optional: ""
• with_account_event - bool Optional: false
• type_list - int list Optional: []

Output:

• activity_events - LIST of ActivityEvent
• total_events_count - int

Example:

{
    "header": {
        "target": "activity.event.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                12345,
                12346
            ]
        }
    }
}

---

activity.event.GetNextList

Ask for the next X results from events

If we are only displaying the first 100 results, this request should return the next 100 results, etc...

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id_list - int list

Body Data:

• min_date - datetime Optional: null
• max_date - datetime Optional: null
• limit - int Optional: 100
• user_id_list - int list Optional: []
• filter - string Optional: ""
• with_account_event - bool Optional: false
• type_list - int list Optional: []
• current_result_count - int

Output:

• activity_events - LIST of ActivityEvent
• total_events_count - int

Example:

{
    "header": {
        "target": "activity.event.GetNextList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                12345,
                12346
            ],
            "current_result_count": 12345
        }
    }
}

---

activity.event.GetNotifications

Get a list of activity events notified for the contexted user

Get a list of activity events notified for the contexted user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• limit - int Optional: 100

Output:

• activity_events - LIST of ActivityEvent
• total_events_count - int
• total_unread - LIST of struct
  • project_id - int
  • total - int
  • document - int
  • task - int
  • calendar - int
  • meeting - int

Example:

{
    "header": {
        "target": "activity.event.GetNotifications",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "limit": 12345
        }
    }
}

---

activity.event.GetUnreadCount

Get unread event count by projects

Push information:

Pushing to: Self
With target: activity.event.GetUnreadCount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• limit - int Optional: 100

Output:

• total_unread - LIST of struct
  • project_id - int
  • total - int
  • document - int
  • task - int
  • calendar - int
  • meeting - int
• panel_unread - int

Example:

{
    "header": {
        "target": "activity.event.GetUnreadCount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "limit": 12345
        }
    }
}

---

activity.event.MarkAllItemsHistoryAsRead

Push information:

Pushing to: Self
With target: activity.event.MarkAllItemsHistoryAsRead
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id_list - int list

Body Data:

• type_list - int list Optional: []

Output:

Documentation not available yet

Example:

{
    "header": {
        "target": "activity.event.MarkAllItemsHistoryAsRead",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "type_list": [
                12345,
                12346
            ]
        }
    }
}

---

activity.event.MarkItemsHistoryAsRead

Push information:

Pushing to: Self
With target: activity.event.MarkItemsHistoryAsRead
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• item_history_id_list - int list

Output:

• item_history_id_list - LIST of int

Example:

{
    "header": {
        "target": "activity.event.MarkItemsHistoryAsRead",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "item_history_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

activity.event.NewEvent

Get unread event count by projects

Push information:

Pushing to: User list
With target: activity.event.NewEvent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Output:

• event - ActivityEvent

Example:

{
    "header": {
        "target": "activity.event.NewEvent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.AddComment

Add a comment to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• comment - string

Output:

• event_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

---

calendar.event.AddExternalAttachment

Attach an external file to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• file_timestamp - string Optional: ""
• name - string
• size - int

Output:

• success - bool
• attachment - ExternalAttachment
• calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.AddExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "file_timestamp": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

---

calendar.event.AddExternalParticipants

Add external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• external_user_list - list

Output:

• success - bool
• event_id - int
• external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.AddExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "external_user_list": [
                {
                    "email": "external_user1@domain.com",
                    "first_name": "first_name1",
                    "last_name": "last_name1"
                },
                {
                    "email": "external_user2@domain.com",
                    "first_name": "first_name2",
                    "last_name": "last_name2"
                }
            ]
        }
    }
}

---

calendar.event.AddWimiAttachment

Attach a wimi file to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• file_id - int

Output:

• success - bool
• attachment - DocumentAttachment
• calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.AddWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ChangeInviteStatus

Change Status of Agenda Event Participant. Accept / Refuse invite to an event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• status - int

Output:

• events - LIST of CalendarEvent

Example:

{
    "header": {
        "target": "calendar.event.ChangeInviteStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

---

calendar.event.ConversationArchive

Archive a conversation

Push information:

Pushing to: Self
With target: calendar.event.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• success - bool
• calendar_event_id - int
• user_id - int

Example:

{
    "header": {
        "target": "calendar.event.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: calendar.event.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• success - bool
• calendar_event_id - int
• user_id - int

Example:

{
    "header": {
        "target": "calendar.event.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: calendar.event.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• silent - bool
• silent_until - datetime Optional: null

Output:

• success - bool
• calendar_event_id - int
• user_id - int
• silent - bool
• silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "calendar.event.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

calendar.event.CopyEventList

Push information:

Pushing to: Project users
With target: calendar.event.CopyEventList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id_list - int list
• target_project_id - int Optional: null

Body Data:

• recurrence_id_list - Array Optional: stdClass Object ( )

Output:

• events - LIST of CalendarEvent
• success - bool

Example:

{
    "header": {
        "target": "calendar.event.CopyEventList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "recurrence_id_list": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

---

calendar.event.Create

Create a calendar event

Push information:

Pushing to: User list
With target: calendar.event.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int

Body Data:

• event - struct

Output:

• event - CalendarEvent
• success - bool

Example:

{
    "header": {
        "target": "calendar.event.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

---

calendar.event.DeleteComment

Delete a calendar event comment

Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Project users
With target: calendar.event.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• comment_id - int (parameter needs to be owned by api user)

Output:

• success - bool
• calendar_event_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.DownloadAttachment

Download a calendar event attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• attachment_id - int
• calendar_event_id - CalendarEvent

Output:

• md5 - string
• date - string
• name - string
• size - int
• file_path - string
• attachment - ExternalAttachment

Example:

{
    "header": {
        "target": "calendar.event.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "attachment_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.EditComment

Edit a comment of a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• comment_id - int (parameter needs to be owned by api user)

Body Data:

• comment - string

Output:

• event_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

---

calendar.event.Get

Get the details of a calendar events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• event - CalendarEvent

Example:

{
    "header": {
        "target": "calendar.event.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetAttachmentList

get the list of files attached to a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• external_attachments - LIST of ExternalAttachment
• wimi_attachments - LIST of DocumentAttachment

Example:

{
    "header": {
        "target": "calendar.event.GetAttachmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetComments

Get teh comments of a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• comments - LIST of Comment

Example:

{
    "header": {
        "target": "calendar.event.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetDownloadInviteLink

Download the ics for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• success - bool
• link - string

Example:

{
    "header": {
        "target": "calendar.event.GetDownloadInviteLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetExternalParticipants

Get external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• success - bool
• event_id - int
• external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.GetExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetList

Get a list of events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int

Body Data:

• start_date - datetime Optional: null
• end_date - datetime Optional: null
• filters - int list Optional: Array ( [0] => 1 )
• view_busy - bool Optional: true
• busy_user_id_list - int list Optional: null
• view_empty_events - bool Optional: true
• calendar_event_id_list - int list Optional: []
• gen_rec_occurrences - bool Optional: true
• modified_after - int Optional: 0

Output:

• events - LIST of CalendarEvent

Example:

{
    "header": {
        "target": "calendar.event.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27 17:10:05",
            "end_date": "2016-11-27 17:10:05",
            "filters": [
                12345,
                12346
            ],
            "view_busy": true,
            "busy_user_id_list": [
                12345,
                12346
            ],
            "view_empty_events": true,
            "calendar_event_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "modified_after": 12345
        }
    }
}

---

calendar.event.GetListUnified

Get a list of events for unified calendars

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• start_date - datetime
• end_date - datetime
• filters - int list Optional: Array ( [0] => 1 )
• project_id_list - int list Optional: null
• user_id_list - int list Optional: null
• gen_rec_occurrences - bool Optional: true
• view_empty_events - bool Optional: true

Output:

• events - LIST of CalendarEvent

Example:

{
    "header": {
        "target": "calendar.event.GetListUnified",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27 17:10:05",
            "end_date": "2016-11-27 17:10:05",
            "filters": [
                12345,
                12346
            ],
            "project_id_list": [
                12345,
                12346
            ],
            "user_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "view_empty_events": true
        }
    }
}

---

calendar.event.GetSubscriptionLink

Get a calendar subscription link

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int

Output:

• link - string - can be null

Example:

{
    "header": {
        "target": "calendar.event.GetSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetUnifiedSubscriptionLink

Get calendar subscription link for unified projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Output:

• link - string

Example:

{
    "header": {
        "target": "calendar.event.GetUnifiedSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• attachment_id - int
• calendar_event_id - CalendarEvent

Body Data:

• preview_type - string Optional: "default"

Output:

• md5 - string
• date - string
• name - string
• size - int
• file_path - string
• preview_status - string
• preview_type - string
• doc_type - string
• doc_id - int

Example:

{
    "header": {
        "target": "calendar.event.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "attachment_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

---

calendar.event.Remove

Delete a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.Remove
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Output:

• event_id - int
• success - bool

Example:

{
    "header": {
        "target": "calendar.event.Remove",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.RemoveExternalAttachment

remove an external attachment from the calendar

Push information:

Pushing to: Project users
With target: calendar.event.RemoveExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• attachment_id - int

Output:

• success - bool
• attachment_id - int
• calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.RemoveExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.RemoveExternalParticipants

Remove external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• external_user_id_list - int list

Output:

• success - bool
• event_id - int
• external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.RemoveExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "external_user_id_list": [
                12345,
                12346
            ]
        }
    }
}

---

calendar.event.RemoveRecurrenceOccurrence

Delete a recurrence occurrence

Push information:

Pushing to: Project users
With target: calendar.event.RemoveRecurrenceOccurrence
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• recurrence_id - datetime

Output:

• event_id - int
• success - bool
• recurrence_id - datetime

Example:

{
    "header": {
        "target": "calendar.event.RemoveRecurrenceOccurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "recurrence_id": "2016-11-27 17:10:05"
        }
    }
}

---

calendar.event.RemoveWimiAttachment

remove a wimi attachment from the calendar

Push information:

Pushing to: Project users
With target: calendar.event.RemoveWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• attachment_id - int

Output:

• success - bool
• attachment_id - int
• calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.RemoveWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.Update

Update a calendar event - only the provided data are updated.

Push information:

Pushing to: User list
With target: calendar.event.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent

Body Data:

• event - struct

Output:

• event - CalendarEvent
• success - bool
• updated_fields - LIST of string

Example:

{
    "header": {
        "target": "calendar.event.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

---

calendar.event.UpdateProject

Move a calendar event from one project to another

Push information:

Pushing to: User list
With target: calendar.event.UpdateProject
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Agenda restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• calendar_event_id - CalendarEvent
• target_project_id - int

Output:

• event - CalendarEvent
• success - bool

Example:

{
    "header": {
        "target": "calendar.event.UpdateProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "target_project_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddAttachment

Attach a file to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Body Data:

• attachment_title - string Optional: ""
• attachment_description - string Optional: ""
• name - string
• size - int

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.AddAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "attachment_title": "some text",
            "attachment_description": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

---

chat.chat.AddInternalAttachment

Attach a internal file to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddInternalAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• file_id - int

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.AddInternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddMembers

Add members to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddMembers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• member_id_list - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

• success - bool
• chat_id - int
• chat_users - LIST of ChatUser
• chat_members - LIST of ChatMember

Example:

{
    "header": {
        "target": "chat.chat.AddMembers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddUsers

Add users to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddUsers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• user_id_list - int list

Output:

• success - bool
• chat_id - int
• added_user_id_list - LIST of int
• chat_users - LIST of ChatUser

Example:

{
    "header": {
        "target": "chat.chat.AddUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.CanceledTyping

Send a notification that the user canceled typing

Push information:

Pushing to: Chat users
With target: chat.chat.CanceledTyping
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• user_id - int
• chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.CanceledTyping",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.ClearUnseen

Clear unseen count for chat

Push information:

Pushing to: Chat users
With target: chat.chat.ClearUnseen
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• success - bool
• chat_id - int
• user_id - int

Example:

{
    "header": {
        "target": "chat.chat.ClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.Create

Create a group chat

Push information:

Pushing to: Self
With target: chat.chat.Create
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• users - int list Optional: []
• user_groups - int list Optional: []
• name - string Optional: ""
• use_existing - bool Optional: true
• force_creation - bool Optional: false

Output:

• success - bool
• chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "users": [
                12345,
                12346
            ],
            "user_groups": [
                12345,
                12346
            ],
            "name": "some text",
            "use_existing": true,
            "force_creation": true
        }
    }
}

---

chat.chat.CreateChannel

Create channel chat

Push information:

Pushing to: Self
With target: chat.chat.CreateChannel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int

Output:

• success - bool
• chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.CreateChannel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.DeleteMessage

Delete a message

Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: User list
With target: chat.chat.DeleteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int (parameter needs to be owned by api user)

Body Data:

• message_index - int Optional: 0

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.DeleteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.Disable

Disable a chat for a user

Remove the chat from the recent chats

Push information:

Pushing to: Self
With target: chat.chat.Disable
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• success - bool
• chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.Disable",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.DownloadAttachment

Download a chat attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• file_id - int
• chat_id - int

Output:

• md5 - string
• date - string
• name - string
• size - int
• file_path - string - can be missing
• attachment - ExternalAttachment

Example:

{
    "header": {
        "target": "chat.chat.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.EditMessage

Edit a message

Push information:

Pushing to: Chat users
With target: chat.chat.EditMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int (parameter needs to be owned by api user)

Body Data:

• message - string
• message_index - int Optional: 0

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.EditMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "message_index": 12345
        }
    }
}

---

chat.chat.EditName

Edit a chat name

Push information:

Pushing to: Chat users
With target: chat.chat.EditName
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Body Data:

• name - string

Output:

• success - bool
• chat_id - int
• name - string

Example:

{
    "header": {
        "target": "chat.chat.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

chat.chat.FavoriteMessage

Favorite a message

Push information:

Pushing to: Self
With target: chat.chat.FavoriteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int

Body Data:

• message_index - int Optional: 0

Output:

• success - bool
• chat_id - int
• message_index - int
• message_id - int

Example:

{
    "header": {
        "target": "chat.chat.FavoriteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.GetAttachmentList

Get attachment list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• success - bool
• attachments - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.GetAttachmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetChat

Get chat

with or without messages, default with

Push information:

Pushing to: Self
With target: chat.chat.GetChat
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Body Data:

• with_messages - bool Optional: true
• limit - int Optional: 30

Output:

• success - bool
• chat_id - int
• chat - ChatFull

Example:

{
    "header": {
        "target": "chat.chat.GetChat",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "with_messages": true,
            "limit": 12345
        }
    }
}

---

chat.chat.GetFavorites

Get favorite list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• success - bool
• favorites - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.GetFavorites",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetLinks

Get shared links in a chat

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• success - bool
• links - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.GetLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetList

Get chat list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• comment_count - bool Optional: false

Output:

• success - bool
• chats - LIST of Chat
• items - LIST of CommentedItemCount - can be missing

Example:

{
    "header": {
        "target": "chat.chat.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "comment_count": true
        }
    }
}

---

chat.chat.GetMessageBeforeAfter

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int

Body Data:

• message_index - int Optional: 0

Output:

• success - bool
• results - struct
  • before - LIST of ChatMessage
  • after - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.GetMessageBeforeAfter",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.LoadMessages

Get chat messages from offset of given message id, until limit

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int Optional: null

Body Data:

• offset - int Optional: 0
• limit - int Optional: 30

Output:

• success - bool
• chat_id - int
• messages - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.LoadMessages",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "offset": 12345,
            "limit": 12345
        }
    }
}

---

chat.chat.PostMessage

Post message to chat

Push information:

Pushing to: Chat users
With target: chat.chat.PostMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• api_key - string Optional: ""
• chat_id - int

Body Data:

• message - string
• integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.PostMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "integration_attachment": "no example yet"
        }
    }
}

---

chat.chat.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• attachment_id - int Optional: null
• chat_id - int

Body Data:

• preview_type - string Optional: "default"

Output:

• md5 - string
• date - string
• name - string
• size - int
• file_path - string
• preview_status - string
• preview_type - string
• doc_type - string
• doc_id - int

Example:

{
    "header": {
        "target": "chat.chat.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

---

chat.chat.RemoveMembers

Remove members from a chat

Push information:

Pushing to: User list
With target: chat.chat.RemoveMembers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• member_id_list - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

• success - bool
• chat_id - int
• chat_users - LIST of ChatUser
• chat_members - LIST of ChatMember

Example:

{
    "header": {
        "target": "chat.chat.RemoveMembers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.RemoveUsers

Remove users from a chat

Push information:

Pushing to: Chat users
With target: chat.chat.RemoveUsers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• user_id_list - int list

Output:

• success - bool
• chat_id - int
• removed_user_id_list - LIST of int
• chat_users - LIST of ChatUser

Example:

{
    "header": {
        "target": "chat.chat.RemoveUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.Search

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Body Data:

• search - string

Output:

• success - bool
• results - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.Search",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "search": "some text"
        }
    }
}

---

chat.chat.SetMessageIntegrationAttachment

Set the integration attachment for a message

Push information:

Pushing to: Chat users
With target: chat.chat.SetMessageIntegrationAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• api_key - string Optional: ""
• chat_id - int
• message_id - int (parameter needs to be owned by api user)

Body Data:

• integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

• success - bool
• chat_id - int
• message - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.SetMessageIntegrationAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet"
        }
    }
}

---

chat.chat.SetSilent

Set silent for chat

Push information:

Pushing to: Self
With target: chat.chat.SetSilent
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Body Data:

• silent - bool
• silent_until - datetime Optional: null

Output:

• success - bool
• chat_id - int
• user_id - int
• silent - bool
• silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "chat.chat.SetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

chat.chat.StartedTyping

Send a notification that the user is typing

Push information:

Pushing to: Chat users
With target: chat.chat.StartedTyping
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int

Output:

• user_id - int
• chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.StartedTyping",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.UnfavoriteMessage

Unfavorite a message

Push information:

Pushing to: Self
With target: chat.chat.UnfavoriteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• message_id - int

Body Data:

• message_index - int Optional: 0

Output:

• success - bool
• chat_id - int
• message_index - int
• message_id - int

Example:

{
    "header": {
        "target": "chat.chat.UnfavoriteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.UpdateGroupChatProfilePicture

Push information:

Pushing to: Chat users
With target: chat.chat.UpdateGroupChatProfilePicture
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• chat_id - int
• name - string Optional: ""
• size - int Optional: 0

Output:

• success - bool
• chat_id - int
• custom_image_id - int

Example:

{
    "header": {
        "target": "chat.chat.UpdateGroupChatProfilePicture",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "chat_id": 12345,
            "name": "some text",
            "size": 12345
        }
    }
}

---

chat.message.AddMessageReaction

Add a reaction for a message

Push information:

Pushing to: Chat users
With target: chat.message.AddMessageReaction
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• api_key - string Optional: ""
• chat_id - int
• message_id - int

Body Data:

• reaction - Emoji

Output:

• success - bool
• chat_id - int
• message_id - int
• user_id - int
• reaction - string

Example:

{
    "header": {
        "target": "chat.message.AddMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

---

chat.message.DeleteMessageReaction

Delete a reaction for a message

Push information:

Pushing to: Chat users
With target: chat.message.DeleteMessageReaction
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• api_key - string Optional: ""
• chat_id - int
• message_id - int

Body Data:

• reaction - Emoji

Output:

• success - bool
• chat_id - int
• message_id - int
• user_id - int
• reaction - string

Example:

{
    "header": {
        "target": "chat.message.DeleteMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

---

comment.comment.GetCommentsForItem

Get a specific user commented item

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int
• item_id - int
• item_type_id - int

Output:

• success - bool
• items - LIST of CommentedItem

Example:

{
    "header": {
        "target": "comment.comment.GetCommentsForItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "item_id": 12345,
            "item_type_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

comment.comment.GetUserCommentedItems

Get user commented items

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Output:

• success - bool
• items - LIST of CommentedItem

Example:

{
    "header": {
        "target": "comment.comment.GetUserCommentedItems",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

communication.air.CreatePersistentRoom

create a persistent room

Push information:

Pushing to: Whole account
With target: communication.air.CreatePersistentRoom
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• name - string
• image - PersistentRoomImage

Output:

• persistent_room - PersistentRoom

Example:

{
    "header": {
        "target": "communication.air.CreatePersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "image": 12345
        }
    }
}

---

communication.air.GetPersistentRoom

Get persistent airtime room

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Header Identification:

• account_id - int
• user_id - int

Body Data:

• room_id - PersistentRoom

Output:

• persistent_room - PersistentRoom

Example:

{
    "header": {
        "target": "communication.air.GetPersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "room_id": 12345
        }
    }
}

---

document.directory.AddComment

Add comment to a directory

Push information:

Pushing to: Project users
With target: document.directory.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Body Data:

• comment - string

Output:

• dir_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.directory.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

---

document.directory.AddLink

Add link to directory

Push information:

Pushing to: Project users
With target: document.directory.AddLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Body Data:

• url - string
• title - string

Output:

• success - bool
• link - Link

Example:

{
    "header": {
        "target": "document.directory.AddLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "url": "mylabel1",
            "title": "mylabel1"
        }
    }
}

---

document.directory.AddMembersToDir

Add members to dir

Return all users having access to dir

Push information:

Pushing to: Project users
With target: document.directory.AddMembersToDir
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
		X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• group_member_list - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

• member_access_list - LIST of MemberAccess
• dir_id - int
• dir_auth - int

Example:

{
    "header": {
        "target": "document.directory.AddMembersToDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationArchive

Archive a conversation

Push information:

Pushing to: Self
With target: document.directory.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• success - bool
• dir_id - int
• user_id - int

Example:

{
    "header": {
        "target": "document.directory.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: document.directory.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• success - bool
• dir_id - int
• user_id - int

Example:

{
    "header": {
        "target": "document.directory.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: document.directory.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Body Data:

• silent - bool
• silent_until - datetime Optional: null

Output:

• success - bool
• dir_id - int
• user_id - int
• silent - bool
• silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "document.directory.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

document.directory.Copy

Copy a directory elsewhere

Push information:

Pushing to: Project users
With target: document.directory.Copy
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• dest_dir_id - int Optional: null
• target_project_id - int Optional: null

Body Data:

• name - string

Output:

• dir_id - int

Example:

{
    "header": {
        "target": "document.directory.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

document.directory.CopyList

Copy a list of directory elsewhere

Push information:

Pushing to: Project users
With target: document.directory.CopyList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list
• dest_dir_id - int Optional: null
• target_project_id - int Optional: null

Body Data:

• copy_meta - bool Optional: false

Output:

• success - bool
• dir_id - int
• target_project_id - int
• dirs - LIST of struct - can be missing
  • success - bool
  • dir - Directory - can be missing
  • error - Error - can be missing

Example:

{
    "header": {
        "target": "document.directory.CopyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "copy_meta": true
        }
    }
}

---

document.directory.Create

Creates a directory

Push information:

Pushing to: Project users
With target: document.directory.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Body Data:

• name - string

Output:

• directory - Directory
• parent_id - int

Example:

{
    "header": {
        "target": "document.directory.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

document.directory.CreateDirectoryTree

Creates a directory tree when uploading a folder

Push information:

Pushing to: Project users
With target: document.directory.CreateDirectoryTree
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null
• relative_path_list - string list

Output:

• success - bool
• files_extended_data - LIST of FileListPathDirId

Example:

{
    "header": {
        "target": "document.directory.CreateDirectoryTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "relative_path_list": [
                "string1",
                "string2",
                "string3"
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.DeleteComment

Delete a directory comment

Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Project users
With target: document.directory.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• comment_id - int (parameter needs to be owned by api user)

Output:

• success - bool
• dir_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.directory.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.DeniedList

Get the list of denied directories for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• group_member - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

• dir_id_list - LIST of int

Example:

{
    "header": {
        "target": "document.directory.DeniedList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.EditComment

Edit a comment of a directory

Push information:

Pushing to: Project users
With target: document.directory.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• comment_id - int (parameter needs to be owned by api user)

Body Data:

• comment - string

Output:

• dir_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.directory.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

---

document.directory.EditMembersAccessToDirectories

Edits members access on one or several directories

Push information:

Pushing to: Project users
With target: document.directory.EditMembersAccessToDirectories
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• member_id_list - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Body Data:

• dir_access_array - assoc array int to in

Output:

• success - bool
• dirs - LIST of struct
  • success - bool
  • dir_id - int
  • dir_auth - int
  • member_access_list - LIST of MemberAccess
  • directory - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.EditMembersAccessToDirectories",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {
            "dir_access_array": {
                "1": 0,
                "2": 1,
                "5": 2
            }
        }
    }
}

---

document.directory.EditName

Edits the name of a directory

Push information:

Pushing to: Project users
With target: document.directory.EditName
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Body Data:

• name - string

Output:

• name - string
• dir_id - int

Example:

{
    "header": {
        "target": "document.directory.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

document.directory.GetComments

Get comments of a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• comments - LIST of Comment

Example:

{
    "header": {
        "target": "document.directory.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetDirectoryUsers

Get list of all users having access to given directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• users - LIST of User

Example:

{
    "header": {
        "target": "document.directory.GetDirectoryUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetMembersAccess

Get users access of a dir

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• dir_id - int
• dir_auth - int
• member_access_list - LIST of MemberAccess

Example:

{
    "header": {
        "target": "document.directory.GetMembersAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetReadOnlyStateForUser

Get the read only state of the directory for the current user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• success - bool
• is_read_only - bool

Example:

{
    "header": {
        "target": "document.directory.GetReadOnlyStateForUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.LinkPathInfo

Get file path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• link_id - Link

Output:

• path_ids - LIST of int
• link_id - int

Example:

{
    "header": {
        "target": "document.directory.LinkPathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.Move

Move directories to a folder

Push information:

Pushing to: Project users
With target: document.directory.Move
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null
• dir_id_list - int list
• target_project_id - int Optional: null

Body Data:

• conflict_rename - bool Optional: false

Output:

• success - bool
• conflicts_count - int
• conflicts - LIST of struct - can be missing
  • dir_id - int
  • dir_name - string
  • alt_name - string
• nb_dirs - int - can be missing
• dir_id - int - can be missing
• dirs - LIST of struct - can be missing
  • error - Error - can be missing
  • success - bool - can be missing
  • dir - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "conflict_rename": true
        }
    }
}

---

document.directory.MoveLink

Move links from one directory to another

Push information:

Pushing to: Project users
With target: document.directory.MoveLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null
• link_id_list - int list
• target_project_id - int Optional: null

Output:

• links - LIST of Link
• dir_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.directory.MoveLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.MoveToGarbageCollector

Permanently delete one or more directories

Push information:

Pushing to: Project users
With target: document.directory.MoveToGarbageCollector
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list

Output:

• success - bool
• dirs - LIST of struct
  • error - Error - can be missing
  • success - bool - can be missing
  • dir_id - int - can be missing

Example:

{
    "header": {
        "target": "document.directory.MoveToGarbageCollector",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.MoveToTrash

Delete one or more directories

Push information:

Pushing to: Project users
With target: document.directory.MoveToTrash
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list

Output:

• success - bool
• dirs - LIST of struct
  • error - Error - can be missing
  • success - bool - can be missing
  • dir_id - int - can be missing

Example:

{
    "header": {
        "target": "document.directory.MoveToTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.PathInfo

Get directory path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Output:

• path_ids - LIST of int
• path_names - LIST of string

Example:

{
    "header": {
        "target": "document.directory.PathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.RemoveMembersFromDir

Remove members from dir

Return all users having access to dir

Push information:

Pushing to: Project users
With target: document.directory.RemoveMembersFromDir
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
		X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• group_member_list - array
  • - member_id: id of the member
  • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

• member_access_list - LIST of MemberAccess
• dir_id - int
• dir_auth - int

Example:

{
    "header": {
        "target": "document.directory.RemoveMembersFromDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.RemoveProperty

Remove a property from a directory

Push information:

Pushing to: Project users
With target: document.directory.RemoveProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• property_label - string

Body Data:

• subdirs - bool Optional: false

Output:

• success - bool
• dir_id_list - LIST of int
• property - Property

Example:

{
    "header": {
        "target": "document.directory.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "subdirs": true
        }
    }
}

---

document.directory.Restore

Restore one or more directories from trash

Push information:

Pushing to: Project users
With target: document.directory.Restore
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list

Body Data:

• dir_id - int Optional: null

Output:

• success - bool
• dirs - LIST of struct
  • error - int - can be missing
  • error_str - string - can be missing
  • success - bool - can be missing
  • dir_id - int - can be missing
  • parent_id - int - can be missing
  • dir - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "dir_id": 12345
        }
    }
}

---

document.directory.SetDirectoryDefault

Get comments of a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int

Body Data:

• access - int Optional: 0

Output:

• success - bool
• dir_id - int
• access - int

Example:

{
    "header": {
        "target": "document.directory.SetDirectoryDefault",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "access": 12345
        }
    }
}

---

document.directory.SetPropertyValue

Add a property to a directory

subdirs: whether or not we apply this property to all subdirs of dir
Return list of dir id affected by the property and its value

Push information:

Pushing to: Project users
With target: document.directory.SetPropertyValue
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int
• property_label - string

Body Data:

• value - string
• subdirs - bool Optional: false

Output:

• success - bool
• dir_id_list - LIST of int
• property - Property

Example:

{
    "header": {
        "target": "document.directory.SetPropertyValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1",
            "subdirs": true
        }
    }
}

---

document.entry.DirList

List folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Output:

• dirs - LIST of Directory

Example:

{
    "header": {
        "target": "document.entry.DirList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.entry.GetProjectTree

Get flat tree for project

Get a flat tree, ordered by path

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int

Output:

• document_entry_list - LIST of DocumentTreeEntry

Example:

{
    "header": {
        "target": "document.entry.GetProjectTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

document.entry.List

List the files and folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Body Data:

• no_comment_count - bool Optional: false
• process_thumbnail - bool Optional: false

Output:

• dirs - LIST of Directory
• files - LIST of File
• links - LIST of Link
• folder - Directory - can be null

Example:

{
    "header": {
        "target": "document.entry.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "no_comment_count": true,
            "process_thumbnail": true
        }
    }
}

---

document.entry.ListServiceEntries

List the service entries of a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Body Data:

• cloud_reference - string Optional: null

Output:

• success - bool
• entries - object - can be missing
• url - string - can be missing

Example:

{
    "header": {
        "target": "document.entry.ListServiceEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "cloud_reference": "some text"
        }
    }
}

---

document.entry.TrashList

List the files, the link and folders found in the trash

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:

Project members (0)	Project administrators (5)
X	X

Role restrictions:

Guests (-5)	Contributors (0)	Managers (1)	Administrators (2)	Account manager (3)
X	X	X	X	X

Documents restrictions:

Read-only (1)	Read-write (2)
X	X

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id - int Optional: null

Output:

• dirs - LIST of Directory
• files - LIST of File
• links - LIST of Link
• folder - Directory - can be null

Example:

{
    "header": {
        "target": "document.entry.TrashList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}