WApi Interface

Version: 1.2
Minimum supported version: 1.0
Code version: 6.37.2

Overview

The WApi api can be used through various protocols, in a synchronous or a asynchronous way.

Http request usage:

The usage mode is synchronous.

The WApi web service can be accessed using that url: https://api.wimi.pro.

WApi has to be called in POST mode. The body of the request contains the WApi input message (json format).
The body of the response contains the WApi response (json format).

The HTTP status code returned by the WApi is always 200. Responses errors must be extracted from the response message (body of the response)


Format description

The request and response messages are based on the same format.

Login request example:

{
    "header": {
        "target": "auth.user.login",
        "identification": {
            "account_name": "mywimi"
        },
        "auth": {
            "login": "firstname.lastname@wimi.pro",
            "password": "mypassword"
        },
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "a key that can be used to map the response with the request in async mode"
    },
    "body": {
        "data": null
    }
}

Login response example:

{
    "header": {
        "target": "auth.user.login.info",
        "identification": {
            "account_name": "mywimi"
        },
        "api_version": "1.2",
        "app_token": "You can generate one from your wimi account setting on wimi.pro",
        "msg_key": "a key that can be used to map the response with the request in async mode",
        "token": "MTU0MDAw:MOB--202545756bd71499f9"
    },
    "body": {
            ...
        }
    }
}

So, the response target is the request target + ".info".
The "msg_key" of the response is the same as the request "msg_key".

Globally speaking, the response header is the same as the request header with some adjustments.

The Header format is generic (common to all request / responses).
The Body format is specific to each target - however the error management is generic

Header fields

target

(string) - Used to identify the WApi function called

identification

(optional object) - Used to provide the ids of the various objects used by the function call - the listed entries are specific to the target being called.

"identification": {
    "account_id": 19472,
    "user_id": 154031,
    "project_id": 131213
    }

auth

(optional object) - Used to provide user authentication

  • login: (string) user login
  • password: (string) user password
"auth": {
    "login": "firstname.lastname@wimi.pro",
    "password": "mypassword"
}
                    

token

(optional string) - Used to provide the session token (returned by auth.user.login)

api_version

(string) - Api version used

msg_key

(string) - Message key also returned in the message response

output_format

(optional object) - used to provide output formatting parameters:

  • populate_http_status_code: (bool) used to indicate that the http status code must be returned when the request is made through http. By default, the http status code is always 200
"output_format": {
    "populate_http_status_code": true
}

debug

(optional object) - used to provide special debugging parameters:

  • indent_output: (bool) used to turn on json pretty print format in the response message
"debug": {
    "indent_output": true
}

Body fields

data

(optional object) - Used in the request and response WApi messages.
The format is specific to each target.

error

(optional object) - Only found in response WApi messages.

  • id: (int) id of the error (based on the closest http status code)
  • str: (string) string associated to the id (for bettre readability)
  • debug_msg: (optional string) Additional debug data
  • detail_id: (optional int) error sub type
  • detail_str: (optional string) string associated to the error sub type
"error": {
    "id": 401,
    "str": "Unauthorized",
    "debug_msg": "account not found: myaccount",
    "detail_id": 1022,
    "detail_str": "invalid_account"
}

Contact

If you are having issues using our Api, contact us: support@wimi.pro

Actions List

auth.user.Login Used to login a user and retrieve an access token
auth.user.Logout Used to logout a user
auth.user.RequestNewPassword Used to request an email containing a link to reset the password in case the user forgot it
activity.event.ExportAsCSV export the list of activity events in a CSV file
activity.event.GetList Get a list of activity events
activity.event.GetNextList Ask for the next X results from events
activity.event.GetNotifications Get a list of activity events notified for the contexted user
activity.event.GetUnreadCount Get unread event count by projects
activity.event.MarkAllItemsHistoryAsRead
activity.event.MarkItemsHistoryAsRead
activity.event.NewEvent Get unread event count by projects
calendar.event.AddComment Add a comment to a calendar event
calendar.event.AddExternalAttachment Attach an external file to a calendar event
calendar.event.AddWimiAttachment Attach a wimi file to a calendar event
calendar.event.ChangeInviteStatus Change Status of Agenda Event Participant. Accept / Refuse invite to an event
calendar.event.ConversationArchive Archive a conversation
calendar.event.ConversationClearUnseen Clear unseen count for conversation
calendar.event.ConversationSetSilent Set silent for conversation
calendar.event.CopyEventList
calendar.event.Create Create a calendar event
calendar.event.DeleteComment Delete a calendar event comment
calendar.event.DownloadAttachment Download a calendar event attachment
calendar.event.EditComment Edit a comment of a calendar event
calendar.event.Get Get the details of a calendar events
calendar.event.GetAttachmentList get the list of files attached to a calendar event
calendar.event.GetComments Get teh comments of a calendar event
calendar.event.GetList Get a list of events
calendar.event.GetListUnified Get a list of events for unified calendars
calendar.event.GetSubscriptionLink Get a calendar subscription link
calendar.event.GetUnifiedSubscriptionLink Get calendar subscription link for unified projects
calendar.event.PreviewAttachment Request attachment preview
calendar.event.Remove Delete a calendar event
calendar.event.RemoveExternalAttachment remove an external attachment from the calendar
calendar.event.RemoveRecurrenceOccurrence Delete a recurrence occurrence
calendar.event.RemoveWimiAttachment remove a wimi attachment from the calendar
calendar.event.Update Update a calendar event - only the provided data are updated.
calendar.event.UpdateProject Move a calendar event from one project to another
chat.chat.AddAttachment Attach a file to a chat
chat.chat.AddInternalAttachment Attach a internal file to a chat
chat.chat.AddMembers Add members to a chat
chat.chat.AddUsers Add users to a chat
chat.chat.CanceledTyping Send a notification that the user canceled typing
chat.chat.ClearUnseen Clear unseen count for chat
chat.chat.Create Create a group chat
chat.chat.CreateChannel Create channel chat
chat.chat.DeleteMessage Delete a message
chat.chat.Disable Disable a chat for a user
chat.chat.DownloadAttachment Download a chat attachment
chat.chat.EditMessage Edit a message
chat.chat.EditName Edit a chat name
chat.chat.FavoriteMessage Favorite a message
chat.chat.GetAttachmentList Get attachment list
chat.chat.GetChat Get chat
chat.chat.GetFavorites Get favorite list
chat.chat.GetLinks Get shared links in a chat
chat.chat.GetList Get chat list
chat.chat.GetMessageBeforeAfter Search through chat messages
chat.chat.LoadMessages Get chat messages from offset of given message id, until limit
chat.chat.PostMessage Post message to chat
chat.chat.PreviewAttachment Request attachment preview
chat.chat.RemoveMembers Remove members from a chat
chat.chat.RemoveUsers Remove users from a chat
chat.chat.Search Search through chat messages
chat.chat.SetMessageIntegrationAttachment Set the integration attachment for a message
chat.chat.SetSilent Set silent for chat
chat.chat.StartedTyping Send a notification that the user is typing
chat.chat.UnfavoriteMessage Unfavorite a message
chat.chat.UpdateGroupChatProfilePicture
chat.message.AddMessageReaction Add a reaction for a message
chat.message.DeleteMessageReaction Delete a reaction for a message
comment.comment.GetCommentsForItem Get a specific user commented item
comment.comment.GetUserCommentedItems Get user commented items
document.directory.AddComment Add comment to a directory
document.directory.AddLink Add link to directory
document.directory.AddMembersToDir Add members to dir
document.directory.ConversationArchive Archive a conversation
document.directory.ConversationClearUnseen Clear unseen count for conversation
document.directory.ConversationSetSilent Set silent for conversation
document.directory.Copy Copy a directory elsewhere
document.directory.CopyList Copy a list of directory elsewhere
document.directory.Create Creates a directory
document.directory.CreateDirectoryTree Creates a directory tree when uploading a folder
document.directory.DeleteComment Delete a directory comment
document.directory.DeniedList Get the list of denied directories for a user
document.directory.EditComment Edit a comment of a directory
document.directory.EditMembersAccessToDirectories Edits members access on one or several directories
document.directory.EditName Edits the name of a directory
document.directory.GetComments Get comments of a directory
document.directory.GetDirectoryUsers Get list of all users having access to given directory
document.directory.GetMembersAccess Get users access of a dir
document.directory.GetReadOnlyStateForUser Get the read only state of the directory for the current user
document.directory.LinkPathInfo Get file path info
document.directory.Move Move directories to a folder
document.directory.MoveLink Move links from one directory to another
document.directory.MoveToGarbageCollector Permanently delete one or more directories
document.directory.MoveToTrash Delete one or more directories
document.directory.PathInfo Get directory path info
document.directory.RemoveMembersFromDir Remove members from dir
document.directory.RemoveProperty Remove a property from a directory
document.directory.Restore Restore one or more directories from trash
document.directory.SetDirectoryDefault Get comments of a directory
document.directory.SetPropertyValue Add a property to a directory
document.entry.DirList List folders found in a folder
document.entry.GetProjectTree Get flat tree for project
document.entry.List List the files and folders found in a folder
document.entry.ListServiceEntries List the service entries of a folder
document.entry.TrashList List the files, the link and folders found in the trash
document.file.ActivateSharing Activate sharing on one file
document.file.AddComment Add a file comment
document.file.AddTag Add a tag on a file
document.file.AttachmentIntoDoc Take an attachment from chat or task and add it to the documennt module
document.file.CheckConflict check a file name conflict
document.file.CheckConflicts Check conflicts of a specific name in a folder
document.file.ConversationArchive Archive a conversation
document.file.ConversationClearUnseen Clear unseen count for conversation
document.file.ConversationSetSilent Set silent for conversation
document.file.Copy Copy a file elsewhere
document.file.CopyList Copy a list of file elsewhere
document.file.DeactivateSharing Deactivate sharing on one file
document.file.DeleteComment Delete a file comment
document.file.Download download a file
document.file.EditComment Edit a file comment
document.file.EditDescription Edit a file description
document.file.EditName Edits the name of a file
document.file.GetComments Get the comments of a file
document.file.GetDownloadToken Get a download token to be used only one time.
document.file.GetEvents Get the historical events of a file
document.file.GetIPTCMetadata Get IPTC data for a file
document.file.GetMetaDataFields Get all metadata fields for account
document.file.GetProperties get the properties of a file
document.file.GetVersions Get a file's versions list
document.file.GuestLink Get guest link of a file - DEPRECATED - use ActivateSharing
document.file.IsVersionOf Checks if a version of a file is on the server (by md5)
document.file.LinkTag Link a tag to a file
document.file.Lock Used to lock a file.
document.file.Move Move files to a folder
document.file.MoveToGarbageCollector Permanently delete one or more files
document.file.MoveToTrash Delete one or more files
document.file.NotifyOpen Warn users that a specific file is being opened
document.file.PathInfo Get file path info
document.file.RemoveProperty Remove a property from a file
document.file.RemoveTag Remove a tag in a file
document.file.RemoveTagByLabel Remove a tag in a file using the label
document.file.Restore Restore one or more files
document.file.SetPropertyValue Set a property to a file
document.file.Unlock Used to unlock a file.
document.file.Unversion Unversion one file
document.file.Upload Upload a file
document.service.BringBack Bring backs a service file back to the wimi (and removes the .html in wimi if it succeeds). Only works with google ATM.
document.service.CheckToken Check service token
document.service.Download Directly download the document from the service. Only google is supported right now.
document.service.Edit Edit (and upload) a file to service. Only google is supported right now.
document.service.GetEntries Get service entries
document.service.ImportEntries Import service entries
document.service.LinkDirs Link directories from service entries
document.sharing.Activate Activate sharing on one directory
document.sharing.AllowInvisibleSub Allow invisible subdirectories on a shared folder
document.sharing.AllowUpload Allow upload on a given shared folder
document.sharing.Deactivate Deactivate sharing on one directory
document.sharing.DisallowInvisibleSub Disallow invisible subs on a shared folder
document.sharing.DisallowUpload Disallow upload on a given shared folder
document.sharing.RemovePassword Remove a password of a shared folder
document.sharing.SetExpirationDate Set an expiration date for an item
document.sharing.SetPassword Set a password for an item
document.trash.EmptyTrash Empty the trash
document.trash.List List the files found in the trash given a set of filters
document.trash.RestoreFile Restore one or more files
document.validation.AddValidatorsToRequest Add validators to a doc validation request
document.validation.CreateRequest Create a doc validation request
document.validation.EditRequestDescription Edit doc validation request description
document.validation.ListRequests List all doc validation requests for that user
document.validation.ListRequestsAsRequester List all doc validation requests associated to a requester
document.validation.ListRequestsAsValidator List all doc validation requests associated to a validator
document.validation.ListResponses List all doc validation responses for a user
document.validation.RemindValidator send a reminder email to a validator
document.validation.RemoveRequest Remove a doc validation request
document.validation.RemoveValidatorsFromRequest Remove validators from a doc validation request
document.validation.ResetResponseStatus Reset a response for a validator
document.validation.UpdateRequestExpiryDate Update expiry date of a doc validation request
document.validation.UpdateRequestStatus Update status of a doc validation request
document.validation.UpdateResponseStatus Update a response for a validator
gantt.gantt.AddList Add a list to gantt view
gantt.gantt.BatchAddList Add lists to gantt view
gantt.gantt.BatchRemoveList Batch remove lists from gantt view
gantt.gantt.RemoveList Remove a list from gantt view
link.link.AddComment Add a link comment
link.link.AddTag Add a tag on a link
link.link.ConversationArchive Archive a conversation
link.link.ConversationClearUnseen Clear unseen count for conversation
link.link.ConversationSetSilent Set silent for conversation
link.link.CopyLink Copy links from one directory into another
link.link.DeleteComment Delete a link comment
link.link.Edit Edit url and/or title of link
link.link.EditComment Edit a link comment
link.link.GetComments Get comments of a link
link.link.GetEvents Get the historical events of a link
link.link.LinkTag Link a tag to a link
link.link.PathInfo Get link path info
link.link.RemoveTag Remove a tag in a link
link.link.RemoveTagByLabel Remove a tag in a link using the label
link.link.RestoreLink Restore link from trash
link.link.TrashLink Put a list of links to trash
main.account.ActivateUsers Activate list of users
main.account.AddUser Add a user
main.account.DeactivateUsers Deactivate list of users
main.account.DeleteAccount Delete the account
main.account.DeleteUsers Delete list of users permanently
main.account.EditCategory Edit a category
main.account.EditUser Edit a user
main.account.ExportUsers Export users in a file
main.account.ExportUsersRights Export users rights in a file
main.account.GenerateAPIKey Generate an API Key for the current account
main.account.Get Get account info
main.account.GetAccountExternalInfo Get external information for an account
main.account.GetActivityRelatedRequestList Get wapi routes that should update the activity unread counter
main.account.GetAllAvailableUsers Get all available users. Which mean a status will be returned.
main.account.GetBillingInfo List offers for account
main.account.GetCalendars Get the calendars of a user
main.account.GetCategories Get categories of a user
main.account.GetGAppsUsers Get gapps users and format the output to correspond the ones of Wimi
main.account.GetListOfUsersSharingSameProjects Get list of users sharing the same projects
main.account.GetMemberProjectsAuth Get list of privileges on projects for a member
main.account.GetProject Get a user project
main.account.GetProjectTemplates Get the project templates for that account
main.account.GetProjects Get projects of a user
main.account.GetProjectsStats Get projects stats for user available projects
main.account.GetServiceUsers Get the users of the given service and format the output to correspond the ones of Wimi
main.account.GetSettings Get settings for the account
main.account.GetTutorialInfo Return the necessary info to display the welcome tutorial
main.account.GetUser Get a user
main.account.GetUserProjectsAuth Get list of privileges on projects for a user
main.account.GetUsers Get all users
main.account.ImportGAppsUser Import a gapps user in wimi
main.account.ImportUsersFromCSV Import users from csv
main.account.RegenerateGeneralPassword Regenerate the password of the Wimi Backup user of this account
main.account.RemoveAPIKey Remove an API Key for the current account
main.account.SelfDeactivate Deactivate the current user
main.account.SetBillingInfo Set billing info of account
main.account.SetSettings Set settings for the account
main.account.SetUISetting Customization - set ui settings
main.account.SetWelcomeActivity Set welcome activity
main.account.ToggleThirdPartyService Enable/Disable a third party service for the account
main.group.AddMember Add a member to a group
main.group.AddTag Add a tag on a user group
main.group.BatchAddMembers Batch add members to a group
main.group.Create Create a user group
main.group.Delete Delete a user group
main.group.Edit Edit a user group
main.group.LinkTag Link a tag to a group
main.group.List List the user group of this account
main.group.RemoveMember Remove a member from a group
main.group.RemoveTag Remove a tag in a user group
main.group.RemoveTagByLabel Remove a tag in a user group using the label
main.project.ActivateModules Activate modules on a project
main.project.AddTag Add a tag on a project
main.project.Archive Archive a project
main.project.Create Create a project
main.project.CreateFromTemplate Create a project given a template
main.project.DeactivateModules Deactivate modules on a project
main.project.Delete Delete a project definitely
main.project.GetProjectTagCountInFamily
main.project.GetTemplateList Get list of templates for this account / user
main.project.GetUsersAuth Get list of all users auth on that project
main.project.GetUsersList Get list of all users in a project (via user_id)
main.project.LinkTag Link a tag to a project
main.project.RemoveTag Remove a tag in a project
main.project.RemoveTagByLabel Remove a tag in a project using the label
main.project.RemoveTagFamilyRestriction Remove tag family restriction
main.project.RemoveUserGroups Removes user groups from a project
main.project.RemoveUsers Removes users from a project
main.project.ReplaceUser Replace a user in another in a project
main.project.Restore Unarchive a project
main.project.SetDriveSync Enable/Disable the drive synchronisation for all users
main.project.SetMemberAuth Set the member auth on a project
main.project.SetTagFamilyRestriction Set tag family restriction
main.project.SetUserAuth Set the user auth on a project
main.project.SetUserGroupAuth Set the user group auth on a project
main.project.Update Update a project.
main.project.UpdateDefaultModule Update default module
main.saml.CreateServiceToken Create a token that can be used by an external service to create a limited access token for that user
main.saml.GetAccountList Get a list of account associated to the user linked to the given access token
main.search.AddRecentSearch Add search to recent search user history
main.search.ClearSearchHistory Clear search history for specified user
main.search.GetUserRecentSearch Get user recent search history
main.search.Search Search items in the wimi with a query
main.search.SearchMore Ask for the next X results from Wimi's global search
main.search.SearchProjects Search through projects in the wimi with a query
main.session.Load Load some info about the session
main.tag.AddTagsToFamilies remove a family tag tag
main.tag.BatchMergeTags merge several tags into another
main.tag.BatchRemove remove several tags
main.tag.ChangeColor Change the color of a tag
main.tag.Create create a tag
main.tag.CreateFamily create a family tag
main.tag.Get get a tag
main.tag.GetAll get all tags for this account
main.tag.GetByLabel get a tag by its label
main.tag.GetFamilyTags get a family tag
main.tag.GetStats get tags stats for this account
main.tag.ImportFromCSV Import tags from csv
main.tag.MergeTags merge one tag into another
main.tag.Remove remove a tag (globally)
main.tag.RemoveFamilyTag remove a family tag tag
main.tag.RemoveTagsFromFamily remove a family tag tag
main.tag.Rename rename a tag (globally)
main.tag.UpdateFamily update a family tag
main.user.AddTag Add a tag on a user
main.user.BatchUpdateProperty Batch add or update properties for the user
main.user.CreateLimitedToken Create a token with restricted accesses to be used instead of the auth token from external applications
main.user.CreateLimitedTokenForService Create a token with restricted accesses for a specific service
main.user.CreateServiceToken Create a token that can be used by an external service to create a limited access token for that user
main.user.DeleteLimitedToken Delete a limited token
main.user.DeleteServiceToken Delete a user service token
main.user.EditArmouredDevice Add or edit a device
main.user.EditAvatar Update the avatar of a user
main.user.GetArmouredDeviceList Get all the device added and usable
main.user.GetCaldavSyncSettings Get Caldav synchronization settings
main.user.GetGlobalStatus Get global status of a user.
main.user.GetNotificationSettings get user notification settings (enabled/disabled)
main.user.GetSelf Get self user
main.user.GetTankerSecret Return the tanker secret for current user
main.user.GetUserServicesInfo Get third party services info for a user
main.user.LinkTag Link a tag to a user
main.user.ListProperties Get all the user properties
main.user.RemoveProperty Remove a property for the user
main.user.RemoveTag Remove a tag in a user
main.user.RemoveTagByLabel Remove a tag in a user using the label
main.user.RevokeService Revoke a third party service for a user
main.user.SendArmouredVerificationEmail Send a mail to the user so he can validate his identity
main.user.SetNotificationSettings set user notification settings (enabled/disabled)
main.user.SetProjectCaldavSync Set Caldav synchronization for a project
main.user.SetStatus Set the status of the user. Status is linked to the session_id.
main.user.SetUserLanguage Set a user language
main.user.SetUserStatus Set the status of the user.
main.user.Update Update the user information
main.user.UpdateProperty Add or update a property for the user
main.util.GetSpecificTrad Get specific trad in specific lang
meeting.meeting.Add Add a meeting
meeting.meeting.AddDates Add dates to a meeting
meeting.meeting.AddExternalParticipants Add external participants to a meeting
meeting.meeting.AddInternalParticipants Add internal participants to a meeting
meeting.meeting.Delete Delete a meeting
meeting.meeting.Edit Edit a meeting
meeting.meeting.FixDate Fix a date
meeting.meeting.Get Get a meeting
meeting.meeting.GetList Get meetings
meeting.meeting.RemoveParticipants Remove participants from a meeting
meeting.meeting.UnfixDate Unfix a date
meeting.meeting.UpdateStatus Add external users to a meeting
reporting.task.Burndown Get burndown
reporting.task.Load Load all stats
reporting.task.Performance Get performance
reporting.task.Status Get status
reporting.task.Tags Get tags
reporting.task.Workload Get workload
sharing.sharing.Download Download a file from a sharing folder
sharing.sharing.DownloadFile Download a file from a sharing file
sharing.sharing.Folder List entries of folder
sharing.sharing.Load Get information required to load sharing doc page
sharing.sharing.LoadFile Get information required to load file sharing page
sharing.sharing.RequestLinkPreview
sharing.sharing.Upload Upload a file via a sharing folder
task.filter.Add Adds a filter on tasks to the project or on unified tasks
task.filter.Apply Apply a filter on the tasks of the given projects
task.filter.Delete Delete a filter
task.filter.Edit Edits a filter on tasks
task.filter.Get Get a tasks filter
task.filter.List List tasks filters
task.filter.ListUnified List unified tasks filters
task.subtask.AddOwners Add Owner to a subtask
task.subtask.ChangeStatus Change status of a subtask
task.subtask.Create Create a subtask for the given task
task.subtask.Delete Delete a subtask
task.subtask.Move Move a subtask to another position (and/or task)
task.subtask.RemoveOwners Add Owner to a subtask
task.subtask.Update Update a subtask
task.task.AddBatchOwner Get all tasks of a list
task.task.AddComment Add a comment to a task
task.task.AddExternalAttachment Attach an external file to a task
task.task.AddReminder Add a reminder for a task
task.task.AddTag Add a tag in a task
task.task.AddWimiAttachment Attach a wimi file to a task
task.task.BatchDelete Delete a batch of tasks
task.task.BatchDuplicate Copy a batch of tasks
task.task.BatchLinkTag Link a tag to a list of tasks
task.task.BatchMove Move a batch of tasks to a position
task.task.BatchMoveAfter Move a batch of tasks after another
task.task.BatchRemoveTag Remove a tag in list of tasks
task.task.ChangeStatus Change the status of a given task
task.task.ChangeStatusBulk Change the status of several tasks
task.task.ConversationArchive Archive conversation
task.task.ConversationClearUnseen Clear unseen count for conversation
task.task.ConversationSetSilent Set silent for conversation
task.task.Create Create a task
task.task.Delete Delete a task
task.task.DeleteComment Delete a task comment
task.task.DeleteDates Delete Dates from a Task
task.task.DisableRecurrence Disable a recurrence for a task
task.task.DownloadAttachment Attach a file to a task
task.task.Duplicate Copy a task
task.task.EditComment Edit a comment of a task
task.task.Follow Add self as follower to this task
task.task.GenerateNextOccurrence Generate the next occurrence of a task
task.task.Get Get a task with all its data
task.task.GetAll Get all tasks of a list
task.task.GetAttachmentList Get the list of files attached to a task
task.task.GetNbNotCompletedForProject Get the total amount of not completed tasks for the given project
task.task.History Get a task history
task.task.LinkTag Link a tag to a task
task.task.Move Move a task to new position
task.task.MoveAfter Move a task after another
task.task.PreviewAttachment Request attachment preview
task.task.Relocate Relocate a task in an other project
task.task.RemoveBatchOwners Get all tasks of a list
task.task.RemoveExternalAttachment remove an external attachment from the task
task.task.RemoveReminder Remove a reminder for a task
task.task.RemoveTag Remove a tag in a task
task.task.RemoveTagByLabel Remove a tag in a task using the label
task.task.RemoveWimiAttachment Remove a wimi attachment from a task
task.task.SendReminder send a reminder to the owners of a task
task.task.SetRecurrence Set or update a recurrence for the given task
task.task.ToggleDefaultOverdueAlert Add or remove the default overdue alert for a task
task.task.Unfollow Remove self as follower from this task
task.task.Update Update a task
task.tlist.AddLink Create a link between 2 lists given a specific relation type
task.tlist.BatchSetHidden Set the tasks lists the user does not want to display
task.tlist.ChangeLine Change line in gantt view
task.tlist.Copy
task.tlist.Create Create a task list
task.tlist.Dashboard Get all necessary data for displaying the tasks module dashboard
task.tlist.DashboardGlobal Get all necessary data for displaying the tasks module dashboard
Same as dashboard but for a user, not a project
task.tlist.Delete Delete a task list
task.tlist.ExportAsCSV Exports all tasks and lists of a project as csv
task.tlist.ExportAsXLS Exports all tasks and lists of a project as XLS
task.tlist.ExportFilteredAsXLS Exports all tasks and lists as csv given filter options
task.tlist.Follow Add self as follower to this list
task.tlist.GetAcceptedTasks Get all Tasks that are accepted
task.tlist.GetAll Returns all tasks lists of a project
task.tlist.GetList Returns a task list with its stats
task.tlist.ImportFromCSV Import tasks and lists from csv
task.tlist.ImportFromXLS Import tasks and lists from xls
task.tlist.Move Move a task list
task.tlist.RemoveLink Remove link between 2 lists
task.tlist.Unfollow Remove self as follower from this list
task.tlist.Update Update a task list
task.tlist.UpdateDates Move a list in a line
task.tlist.UpdateExcludeAcceptedTask
task.trash.List List all trashed tasks lists and their tasks (also trashed)

Actions


auth.user.Login

Used to login a user and retrieve an access token
The account must be valid and the user must be activated

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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.RequestNewPassword

Used to request an email containing a link to reset the password in case the user forgot it

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

activity.event.ExportAsCSV

export the list of activity events in a CSV file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "type_list": [
                12345,
                12346
            ],
            "csv_delimiter": "some text",
            "csv_enclosure": "some text",
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true
        }
    }
}

activity.event.GetList

Get a list of activity events
Get a list of activity events based on the given parameters

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                12345,
                12346
            ]
        }
    }
}

activity.event.GetNextList

Ask for the next X results from events
If we are only displaying the first 100 results, this request should return the next 100 results, etc...

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                12345,
                12346
            ],
            "current_result_count": 12345
        }
    }
}

activity.event.GetNotifications

Get a list of activity events notified for the contexted user
Get a list of activity events notified for the contexted user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

Get unread event count by projects

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "type_list": [
                12345,
                12346
            ]
        }
    }
}

activity.event.MarkItemsHistoryAsRead

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

activity.event.NewEvent

Get unread event count by projects

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

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

Add a comment to a calendar event

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Body Data:

  • comment - string

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

calendar.event.AddExternalAttachment

Attach an external file to a calendar event

Push information:

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

Url:

https://api.files.wimi.pro

Call type:

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

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "file_timestamp": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

calendar.event.AddWimiAttachment

Attach a wimi file to a calendar event

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ChangeInviteStatus

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • status - int

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

calendar.event.ConversationArchive

Archive a conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ConversationClearUnseen

Clear unseen count for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ConversationSetSilent

Set silent for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

calendar.event.CopyEventList

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • recurrence_id_list - Array Optional: stdClass Object ( )

Output:

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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "recurrence_id_list": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

calendar.event.Create

Create a calendar event

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • event - struct

Output:

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

Delete a calendar event comment
Mark the message as deleted, does not delete it entirely

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "calendar.event.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.DownloadAttachment

Download a calendar event attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.EditComment

Edit a comment of a calendar event

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Body Data:

  • comment - string

Output:

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": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

calendar.event.Get

Get the details of a calendar events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetAttachmentList

get the list of files attached to a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetComments

Get teh comments of a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetList

Get a list of events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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:

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": [
                12345,
                12346
            ],
            "view_busy": true,
            "busy_user_id_list": [
                12345,
                12346
            ],
            "view_empty_events": true,
            "calendar_event_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "modified_after": 12345
        }
    }
}

calendar.event.GetListUnified

Get a list of events for unified calendars

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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:

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": [
                12345,
                12346
            ],
            "project_id_list": [
                12345,
                12346
            ],
            "user_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "view_empty_events": true
        }
    }
}

calendar.event.GetSubscriptionLink

Get a calendar subscription link

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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

Get calendar subscription link for unified projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


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": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

calendar.event.Remove

Delete a calendar event

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

  • event_id - int
  • success - bool

Example:

{
    "header": {
        "target": "calendar.event.Remove",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.RemoveExternalAttachment

remove an external attachment from the calendar

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "calendar.event.RemoveExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.RemoveRecurrenceOccurrence

Delete a recurrence occurrence

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • recurrence_id - datetime

Output:

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

Example:

{
    "header": {
        "target": "calendar.event.RemoveRecurrenceOccurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "recurrence_id": "2016-11-27 17:10:05"
        }
    }
}

calendar.event.RemoveWimiAttachment

remove a wimi attachment from the calendar

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "calendar.event.RemoveWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.Update

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

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • event - struct

Output:

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

Example:

{
    "header": {
        "target": "calendar.event.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

calendar.event.UpdateProject

Move a calendar event from one project to another

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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": 12345,
            "target_project_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddAttachment

Attach a file to a chat

Push information:

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

Url:

https://api.files.wimi.pro

Call type:

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

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "attachment_title": "some text",
            "attachment_description": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

chat.chat.AddInternalAttachment

Attach a internal file to a chat

Push information:

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

Url:

https://api.files.wimi.pro

Call type:

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

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Output:

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": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddMembers

Add members to a chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddUsers

Add users to a chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.CanceledTyping

Send a notification that the user canceled typing

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.ClearUnseen

Clear unseen count for chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.Create

Create a group chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

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

Output:

  • success - bool
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": [
                12345,
                12346
            ],
            "user_groups": [
                12345,
                12346
            ],
            "name": "some text",
            "use_existing": true,
            "force_creation": true
        }
    }
}

chat.chat.CreateChannel

Create channel chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

Delete a message
Mark the message as deleted, does not delete it entirely

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • message_index - int Optional: 0

Output:

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.Disable

Disable a chat for a user
Remove the chat from the recent chats

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.DownloadAttachment

Download a chat attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.EditMessage

Edit a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • message - string
  • message_index - int Optional: 0

Output:

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "message_index": 12345
        }
    }
}

chat.chat.EditName

Edit a chat name

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • name - string

Output:

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

Example:

{
    "header": {
        "target": "chat.chat.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

chat.chat.FavoriteMessage

Favorite a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.GetAttachmentList

Get attachment list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetChat

Get chat
with or without messages, default with

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {
            "with_messages": true,
            "limit": 12345
        }
    }
}

chat.chat.GetFavorites

Get favorite list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetLinks

Get shared links in a chat

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetList

Get chat list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • comment_count - bool Optional: false

Output:

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": {
            "comment_count": true
        }
    }
}

chat.chat.GetMessageBeforeAfter

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • message_index - int Optional: 0

Output:

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.LoadMessages

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {
            "offset": 12345,
            "limit": 12345
        }
    }
}

chat.chat.PostMessage

Post message to chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "integration_attachment": "no example yet"
        }
    }
}

chat.chat.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

chat.chat.RemoveMembers

Remove members from a chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.RemoveUsers

Remove users from a chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.Search

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • search - string

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "search": "some text"
        }
    }
}

chat.chat.SetMessageIntegrationAttachment

Set the integration attachment for a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

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

Output:

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet"
        }
    }
}

chat.chat.SetSilent

Set silent for chat

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

chat.chat.StartedTyping

Send a notification that the user is typing

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.UnfavoriteMessage

Unfavorite a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.UpdateGroupChatProfilePicture

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345,
            "name": "some text",
            "size": 12345
        }
    }
}

chat.message.AddMessageReaction

Add a reaction for a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • reaction - Emoji

Output:

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

Example:

{
    "header": {
        "target": "chat.message.AddMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

chat.message.DeleteMessageReaction

Delete a reaction for a message

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Body Data:

  • reaction - Emoji

Output:

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

Example:

{
    "header": {
        "target": "chat.message.DeleteMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

comment.comment.GetCommentsForItem

Get a specific user commented item

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

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

Output:

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

Get user commented items

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

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

document.directory.AddComment

Add comment to a directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Body Data:

  • comment - string

Output:

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": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.directory.AddLink

Add link to directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • url - string
  • title - string

Output:

  • success - bool
  • link - Link

Example:

{
    "header": {
        "target": "document.directory.AddLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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"
        }
    }
}

document.directory.AddMembersToDir

Add members to dir
Return all users having access to dir

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.AddMembersToDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationArchive

Archive a conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationClearUnseen

Clear unseen count for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationSetSilent

Set silent for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

document.directory.Copy

Copy a directory elsewhere

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • name - string

Output:

  • dir_id - int

Example:

{
    "header": {
        "target": "document.directory.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.directory.CopyList

Copy a list of directory elsewhere

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • copy_meta - bool Optional: false

Output:

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

Example:

{
    "header": {
        "target": "document.directory.CopyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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

Creates a directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • name - string

Output:

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

document.directory.CreateDirectoryTree

Creates a directory tree when uploading a folder

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

document.directory.DeleteComment

Delete a directory comment
Mark the message as deleted, does not delete it entirely

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.DeniedList

Get the list of denied directories for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

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

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.EditComment

Edit a comment of a directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Body Data:

  • comment - string

Output:

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": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.directory.EditMembersAccessToDirectories

Edits members access on one or several directories

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

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

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • dir_access_array - assoc array int to in

Output:

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

Example:

{
    "header": {
        "target": "document.directory.EditMembersAccessToDirectories",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {
            "dir_access_array": {
                "1": 0,
                "2": 1,
                "5": 2
            }
        }
    }
}

document.directory.EditName

Edits the name of a directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • name - string

Output:

  • name - string
  • dir_id - int

Example:

{
    "header": {
        "target": "document.directory.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.directory.GetComments

Get comments of a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetDirectoryUsers

Get list of all users having access to given directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetMembersAccess

Get users access of a dir

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetReadOnlyStateForUser

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.LinkPathInfo

Get file path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.Move

Move directories to a folder

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • conflict_rename - bool Optional: false

Output:

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

Example:

{
    "header": {
        "target": "document.directory.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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

Move links from one directory to another

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.MoveLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.MoveToGarbageCollector

Permanently delete one or more directories

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

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

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.MoveToGarbageCollector",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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

Delete one or more directories

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.MoveToTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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

Get directory path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.RemoveMembersFromDir

Remove members from dir
Return all users having access to dir

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Output:

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

Example:

{
    "header": {
        "target": "document.directory.RemoveMembersFromDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.RemoveProperty

Remove a property from a directory

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • subdirs - bool Optional: false

Output:

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

Example:

{
    "header": {
        "target": "document.directory.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "subdirs": true
        }
    }
}

document.directory.Restore

Restore one or more directories from trash

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • dir_id - int Optional: null

Output:

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

Example:

{
    "header": {
        "target": "document.directory.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    }
}

document.directory.SetDirectoryDefault

Get comments of a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • access - int Optional: 0

Output:

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

Example:

{
    "header": {
        "target": "document.directory.SetDirectoryDefault",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345
        }
    },
    "body": {
        "data": {
            "access": 12345
        }
    }
}

document.directory.SetPropertyValue

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

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • value - string
  • subdirs - bool Optional: false

Output:

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

Example:

{
    "header": {
        "target": "document.directory.SetPropertyValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your 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": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1",
            "subdirs": true
        }
    }
}

document.entry.DirList

List folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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.GetProjectTree

Get flat tree for project
Get a flat tree, ordered by path

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

Example:

{
    "header": {
        "target": "document.entry.GetProjectTree",
        "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.List

List the files and folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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:

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

List the service entries of a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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

Activate sharing on one file

Push information:

Pushing to: Project users
With target: document.file.ActivateSharing
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.AddComment

Add a file comment

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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

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

document.file.AddTag

Add a tag on a file

Push information:

Pushing to: Project users
With target: document.file.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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.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": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

document.file.AttachmentIntoDoc

Take an attachment from chat or task and add it to the documennt module
Take an attachment from chat or task and add it to the document module

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.CheckConflict

check a file name conflict

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • name - string

Output:

  • 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

Check conflicts of a specific name in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • 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

Archive a conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.ConversationClearUnseen

Clear unseen count for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.ConversationSetSilent

Set silent for conversation

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

document.file.Copy

Copy a file elsewhere

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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:

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": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.file.CopyList

Copy a list of file elsewhere

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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

Deactivate sharing on one file

Push information:

Pushing to: Project users
With target: document.file.DeactivateSharing
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.DeleteComment

Delete a file comment
Mark the message as deleted, does not delete it entirely

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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 (parameter needs to be owned by api user)

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Download

download a file
The file content is returned in the message body.


The wapi json message is returned in the X-Wimi-WApi http header of the response and needs to be decoded using the function equivalent to the php function rawurldecode.

The download web request needs to be performed on the filer domain (e.g. api.files.wimi.pro) instead of the standard domain (api.wimi.pro).

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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

Edit a file comment

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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 (parameter needs to be owned by api user)

Body Data:

  • comment - string

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": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.file.EditDescription

Edit a file description

Push information:

Pushing to: Project users
With target: document.file.EditDescription
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • description - string

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": 12345
        }
    },
    "body": {
        "data": {
            "description": "some text"
        }
    }
}

document.file.EditName

Edits the name of a file

Push information:

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

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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

Body Data:

  • name - string

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": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.file.GetComments

Get the comments of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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

Get a download token to be used only one time.
Token to be used in .files./download.php?download_token=
The token generated is set in memcache.
It will be removed automatically from memcache after 1 min or when it has been used.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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

Get the historical events of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetIPTCMetadata

Get IPTC data for a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

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

Output:

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

Get all metadata fields for account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

get the properties of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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

Get a file's versions list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GuestLink

Get guest link of a file - DEPRECATED - use ActivateSharing

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.IsVersionOf

Checks if a version of a file is on the server (by md5)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

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

Link a tag to a file

Push information:

Pushing to: Project users
With target: document.file.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


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.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": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Lock

Used to lock a file.
By default, you cannot lock a file if is it already locked by a different user. Use the  force parameter to perform the action regardless of that constraint.

Push information:

Pushing to: Project users
With target: document.file.Lock
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

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

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

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