Developer GuideList of Basic APIs
APIs for Obtaining Access Credentials
| API | API description | API version |
|---|---|---|
| Obtain the access_token of an internal app | Call this API to obtain the access_token. When you call a Server API to obtain app resources, use the access_token to authenticate the caller’s identity and grant authorization. | Server-side |
| Obtain the access token of an internal app | Call this API to obtain the access_token. When you call a Server API to obtain app resources, use the access_token to authenticate the caller’s identity and grant authorization. | New Server-side |
| Obtain the access_token of a third-party personal app | Call this API to obtain the access_token of a Third-party personal app. | Server-side |
| Obtain the user token | Call this API to obtain the user token. | New Server-side |
| Obtain the jsapi_ticket | When developing an H5 Micro app, first call this API to obtain the jsapi_ticket, then generate the authentication signature, and finally call dd.config to complete authentication. | Server-side |
| Create a jsapi ticket | When developing an H5 Micro app, first call this API to obtain the jsapi_ticket, then generate the authentication signature, and finally call dd.config to complete authentication. | New Server-side |
| Obtain the access_token for silent login to the Micro app backend | Call this API to obtain the access_token for silent login to the Micro app backend. The obtained access_token, that is, the ssotoken, is used only in the App Management backend silent login scenario. | Server-side |
| Obtain the access_token for silent login to the Micro app backend | Call this API to obtain the access_token for silent login to the Micro app backend. The obtained access_token is used only in the App Management backend silent login scenario. | New Server-side |
| Query individual authorization records | When you need to query a user’s authorization records, call this API to query the individual authorization records of the user. | New Server-side |
Authentication (Silent Login) APIs
| API | API description | API version |
|---|---|---|
| Obtain user information using the silent login code | In the silent login scenarios for a Third-party enterprise app and an Internal app, use this API to obtain the user ID via the access_token and the code obtained from the silent login API. | Server-side |
| Obtain the user information for App Management backend silent login | In the App Management backend silent login scenario, use this API to exchange the obtained silent login authorization code and the obtained app backend silent login access_token for the app admin’s identity information. | Server-side |
| Obtain the user information for App Management backend silent login | In the App Management backend silent login scenario, use this API to exchange the obtained silent login authorization code and the obtained app backend silent login access_token for the app admin’s identity information. | New Server-side |
| Obtain user information based on the SNS temporary authorization code | Call this API to obtain user information based on the SNS temporary authorization code. | Server-side |
Contacts Management APIs
User Management| API | API description | API version |
|---|---|---|
| Create a user | Call this API to create a new user. | Server-side |
| Update user information | Call this API to update the specified user information. | Server-side |
| Query user details | Call this API to obtain the detailed information of a specified user. | Server-side |
| Delete a user | Call this API to delete a specified user by the user ID. | Server-side |
| Obtain the basic information of department users | Call this API to obtain the basic information of users in a specified department. | Server-side |
| Obtain the details of department users | Call this API to obtain the detailed information of users in a specified department. | Server-side |
| Obtain the list of department user IDs | Call this API to obtain the user ID list of a specified department. | Server-side |
| Obtain the number of employees | Call this API to obtain the number of employees. | Server-side |
| Obtain the list of employees who have not signed in to DingTalk | Call this API to query the list of employees who have not signed in to DingTalk within a specified date range. | Server-side |
| Query users by phone number | Call this API to obtain the user ID of a dedicated account user by phone number. | Server-side |
| Obtain the user ID by unionid | Call this API to obtain a user’s user ID by unionid. | Server-side |
| Obtain the admin list | Call this API to query the admin list. | Server-side |
| Obtain the admin’s Contacts permission scope | Call this API to obtain the admin’s Contacts permission scope. | Server-side |
| Query the list of resignation records | Call this API to query the list of resignation records for an organization, including the resignation date, phone number, and Leave Organization method of resigned employees. | New Server-side |
| Configure executive mode | Call this API to configure the executive mode for an employee. | New Server-side |
| Obtain a user’s executive mode settings | Call this API to obtain a user’s executive mode settings. | New Server-side |
| Delete user attribute visibility settings | Call this API to delete the attribute field visibility settings of an organization employee. | New Server-side |
| Obtain user attribute visibility settings | Call this API to obtain user attribute visibility settings. | New Server-side |
| Configure user attribute visibility | Call this API to configure user attribute visibility. | New Server-side |
| Obtain a user’s Profile from Contacts | Call this API to obtain the Profile of an organization user from Contacts. | New Server-side |
| API | API description | API version |
|---|---|---|
| Create a department | Call this API to create a new department. | Server-side |
| Update a department | Call this API to update department information. | Server-side |
| Delete a department | Call this API to delete a specified department by department ID. | Server-side |
| Obtain department details | Call this API to obtain the details of a specified department by department ID. | Server-side |
| Obtain the department list | Call this API to obtain the basic information of the next-level departments. | Server-side |
| Obtain the list of sub-department IDs | Call this API to obtain the list of all direct sub-departments under an organization department. | Server-side |
| Obtain the list of all parent departments of a department | Call this API to obtain the list of all parent department IDs of a specified department. | Server-side |
| Obtain the list of all parent departments of a user | Call this API to query all parent departments to which a specified user belongs. | Server-side |
| API | API description | API version |
|---|---|---|
| Create a role | Call this API to create a new role. | Server-side |
| Create a role group | Call this API to create a role group. | Server-side |
| Update a role name | Call this API to update a role name. | Server-side |
| Add roles to employees in batches | Call this API to add roles to employees in batches. | Server-side |
| Delete a role | Call this API to delete a specified role by role ID. | Server-side |
| Delete employee roles in batches | Call this API to delete employee roles in batches. | Server-side |
| Configure the member management scope of a role | Call this API to configure the member management scope of a role. | Server-side |
| Obtain the role group list | Call this API to obtain role group information. | Server-side |
| Obtain the role list | Call this API to obtain the role list. | Server-side |
| Obtain role details | Call this API to obtain the details of a specified role by role ID. | Server-side |
| Obtain the employee list of a specified role | Call this API to obtain the employee list of a specified role. | Server-side |
| API | API description | API version |
|---|---|---|
| Add an External contact | Call this API to add an organization External contact. | Server-side |
| Delete an External contact | Call this API to delete an organization External contact. | Server-side |
| Update an External contact | Call this API to update an organization External contact. | Server-side |
| Obtain the External contacts list | Call this API to obtain the organization External contacts list. | Server-side |
| Obtain the External contacts tag list | Call this API to obtain the tags of organization External contacts. | Server-side |
| Obtain External contact details | Call this API to obtain the detailed information of an organization External contact. | Server-side |
| API | API description | API version |
|---|---|---|
| Obtain organization invitation information | Call this API to obtain the invitation information of an organization. | New Server-side |
| Obtain the latest DingTalk index information of an organization | Call this API to obtain the latest DingTalk index information of an organization. | New Server-side |
| Obtain organization authentication information | Call this API to obtain organization authentication information. | New Server-side |
| API | API description | API version |
|---|---|---|
| Obtain Contacts hide settings | Call this API to obtain the Contacts hide settings list in batches. | New Server-side |
| Delete Contacts hide settings | Call this API to delete Contacts hide settings. | New Server-side |
| Update Contacts hide settings | Call this API to update Contacts hide settings. | New Server-side |
| Configure department visibility priority | Call this API to configure the department visibility priority in Contacts. | New Server-side |
List of Smart HR APIs
| API | API description | API version |
|---|---|---|
| Add employees to be hired to an organization | Add employees to be hired to an organization. | Server-side |
| Obtain the list of employees to be hired | Query the user ID list of employees to be hired in an organization. | Server-side |
| Obtain the list of active employees | Query the user ID list of active employees in an organization. | Server-side |
| Update employee roster information | Update employee file information, with support for detail groups. | Server-side |
| Obtain employee roster field information | Query the information of specified employee roster fields, with support for detail group fields. | Server-side |
| Obtain roster metadata | Obtain the metadata of the employee roster, including roster groups and fields. | Server-side |
| Obtain employee resignation information in batches | Query employee resignation information in batches, such as the department ID, voluntary resignation reason, and involuntary resignation reason of resigned employees. | New Server-side |
| Transfer a Smart HR employee | Transfer a Smart HR employee, with support for adjusting the employee’s department list, primary department, job, Job Title, and job level. | New Server-side |
| Obtain the list of resigned employees | Query the user ID list of resigned employees in an organization. | New Server-side |
List of DingTalk Customer Connect APIs
| API | API description | API version |
|---|---|---|
| Create a DingTalk Customer Connect account association | Create an external user account and establish an account association with a DingTalk internal user. | New Server-side |
| Create a Standard Group or a cross-DingTalk two-person group | Create a DingTalk Customer Connect group of the type Standard Group or cross-DingTalk two-person group. | New Server-side |
| Create an external two-person group | Create an external two-person group. | New Server-side |
| Create a store group | Create a store group. | New Server-side |
| Obtain the chat address of a DingTalk Customer Connect group | Obtain the chat address of a DingTalk Customer Connect group. External users can access the corresponding group through this address. | New Server-side |
| Add members to an interconnection group | Add members to an interconnection group. | New Server-side |
| Query the member list of an interconnection group | Query the member list of an interconnection group, including Standard Groups, cross-DingTalk two-person groups, external two-person groups, and store groups. | New Server-side |
| Remove members from an interconnection group | Remove members from an interconnection group. | New Server-side |
| Modify the Profile Photo of an interconnection group | Modify the Profile Photo of an interconnection group, including Standard Groups, cross-DingTalk two-person groups, external two-person groups, and store groups. | New Server-side |
| Modify the name of an interconnection group | Modify a group name, including Standard Groups, cross-DingTalk two-person groups, external two-person groups, and store groups. | New Server-side |
| Change the owner of an interconnection group | Change the owner of an interconnection group. | New Server-side |
| External users send messages to DingTalk internal users or interconnection groups | Enable external users to send messages to DingTalk internal users or interconnection groups. | New Server-side |
| DingTalk internal users send messages to interconnection groups or external users | Enable DingTalk internal users to send messages to external users or interconnection groups. | New Server-side |
| An interconnection Group bot sends group messages | Send messages to a group through the Group bot in an interconnection group. | New Server-side |
| Query the number of Unread messages of an external user | Query the number of Unread messages of an external user. | New Server-side |
| Query the list of cross-DingTalk two-person groups in batches | Query the list of cross-DingTalk two-person groups in batches by group members. | New Server-side |
| Disband an interconnection group | Disband an interconnection group, including Standard Groups, cross-DingTalk two-person groups, external two-person groups, and store groups. | New Server-side |
List of YiDA APIs
| API | API description | API version |
|---|---|---|
| Initiate a YiDA Approval process | Initiate a YiDA Approval process to the DingTalk Open Platform. | New Server-side |
| Delete a workflow instance | Delete a workflow instance. | New Server-side |
| Terminate a workflow instance | Terminate a workflow instance. | New Server-side |
| Obtain the list of instance IDs | Obtain the list of instance IDs. | New Server-side |
| Obtain the list of workflow instances in batches | Obtain the details of the corresponding workflow instances in batches. | New Server-side |
| Obtain a workflow instance | Obtain YiDA workflow instance information, including the instance ID, Created time, and initiator. | New Server-side |
| Obtain a workflow instance by workflow instance ID | Obtain the details of a workflow instance by a specified workflow instance ID. | New Server-side |
| Obtain the form list under a specified app | Obtain the form list under an app by page. | New Server-side |
| Obtain the component information within a form | Obtain the component information within a document or workflow form by form ID. | New Server-side |
| Query form instance data | Query form instance data. | New Server-side |
| Save form data | Add a YiDA form instance without an Approval process. | New Server-side |
| Update form data | Update form data. | New Server-side |
| Query form data | Query form data by form instance ID. | New Server-side |
| Obtain the value of an employee component | Obtain the value of an employee component. | New Server-side |
| Obtain the form component definition list | Obtain the form component definition list. | New Server-side |
| Obtain subform component data | Obtain subform component data by form instance ID and subform group ID. | New Server-side |
| Delete form data | Delete form data. | New Server-side |
| Obtain multiple form instance IDs | Obtain multiple form instance IDs. | New Server-side |
| Obtain form instance data in batches | Obtain the details of form instances in batches, including the instance name and instance Submitter. | New Server-side |
| Delete form instances in batches | Delete form instance data in batches and remove it from the form instance list. | New Server-side |
| Create form instances in batches | Create form instance data in batches and return the IDs of the new form instances. | New Server-side |
| Update the component values within form instances in batches | Update the component values of YiDA form instances in batches by YiDA form instance ID. | New Server-side |
| Add or update a form instance | Filter form instances by a Filter. If the Filter is met, update the form instances matching the query condition based on the specified form values. If no form instance meets the Filter, add a form instance based on the specified form values. | New Server-side |
| Obtain form instance data using advanced query conditions (including subform component data) | Obtain the details of form instances using a Filter. | New Server-side |
| Obtain form instance data using advanced query conditions (excluding subform component data) | Obtain the details of form instances using a Filter, excluding subform component data. | New Server-side |
| Update form instances in batches by form instance data | Update form instance information in batches based on YiDA form component data. | New Server-side |
| Query the change records of a form | Query the change records under a YiDA form. | New Server-side |
| Obtain Approval records | Obtain Approval records. | New Server-side |
| Accept or Decline a YiDA Approval task | Used to Accept or Decline a YiDA Approval task. | New Server-side |
| Obtain the tasks submitted by someone in an organization | Obtain the tasks submitted by someone in an organization. | New Server-side |
| Obtain the Completed Approval tasks in an organization | Obtain the Completed Approval tasks in an organization. | New Server-side |
| Transfer a task | Transfer a task. | New Server-side |
| Query workflow running tasks (VPC) | Query workflow running tasks (VPC). | New Server-side |
| Obtain the task list (organization dimension) | Obtain the task list from the organization dimension. | New Server-side |
| Obtain the notifications sent to users | Obtain the notifications sent to users. | New Server-side |
| Query the list of tasks CC’d to me (app dimension) | Query the list of tasks CC’d to me (app dimension). | New Server-side |
| Execute YiDA Approval tasks in batches | Execute the Approval tasks of YiDA form instances in batches. | New Server-side |
| Submit a comment | Submit a comment under a form or workflow instance. | New Server-side |
| Query the comments of YiDA form instances in batches | Query all comments under a YiDA form in batches. | New Server-side |
| Obtain the temporary silent login address of a YiDA attachment | Obtain the temporary silent login address of a YiDA attachment. | New Server-side |
| Query the YiDA app list | Query the YiDA app list under an organization, including the YiDA app status, YiDA app icon, and YiDA app code. | New Server-side |
| Query the service call execution records of a YiDA form | Query the corresponding service call execution records by YiDA form ID, including the service call status, service call address, and service call result. | New Server-side |
Ecosystem API List
Alibaba Business Travel APIs
| API | API description | API version |
|---|---|---|
| Flight ticket city search | Search for train ticket cities. | Server-side |
| Train ticket city search | Search for flight ticket cities. | Server-side |
| Create a cost center | Create a cost center. | Server-side |
| Modify a cost center | Modify the basic information of a cost center. | Server-side |
| Delete a cost center | Delete a cost center. | Server-side |
| Query cost centers | Query cost center information. | Server-side |
| Configure cost center personnel information | Configure cost center personnel information. | Server-side |
| Delete cost center personnel information | Delete cost center personnel information. | Server-side |
| Convert a business travel cost center to an external cost center | Convert a business travel cost center to an external cost center. | Server-side |
| Add a project | Add a business travel project. | Server-side |
| Modify a project | Modify project information. | Server-side |
| Delete a project | Delete a project. | Server-side |
| Create an Approval form | Create an Approval form. | Server-side |
| Obtain the application form list | Query the Approval form data of an organization. | Server-side |
| Obtain application form details | Obtain the detailed information of a single application form. | Server-side |
| Modify an application form | Modify a business trip application form. | Server-side |
| Update the status of an application form | Update the status of an Approval form. | Server-side |
| Search for third-party hotel over-limit Approval forms | Search for third-party hotel over-limit Approval forms. | Server-side |
| Search for third-party train ticket over-limit Approval forms | Search for third-party train ticket over-limit Approval forms. | Server-side |
| Return third-party over-limit Approval results | Return third-party over-limit Approval results. | Server-side |
| Search for third-party flight ticket over-limit Approval forms | Search for third-party flight ticket over-limit Approval forms. | Server-side |
| Obtain organization flight ticket order data | Obtain organization flight ticket order data. | Server-side |
| Obtain organization business travel hotel order data | Obtain business travel hotel order data. | Server-side |
| Obtain organization train ticket order data | Obtain organization train ticket order data. | Server-side |
| Obtain car-hailing order data | Obtain organization car-hailing order data. | Server-side |
| Query the list of related order information by associated order number | Obtain order information by the associated order number in an application form. | New Server-side |
| Obtain business travel access addresses | Obtain the booking access addresses for various scenarios and the My Orders address. | Server-side |
| Add an invoice configuration | Add an invoice configuration. | Server-side |
| Configure the applicable users for an invoice | Configure the applicable users for an invoice. | Server-side |
| Query the list of available invoices | Query the list of available invoices. | Server-side |
| Modify an invoice configuration | Modify an invoice configuration. | Server-side |
| Delete invoice information | Delete invoice information. | Server-side |
| Sync an intra-city car-hailing application form | Sync an intra-city car-hailing application form. | Server-side |
| Approve an intra-city car-hailing application form | Approve an intra-city car-hailing application form. | Server-side |
| Query intra-city car-hailing application forms | Query intra-city car-hailing application forms. | Server-side |
| Query car-hailing settlement records | Query the settlement bookkeeping data of business travel car-hailing. | New Server-side |
| Query business travel train ticket settlement data | Query the settlement bookkeeping data of business travel train tickets. | New Server-side |
| Query hotel settlement data | Query the settlement bookkeeping data of business travel hotels. | New Server-side |
| Query flight ticket settlement data | Query the settlement bookkeeping data of flight tickets. | New Server-side |
| Obtain monthly reconciliation settlement data | Obtain the download address of monthly reconciliation settlement data. | Server-side |
| Query the estimated price | Query the estimated price. | Server-side |
Xiaomi Customer Service APIs
| API | API description | API version |
|---|---|---|
| Intelligent Q&A | Use the capabilities of the Xiaomi Customer Service Bot for intelligent Q&A. | New Server-side |
| Push an O2O Direct Message from the Xiaomi Bot | Send O2O (Online To Offline) messages through the Xiaomi Customer Service Bot. | New Server-side |
| Reply to messages from the Xiaomi Customer Service Bot | Perform asynchronous message replies based on the sessionId of the Xiaomi Customer Service Bot. | New Server-side |
| Query the basic metric data of a Bot | Query the basic metric data of a Bot over a certain period by Bot ID. | New Server-side |
| Obtain a user’s sign-in credential | Obtain a user’s sign-in Credential. | New Server-side |
Smart Customer Service APIs
| API | API description | API version |
|---|---|---|
| Create a self-service ticket | Create a user-defined self-service ticket. | New Server-side |
| Execute a ticket activity | Execute a ticket activity. | New Server-side |
| Query action records | Query action records. | New Server-side |
| Query tickets by page | Query tickets by page. | New Server-side |
Employee Service Desk
| API | API description | API version |
|---|---|---|
| Push messages using the service assistant | Send messages to organization employees through the service assistant Bot. | Server-side |
Manufacturing APIs
| API | API description | API version |
|---|---|---|
| Piece-rate work reporting | Used by the MES system to report piece-rate data to the platform. | New Server-side |
| Query piece-rate work reporting data | Query piece-rate work reporting data. | New Server-side |
eSign APIs
| API | API description | API version |
|---|---|---|
| Initialize eSign data | Help DingTalk organizations initialize data on the eSign Open Platform. | New Server-side |
| Obtain the authorization page address | Obtain the organization authorization page address. | New Server-side |
| Cancel organization authorization | Cancel the authorization status of an authorized organization. | New Server-side |
| Package resale — profit-sharing mode | Create a resale order for users of electronic contracts. | New Server-side |
| Package resale — reserve price settlement mode | Directly resell an eSign order to the end user who actually uses the electronic contract. | New Server-side |
| Query package balance | Query the package balance of the current organization. | New Server-side |
| Obtain the eSign Micro app status of an organization | Obtain the eSign Micro app status of an organization. | New Server-side |
| Query whether an organization has completed identity verification | Query whether an organization has completed identity verification on eSign. | New Server-side |
| Obtain the organization console address | Obtain the organization’s console address on eSign. | New Server-side |
| Query whether an individual has completed identity verification | Query whether the current user has completed identity verification on eSign. | New Server-side |
| Obtain the individual identity verification address | When the Profile API shows that an individual has not completed identity verification, call this API to obtain the individual identity verification address. | New Server-side |
| Obtain the address that redirects to organization identity verification | When the organization information API shows that an organization has not completed identity verification, call this API to obtain the identity verification address and display it to the organization within the app. | New Server-side |
| Obtain the file upload address | Obtain the file upload address. | New Server-side |
| Obtain file details | Query file details. | New Server-side |
| Obtain the address for initiating a signing task | Obtain the address for initiating a signing task. | New Server-side |
| Create a signing process | When an ISV-side organization has files to sign, call this API to obtain the signing initiation address. | New Server-side |
| Obtain the signer’s signing address | Obtain the signer’s signing address. | New Server-side |
| Obtain the signing details of a process | Obtain the detailed signing information of a process by taskId. | New Server-side |
| Obtain the seal Approval list for process tasks | Obtain the seal Approval list for process tasks. | New Server-side |
| Obtain process details and Activity log | Obtain process details and the Activity log. | New Server-side |
| Obtain the list of all contracts for a process task | Obtain the list of all contracts for a process task, queried after receiving the signing completion message. | New Server-side |
Jinzhi CRM APIs
| API | API description | API version |
|---|---|---|
| Customer profile | Add or edit a customer profile. | New Server-side |
| Customer public pool | Add or edit a customer public pool. | New Server-side |
| Contact | Add or edit a Contact. | New Server-side |
| Contract order | Add or edit a contract order. | New Server-side |
| Delivery note | Add or edit a delivery note. | New Server-side |
| Sales exchange order | Add or edit a sales exchange order. | New Server-side |
| Sales opportunity | Add or edit a sales opportunity. | New Server-side |
| Quotation record | Add or edit a quotation record. | New Server-side |
| Purchase order | Add or edit a purchase order. | New Server-side |
| Production order | Add or edit a production order. | New Server-side |
| Product information | Add or edit product information. | New Server-side |
| Inbound order | Add or edit an inbound order. | New Server-side |
| Outbound order | Add or edit an outbound order. | New Server-side |
| Obtain the data list | Obtain the list data of various documents. | New Server-side |
| Obtain Source records | Obtain the detailed data of various documents. | New Server-side |
H3 Yun APIs
| API | API description | API version |
|---|---|---|
| Obtain the app list | Query the app information of H3 Yun. | New Server-side |
| Obtain app feature nodes | Obtain the feature node information of an app. | New Server-side |
| Obtain organization data | Obtain organization department data. | New Server-side |
| Obtain user data | Obtain basic user data. | New Server-side |
| Obtain role data | Obtain role group and role data. | New Server-side |
| Obtain role user data | Obtain the users included in a specified role. | New Server-side |
| Obtain the form object structure | Obtain the form object structure information. | New Server-side |
| Create form business data | Create a single business data object for a form or workflow form. | New Server-side |
| Query the form business data list | Query a collection of form business data instances. | New Server-side |
| Modify form business object data | Modify a single business instance data of a form. | New Server-side |
| Add form business data in batches | Add business instance data of a form in batches. | New Server-side |
| Delete a business object | Add business instance data of a form in batches. | New Server-side |
| Obtain business instance information | Obtain a single business instance data of a form. | New Server-side |
| Create a workflow instance | Create workflow instance data for a workflow form. | New Server-side |
| Delete workflow instance data | A single workflow instance data of a workflow form. | New Server-side |
| Cancel a workflow instance | Cancel a workflow instance. After cancellation, the workflow instance status is Canceled. | New Server-side |
| Query workflow instances | Query the workflow instance data of a workflow form. | New Server-side |
| Query workflow instance node work items | Obtain the information of workflow instance node work items. | New Server-side |
| Obtain the temporary access address of an attachment | Obtain the temporary silent login access address of an attachment. | New Server-side |
| Obtain the file upload address | Return the file upload address of a specified image, attachment, or other control in a form. | New Server-side |