WApi Interface

---

auth.doubleauth.AddDevice

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.doubleauth.AddDevice",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.Authenticated

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• status - string
• type - int
• tag - string
• data - object

Example:

{
    "header": {
        "target": "auth.doubleauth.Authenticated",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.DeviceAdded

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• tag - string

Example:

{
    "header": {
        "target": "auth.doubleauth.DeviceAdded",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.ErrorMessage

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• status - string
• error_code - int
• message - string

Example:

{
    "header": {
        "target": "auth.doubleauth.ErrorMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.InitOtpProcess

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• session_id - string
• authtoken - string
• otp - int

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.doubleauth.InitOtpProcess",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "session_id": "some text",
            "authtoken": "some text",
            "otp": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

auth.doubleauth.QrCodeFlashed

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• status - string
• type - int
• tag - string

Example:

{
    "header": {
        "target": "auth.doubleauth.QrCodeFlashed",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.ResetAuthDevices

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.doubleauth.ResetAuthDevices",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "user_id_list": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

auth.doubleauth.SessionCanceled

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• status - string
• type - int
• tag - string

Example:

{
    "header": {
        "target": "auth.doubleauth.SessionCanceled",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.SessionInitialized

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• status - string
• type - int
• tag - string
• data - object

Example:

{
    "header": {
        "target": "auth.doubleauth.SessionInitialized",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.doubleauth.ToggleDoubleAuth

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• user_id_list - int list
• activating - bool

Output:

• success - bool
• user_id_list - LIST of int
• double_auth - bool

Example:

{
    "header": {
        "target": "auth.doubleauth.ToggleDoubleAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "user_id_list": [
                1234,
                82373,
                1212
            ],
            "activating": true
        }
    },
    "body": {
        "data": {}
    }
}

---

auth.user.CheckUserPassword

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.user.CheckUserPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

auth.user.Login

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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
        }
    }
}

---

auth.user.MultiLogin

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

Output:

• success - bool
• accounts - LIST of struct
  • user_id - int
  • login - string
  • first_name - string
  • last_name - string
  • user_image_url - string - can be null
  • account_image_url - string - can be null
  • login_link - string
  • account_name - string
  • account_id - int

Example:

{
    "header": {
        "target": "auth.user.MultiLogin",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {}
    }
}

---

auth.user.RequestNewPassword

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int

Body Data:

• email - string

Output:

• success - bool

Example:

{
    "header": {
        "target": "auth.user.RequestNewPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345
        }
    },
    "body": {
        "data": {
            "email": "some text"
        }
    }
}

---

auth.user.WimiReminder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

Output:

• sent - string
• customer - bool

Example:

{
    "header": {
        "target": "auth.user.WimiReminder",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {}
    }
}

---

activity.event.ExportAsCSV

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "type_list": [
                1,
                5,
                8,
                9
            ],
            "csv_delimiter": "some text",
            "csv_enclosure": "some text",
            "user_id_list": [
                1234,
                82373,
                1212
            ],
            "filter": "some text",
            "with_account_event": true
        }
    }
}

---

activity.event.GetList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                1234,
                82373,
                1212
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                1,
                5,
                8,
                9
            ]
        }
    }
}

---

activity.event.GetNextList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                1234,
                82373,
                1212
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                1,
                5,
                8,
                9
            ],
            "current_result_count": 12345
        }
    }
}

---

activity.event.GetNotifications

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {
            "type_list": [
                1,
                5,
                8,
                9
            ]
        }
    }
}

---

activity.event.MarkItemsHistoryAsRead

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1,
                5,
                8,
                9
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

activity.event.NewEvent

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• event_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

calendar.event.AddExternalAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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
• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "file_timestamp": "some text",
            "name": "some text",
            "size": 12345,
            "_encryption": "no example yet"
        }
    }
}

---

calendar.event.AddWimiAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ChangeInviteStatus

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

---

calendar.event.ConversationArchive

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ConversationClearUnseen

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.ConversationSetSilent

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

calendar.event.CopyEventList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1,
                5,
                8,
                9
            ]
        }
    },
    "body": {
        "data": {
            "recurrence_id_list": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

---

calendar.event.Create

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

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 wimi account setting on wimi.pro",
        "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": 12364,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.DownloadAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 98513,
            "calendar_event_id": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.EditComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• event_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 12364,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

calendar.event.Get

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetAttachmentList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetComments

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.GetList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1,
                5,
                8,
                9
            ],
            "view_busy": true,
            "busy_user_id_list": [
                1,
                5,
                8,
                9
            ],
            "view_empty_events": true,
            "calendar_event_id_list": [
                1,
                5,
                8,
                9
            ],
            "gen_rec_occurrences": true,
            "modified_after": 12345
        }
    }
}

---

calendar.event.GetListUnified

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1,
                5,
                8,
                9
            ],
            "project_id_list": [
                1,
                5,
                8,
                9
            ],
            "user_id_list": [
                1,
                5,
                8,
                9
            ],
            "gen_rec_occurrences": true,
            "view_empty_events": true
        }
    }
}

---

calendar.event.GetSubscriptionLink

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 98513,
            "calendar_event_id": 12364
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

---

calendar.event.Remove

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.RemoveExternalAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.RemoveRecurrenceOccurrence

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "recurrence_id": "2016-11-27 17:10:05"
        }
    }
}

---

calendar.event.RemoveWimiAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

---

calendar.event.Update

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

---

calendar.event.UpdateProject

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 12364,
            "target_project_id": 94233
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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
• _messageEncryption - any list Optional: []
• _fileEncryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "attachment_title": "some text",
            "attachment_description": "some text",
            "name": "some text",
            "size": 12345,
            "_messageEncryption": "no example yet",
            "_fileEncryption": "no example yet"
        }
    }
}

---

chat.chat.AddInternalAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddInternalAttachments

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• chat_id - int
• file_id_list - int list

Output:

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

Example:

{
    "header": {
        "target": "chat.chat.AddInternalAttachments",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": "1234",
            "file_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddMembers

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 123
                },
                {
                    "member_type_id": 2,
                    "member_id": 789
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.AddUsers

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "user_id_list": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.CanceledTyping

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.ClearUnseen

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.Create

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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
• _encryption - any list Optional: []

Output:

• success - bool
• chat_id - int
• _encryption - LIST of Encryption - can be null

Example:

{
    "header": {
        "target": "chat.chat.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": [
                1234,
                82373,
                1212
            ],
            "user_groups": [
                1234,
                82373,
                1212
            ],
            "name": "some text",
            "use_existing": true,
            "force_creation": true,
            "_encryption": "no example yet"
        }
    }
}

---

chat.chat.CreateChannel

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 - ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.DeleteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.Disable

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.DownloadAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 98513,
            "chat_id": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.EditMessage

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• message - string
• message_index - int Optional: 0
• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "message_index": 12345,
            "_encryption": "no example yet"
        }
    }
}

---

chat.chat.EditName

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string
• _encryption - any list Optional: []

Output:

• success - bool
• chat_id - int
• name - string
• _encryption - LIST of Encryption - can be null

Example:

{
    "header": {
        "target": "chat.chat.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

chat.chat.FavoriteMessage

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.GetAttachmentList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetChat

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "with_messages": true,
            "limit": 12345
        }
    }
}

---

chat.chat.GetFavorites

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetLinks

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.GetList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Output:

• success - bool
• chats - LIST of Chat

Example:

{
    "header": {
        "target": "chat.chat.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.chat.GetMessageBeforeAfter

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.LoadMessages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "offset": 12345,
            "limit": 12345
        }
    }
}

---

chat.chat.PostMessage

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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
• _encryption - any list Optional: []
• _encryptionIntegration - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "integration_attachment": "no example yet",
            "_encryption": "no example yet",
            "_encryptionIntegration": "no example yet"
        }
    }
}

---

chat.chat.PreviewAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

---

chat.chat.RemoveMembers

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 123
                },
                {
                    "member_type_id": 2,
                    "member_id": 789
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.RemoveUsers

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "user_id_list": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.Search

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "search": "some text"
        }
    }
}

---

chat.chat.SetMessageIntegrationAttachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null
• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet",
            "_encryption": "no example yet"
        }
    }
}

---

chat.chat.SetSilent

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

chat.chat.StartedTyping

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234"
        }
    },
    "body": {
        "data": {}
    }
}

---

chat.chat.UnfavoriteMessage

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

---

chat.chat.UpdateGroupChatProfilePicture

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "1234",
            "name": "some text",
            "size": 12345
        }
    }
}

---

chat.message.AddMessageReaction

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• reaction - Emoji
• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "reaction": "copyright",
            "_encryption": "no example yet"
        }
    }
}

---

chat.message.DeleteMessageReaction

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• reaction - Emoji
• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": "1234",
            "message_id": "1234"
        }
    },
    "body": {
        "data": {
            "reaction": "copyright",
            "_encryption": "no example yet"
        }
    }
}

---

comment.comment.GetCommentsForItem

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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.AddRoomForAccount

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Body Data:

• room_name - string

Output:

• success - bool

Example:

{
    "header": {
        "target": "communication.air.AddRoomForAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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_name": "some text"
        }
    }
}

---

communication.air.CheckRoomAccess

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int

Body Data:

• room_name - string

Output:

• success - bool

Example:

{
    "header": {
        "target": "communication.air.CheckRoomAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345
        }
    },
    "body": {
        "data": {
            "room_name": "some text"
        }
    }
}

---

communication.air.Decline

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Body Data:

• room_name - string

Output:

• success - bool
• room - string

Example:

{
    "header": {
        "target": "communication.air.Decline",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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_name": "some text"
        }
    }
}

---

communication.air.GetAirtimeToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int

Output:

• success - bool
• access_token - string

Example:

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

---

communication.air.InvalidateAirtimeToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int

Output:

• success - bool

Example:

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

---

communication.air.Invite

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• room_name - string
• message - string Optional: ""

Output:

• success - bool
• url - string
• room - string
• user_id - int

Example:

{
    "header": {
        "target": "communication.air.Invite",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "user_id_list": [
                1234,
                82373,
                1212
            ]
        }
    },
    "body": {
        "data": {
            "room_name": "some text",
            "message": "some text"
        }
    }
}

---

communication.air.Join

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Body Data:

• room_name - string

Output:

• success - bool
• room - string

Example:

{
    "header": {
        "target": "communication.air.Join",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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_name": "some text"
        }
    }
}

---

communication.air.LogAirtimeStreamStats

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Body Data:

• member_id - string
• room_name - string
• stream_data_list - list

Output:

• success - bool

Example:

{
    "header": {
        "target": "communication.air.LogAirtimeStreamStats",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "member_id": "some text",
            "room_name": "some text",
            "stream_data_list": "no example yet"
        }
    }
}

---

communication.air.RefreshAirtimeToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int

Output:

• success - bool
• access_token - string

Example:

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

---

communication.mobile.OpenFile

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• dir_id - int

Example:

{
    "header": {
        "target": "communication.mobile.OpenFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.directory.AddComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• dir_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.directory.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.AddLink

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• url - string
• title - string
• _encryption - any list Optional: []

Output:

• success - bool
• link - Link

Example:

{
    "header": {
        "target": "document.directory.AddLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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",
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.AddMembersToDir

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 123
                },
                {
                    "member_type_id": 2,
                    "member_id": 789
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationArchive

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationClearUnseen

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.ConversationSetSilent

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

document.directory.Copy

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

document.directory.CopyList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string
• _encryption - any list Optional: []

Output:

• directory - Directory
• parent_id - int

Example:

{
    "header": {
        "target": "document.directory.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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",
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.CreateDirectoryTree

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• _encryption - any list Optional: []

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 wimi account setting on wimi.pro",
        "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": {
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.DeleteComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

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 wimi account setting on wimi.pro",
        "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": 785645,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.DeniedList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 123
            }
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.EditComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• dir_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.directory.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 785645,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.EditMembersAccessToDirectories

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 123
                },
                {
                    "member_type_id": 2,
                    "member_id": 789
                }
            ]
        }
    },
    "body": {
        "data": {
            "dir_access_array": {
                "1": 0,
                "2": 1,
                "5": 2
            }
        }
    }
}

---

document.directory.EditName

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string
• _encryption - any list Optional: []

Output:

• name - string
• dir_id - int
• _encryption - LIST of Encryption - can be null

Example:

{
    "header": {
        "target": "document.directory.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.directory.GetComments

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetDirectoryUsers

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetMembersAccess

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.GetReadOnlyStateForUser

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.LinkPathInfo

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": "no example yet"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.Move

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.MoveToGarbageCollector

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.RemoveMembersFromDir

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 123
                },
                {
                    "member_type_id": 2,
                    "member_id": 789
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.directory.RemoveProperty

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "subdirs": true
        }
    }
}

---

document.directory.Restore

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    }
}

---

document.directory.SetDirectoryDefault

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {
            "access": 12345
        }
    }
}

---

document.directory.SetPropertyValue

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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": 785645,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1",
            "subdirs": true
        }
    }
}

---

document.entry.DirList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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.GetSharingZipperFileList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list Optional: []
• file_id_list - int list Optional: []
• sharing_code - string

Body Data:

• recursive - bool Optional: false
• sharing_pwd - string Optional: ""

Output:

• entries - LIST of struct
  • zip_name - string
  • name - string
  • path - string
  • fs_name - string
  • file_id - int
• storage_id - int

Example:

{
    "header": {
        "target": "document.entry.GetSharingZipperFileList",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "recursive": true,
            "sharing_pwd": "some text"
        }
    }
}

---

document.entry.GetZipperFileList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• dir_id_list - int list Optional: []
• file_id_list - int list Optional: []

Body Data:

• recursive - bool Optional: false

Output:

• entries - LIST of struct
  • zip_name - string
  • name - string
  • path - string
  • fs_name - string
  • file_id - int
• storage_id - int

Example:

{
    "header": {
        "target": "document.entry.GetZipperFileList",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "recursive": true
        }
    }
}

---

document.entry.List

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

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 wimi account setting on wimi.pro",
        "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.file.ActivateSharing

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• file_id - int
• file_master_id - int
• code - string
• file - File
• url - string

Example:

{
    "header": {
        "target": "document.file.ActivateSharing",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.AddComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• file_id - int
• file_master_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.file.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.file.AddTag

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_master_id - int
• label - string

Body Data:

• _encryption - any list Optional: []

Output:

• success - bool
• file_master_id - int
• file_id - int
• tag - Tag

Example:

{
    "header": {
        "target": "document.file.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "_encryption": "no example yet"
        }
    }
}

---

document.file.AttachmentIntoDoc

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool
• file - File

Example:

{
    "header": {
        "target": "document.file.AttachmentIntoDoc",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 98513
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.CheckConflict

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string

Output:

• conflict - bool
• alt_name - string - can be missing

Example:

{
    "header": {
        "target": "document.file.CheckConflict",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.CheckConflicts

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• file_name - string

Output:

• success - bool
• conflict - bool
• conflict_file_id - int - can be missing
• alt_name - string - can be missing

Example:

{
    "header": {
        "target": "document.file.CheckConflicts",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "file_name": "some text"
        }
    }
}

---

document.file.ConversationArchive

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool
• file_master_id - int
• user_id - int

Example:

{
    "header": {
        "target": "document.file.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.ConversationClearUnseen

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool
• file_master_id - int
• user_id - int

Example:

{
    "header": {
        "target": "document.file.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.ConversationSetSilent

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• silent - bool
• silent_until - datetime Optional: null

Output:

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

Example:

{
    "header": {
        "target": "document.file.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

---

document.file.Copy

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string

Output:

• file - File

Example:

{
    "header": {
        "target": "document.file.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

---

document.file.CopyList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id_list - int list Optional: []
• target_project_id - int Optional: null
• dest_dir_id - int Optional: null

Body Data:

• copy_meta - bool Optional: false

Output:

• success - bool
• dir_id - int
• target_project_id - int
• files - LIST of struct - can be missing
  • success - bool
  • file - File - can be missing
  • error - Error - can be missing

Example:

{
    "header": {
        "target": "document.file.CopyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "copy_meta": true
        }
    }
}

---

document.file.DeactivateSharing

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• file_id - int
• file_master_id - int

Example:

{
    "header": {
        "target": "document.file.DeactivateSharing",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.DeleteComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null
• comment_id - int

Output:

• success - bool
• file_id - int
• file_master_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.file.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.Download

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Output:

• md5 - string
• date - string
• name - string
• size - int
• file_path - string - can be missing
• file - File

Example:

{
    "header": {
        "target": "document.file.Download",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.EditComment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null
• comment_id - int

Body Data:

• comment - string
• _encryption - any list Optional: []

Output:

• file_id - int
• file_master_id - int
• comment - Comment

Example:

{
    "header": {
        "target": "document.file.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "comment_id": 122931
        }
    },
    "body": {
        "data": {
            "comment": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.file.EditDescription

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• description - string
• _encryption - any list Optional: []

Output:

• file_id - int
• file_master_id - int
• info - string
• file - File

Example:

{
    "header": {
        "target": "document.file.EditDescription",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "description": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.file.EditName

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• name - string
• _encryption - any list Optional: []

Output:

• name - string
• file_id - int
• file_master_id - int
• file - File

Example:

{
    "header": {
        "target": "document.file.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "_encryption": "no example yet"
        }
    }
}

---

document.file.GetComments

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Output:

• comments - LIST of Comment

Example:

{
    "header": {
        "target": "document.file.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.GetDownloadToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Output:

• token - string

Example:

{
    "header": {
        "target": "document.file.GetDownloadToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.GetEvents

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• events - LIST of FileEvent

Example:

{
    "header": {
        "target": "document.file.GetEvents",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.GetIPTCMetadata

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool
• metadata - LIST of FileMetadata

Example:

{
    "header": {
        "target": "document.file.GetIPTCMetadata",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.GetMetaDataFields

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Output:

• success - bool
• fields - LIST of string

Example:

{
    "header": {
        "target": "document.file.GetMetaDataFields",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {}
    }
}

---

document.file.GetProperties

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_id_list - int list Optional: []

Output:

• file_list - LIST of File

Example:

{
    "header": {
        "target": "document.file.GetProperties",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.GetVersions

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• versions - LIST of File

Example:

{
    "header": {
        "target": "document.file.GetVersions",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.GuestLink

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• url - string
• file - File

Example:

{
    "header": {
        "target": "document.file.GuestLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.IsVersionOf

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• file_md5 - string

Output:

• found - bool

Example:

{
    "header": {
        "target": "document.file.IsVersionOf",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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
        }
    },
    "body": {
        "data": {
            "file_md5": "some text"
        }
    }
}

---

document.file.LinkTag

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_master_id - int
• tag_id - int

Body Data:

• _encryption - any list Optional: []

Output:

• success - bool
• file_master_id - int
• file_id - int
• tag - Tag

Example:

{
    "header": {
        "target": "document.file.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "tag_id": 1193
        }
    },
    "body": {
        "data": {
            "_encryption": "no example yet"
        }
    }
}

---

document.file.Lock

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• force - bool Optional: false

Output:

• file - File

Example:

{
    "header": {
        "target": "document.file.Lock",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

---

document.file.Move

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• operation - string Optional: ""

Output:

• success - bool
• conflicts_count - int
• conflicts - LIST of struct - can be missing
  • file_id - int
  • file_name - string
  • alt_name - string
• nb_files - int - can be missing
• dir_id - int - can be missing
• files - LIST of struct - can be missing
  • error - Error - can be missing
  • success - bool - can be missing
  • file - File - can be missing

Example:

{
    "header": {
        "target": "document.file.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "operation": "some text"
        }
    }
}

---

document.file.MoveToGarbageCollector

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id_list - int list

Body Data:

• force - bool Optional: false

Output:

• success - bool
• files - LIST of struct
  • error - Error - can be missing
  • success - bool - can be missing
  • file_id - int - can be missing

Example:

{
    "header": {
        "target": "document.file.MoveToGarbageCollector",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

---

document.file.MoveToTrash

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id_list - int list

Output:

• success - bool
• files - LIST of struct
  • error - Error - can be missing
  • success - bool - can be missing
  • file_id - int - can be missing
  • id_version_of - int - can be missing

Example:

{
    "header": {
        "target": "document.file.MoveToTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.NotifyOpen

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• file - File

Example:

{
    "header": {
        "target": "document.file.NotifyOpen",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.PathInfo

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Output:

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

Example:

{
    "header": {
        "target": "document.file.PathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.file.RemoveProperty

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool
• file_master_id - int
• file_id - int
• property - Property

Example:

{
    "header": {
        "target": "document.file.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.RemoveTag

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_master_id - int
• tag_id - int

Output:

• success - bool
• file_master_id - int
• file_id - int
• tag - Tag

Example:

{
    "header": {
        "target": "document.file.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "tag_id": 1193
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.RemoveTagByLabel

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_master_id - int
• label - string

Output:

• success - bool
• file_master_id - int
• file_id - int
• tag - Tag

Example:

{
    "header": {
        "target": "document.file.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.RequestPreview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id - int Optional: null
• file_master_id - int Optional: null

Body Data:

• preview_type - string Optional: "default"

Output:

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

Example:

{
    "header": {
        "target": "document.file.RequestPreview",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "preview_type": "some text"
        }
    }
}

---

document.file.Restore

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• file_id_list - int list

Body Data:

• dir_id - int Optional: null

Output:

• success - bool
• files - LIST of struct
  • success - bool
  • file_id - int
  • parent_id - int
  • file - File - can be missing
  • error - int - can be missing
  • error_str - string - can be missing

Example:

{
    "header": {
        "target": "document.file.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "dir_id": 785645
        }
    }
}

---

document.file.SetPropertyValue

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• value - string

Output:

• success - bool
• file_master_id - int
• file_id - int
• property - Property

Example:

{
    "header": {
        "target": "document.file.SetPropertyValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_master_id": 42375,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1"
        }
    }
}

---

document.file.Unlock

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• force - bool Optional: false

Output:

• file - File

Example:

{
    "header": {
        "target": "document.file.Unlock",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

---

document.file.Unversion

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• file - File

Example:

{
    "header": {
        "target": "document.file.Unversion",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {}
    }
}

---

document.file.Upload

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• notify - bool Optional: false
• timestamp - string Optional: ""
• replace_master - bool Optional: false
• md5 - string Optional: ""
• name - string
• info - string Optional: ""
• size - int
• process_thumbnail - bool Optional: false
• _encryption - any list Optional: []
• _encryption_file_master - any list Optional: []

Output:

• file - File
• id_version_of - int

Example:

{
    "header": {
        "target": "document.file.Upload",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "notify": true,
            "timestamp": "some text",
            "replace_master": true,
            "md5": "some text",
            "name": "some text",
            "info": "some text",
            "size": 12345,
            "process_thumbnail": true,
            "_encryption": "no example yet",
            "_encryption_file_master": "no example yet"
        }
    }
}

---

document.general_file.GetDownloadToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• attachment_id - int

Output:

• token - string

Example:

{
    "header": {
        "target": "document.general_file.GetDownloadToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "attachment_id": 98513
        }
    },
    "body": {
        "data": {}
    }
}

---

document.service.BringBack

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string
• format - string Optional: ""

Output:

• success - bool
• file - File - can be missing
• dir_id - int - can be missing - can be null
• old_file_id - int - can be missing - can be null
• url - string - can be missing
• msg - string - can be missing
• formats - LIST of string - can be missing

Example:

{
    "header": {
        "target": "document.service.BringBack",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "format": "some text"
        }
    }
}

---

document.service.CheckToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string

Output:

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

Example:

{
    "header": {
        "target": "document.service.CheckToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "service": "some text"
        }
    }
}

---

document.service.Download

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string
• format - string Optional: ""

Output:

• success - bool
• formats - LIST of string - can be missing
• download_url - string - can be missing
• url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.Download",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "format": "some text"
        }
    }
}

---

document.service.Edit

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string

Output:

• success - bool
• file - File - can be missing
• id_version_of - int - can be missing - can be null
• url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.Edit",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "file_id": 9335546
        }
    },
    "body": {
        "data": {
            "service": "some text"
        }
    }
}

---

document.service.GetEntries

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int

Body Data:

• service - string
• folder_ref - string Optional: ""

Output:

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

Example:

{
    "header": {
        "target": "document.service.GetEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "service": "some text",
            "folder_ref": "some text"
        }
    }
}

---

document.service.ImportEntries

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string
• files - Array
• dir_id - int Optional: null

Output:

• files - LIST of File

Example:

{
    "header": {
        "target": "document.service.ImportEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "service": "some text",
            "files": [
                1,
                2,
                3,
                4
            ],
            "dir_id": 785645
        }
    }
}

---

document.service.LinkDirs

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• service - string
• dirs - Array

Output:

• dirs - LIST of Directory
• dir_id - int

Example:

{
    "header": {
        "target": "document.service.LinkDirs",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": {
            "service": "some text",
            "dirs": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

---

document.sharing.Activate

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• dir_id - int
• code - string
• password - string - can be null

Example:

{
    "header": {
        "target": "document.sharing.Activate",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.AllowInvisibleSub

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Output:

• dir_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.sharing.AllowInvisibleSub",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.AllowUpload

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Output:

• dir_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.sharing.AllowUpload",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.Deactivate

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• dir_id - int

Example:

{
    "header": {
        "target": "document.sharing.Deactivate",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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": 785645
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.DisallowInvisibleSub

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Output:

• dir_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.sharing.DisallowInvisibleSub",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.DisallowUpload

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Output:

• dir_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.sharing.DisallowUpload",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.RemovePassword

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Output:

• item_id - int
• item_type_id - int
• success - bool

Example:

{
    "header": {
        "target": "document.sharing.RemovePassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

---

document.sharing.SetExpirationDate

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Body Data:

• sharing_expiration_date - datetime

Output:

• item_id - int
• item_type_id - int
• success - bool
• sharing_expiration_date - datetime - can be null

Example:

{
    "header": {
        "target": "document.sharing.SetExpirationDate",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_expiration_date": "2016-11-27 17:10:05"
        }
    }
}

---

document.sharing.SetPassword

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

• account_id - int
• user_id - int
• project_id - int
• sharing_code - string

Body Data:

• sharing_pwd - string Optional: ""

Output:

• item_id - int
• item_type_id - int
• success - bool
• password - string

Example:

{
    "header": {
        "target": "document.sharing.SetPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

---

document.trash.EmptyTrash

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Output:

• success - bool

Example:

{
    "header": {
        "target": "document.trash.EmptyTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "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.trash.List

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Header Identification:

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

Body Data:

• query - string Optional: ""
• before_date - datetime Optional: null
• after_date - datetime Optional: null
• deleted_by - int Optional: 0
• order_by - string Optional: ""
• order_by_type - string Optional: ""
• folder_name - string Optional: ""

Output:

• files - LIST of File