开发

开发自定义解决方案

TeamViewer API

开发监控器

TeamViewer提供一种基于网络的API,以帮助您访问数据以及管理TeamViewer帐户的方方面面。您可使用API开发用于将TeamViewer功能集成到您自己的企业环境中的应用程序,或者开发供所有人使用的应用程序。 

API使用REST与您的应用程序进行通信,并采用安全授权标准OAuth 2.0管理对所有数据的访问。

功能特性

应用程序开发者可通过TeamViewer API使用下列TeamViewer功能: 

用户管理

与TeamViewer公司资料相关的方法 (如创建新公司成员、修改成员信息)。 

组管理

与TeamViewer计算机和联系人列表中的组相关的方法 (如创建组、共享组) 

会话管理

与TeamViewer远程控制会话相关的方法 (如创建新会话、修改会话信息)。 

连接报告

与TeamViewer Management Console中的连接报告相关的方法 (如列出连接报告、导出报告)。 

在线会议

与TeamViewer会议相关的方法 (如安排会议、启动自发会议) 

计算机和联系人

与TeamViewer计算机和联系人列表相关的方法(例如查看哪些人在线,与某联系人或设备开始远程控制会话,或从您的地址簿批量导入新联系人)。

用例

  • 在帮助中心内部的客户支持凭单中创建服务事项
  • 在您的网络应用程序中集成“请求支持会话”按钮。
  • 从TeamViewer Management Console导出连接报告至Excel文件,以供进一步处理并生成统计数据。
  • 每晚自动从TeamViewer Management Console导出连接报告,以供离线及灵活使用 (如用于计费)。
  • 将整个支持团队快速导入到您的TeamViewer公司资料中。
  • 为您的活动目录中的每个新用户自动创建新的TeamViewer帐户。
  • 在聊天应用程序中启动会议,并直接邀请聊天伙伴。
  • 在第三方日历应用程序中安排会议。
  • 在TeamViewer中查看您的CRM联系人是否在线,并直接要求与其计算机开始远程控制会话。
  • 使用存储在计算机和联系人列表中的密码,从您偏好的资产管理系统直接连接到计算机。

开始开发

开始使用 文档 示例

立即使用

快速上手开发应用程序及脚本。TeamViewer API使用OAuth 2.0、脚本标志及客户端ID。

立即开始开发

轻松开发您自己的应用程序。按照以下步骤,或者直接跳转到API 文档立即开始。

在TeamViewer API中,有两种不同的API使用方法:通过脚本或者通过应用程序。

应用程序经开发可供多个不同的帐户使用。因此,脚本和应用程序访问TeamViewer数据的方式各不相同,并使用不同类型的标志表示。

如果您希望API仅供您自己的数据使用,可创建脚本标志。即使您稍后改变主意也无需担心,您仍然可以轻松地转而创建应用程序。如果您希望创建可供其他TeamViewer客户使用的应用程序,则继续并创建OAuth 2.0客户端ID

在TeamViewer Management Console中创建一个TeamViewer帐户,使用TeamViewer API开发TeamViewer应用程序或脚本 | 屏幕截图

创建帐户

要使用TeamViewer API,您必须具备一个TeamViewer帐户。 

为此,最简单的方法就是访问 TeamViewer Management Console 网站。在页面左侧注册一个帐户。

创建脚本

在TeamViewer Management Console中打开您的配置文件设置 | 屏幕截图

打开Management Console

要创建脚本,您必须通过使用您的TeamViewer TeamViewer Management Console 帐户登录到

在Console中,打开网站右上方的配置文件设置。

创建可配合您的TeamViewer账户使用的新脚本 | 屏幕截图

创建 脚本

  1. 输入您的脚本名称
  2. 输入您的脚本描述
  3. 选择您的脚本权限
  4. 保存脚本

如需了解更多信息,请参见API 文档

记下脚本属性中的脚本标志,以后会用到它 | 屏幕截图

记下标志

记下您最近创建的脚本属性中的标志。
您在开发过程中会用到这些标志。

如需了解关于标志的更多信息,请参见API 文档

开始编写代码

您现在即可参照API 文档编写您自己的脚本,或者也可使用某个脚本实例中的标志。

创建应用程序

在TeamViewer Management Console中打开“应用”菜单 | 屏幕截图

打开Management Console

要创建应用,请使用您的TeamViewer帐户登录到 TeamViewer Management Console 帐户登录到

在Console中,打开网站底部的“应用”链接。

使用OAuth 2.0的方法创建可供任意TeamViewer帐户使用的新应用程序 | 屏幕截图

创建 应用程序

  1. 输入应用程序名称
  2. 输入应用程序描述
  3. 输入重定向URI。
    在您的应用程序获得访问用户数据的授权后,用户会被重新定向到该URI。设置该项后,只有使用给定重定向URI的授权请求才会获得授权。该项可在以后更改。
  4. 选择访问等级
  5. 选择应用程序权限
  6. 保存应用程序

如需了解更多信息,请参见API 文档

记下脚本属性中的客户端ID,以后会用到它 | 屏幕截图

记下客户端ID及客户端私密信息

记下您最近创建的应用程序属性中的客户端ID和客户端私密信息。
您在开发过程中会用到这些信息。

如需了解关于客户端ID的更多信息,请参见API 文档

开始编写代码

您现在即可参照API 文档开始编写您的应用程序。

API文档

TeamViewer API文档中介绍了TeamViewer API及其参考资料、技术规范和方法 | 图标

TeamViewer API文档提供可用方法 (包括方法调用实例) 的详细描述,以及关于使用API的基本信息。

您可通过以下链接下载PDF格式的TeamViewer API文档。

下载

示例

开发集成插件时,可使用预建脚本获取一些有益的参考。

我们的脚本实例

我们提供了一些预建脚本,旨在帮助您快速上手开发自己的应用程序。

支持的脚本语言包括PowerShellPython

下载 用户管理, 报告 以及 Active Directory 脚本,或查看下列实例获取一些有益的参考。

关于所用API方法的详细信息,请参见TeamViewer API 文档

使用TeamViewer API代码实例,您可开发用于创建服务事项的应用程序。

代码实例:服务队列

使用服务队列,您可在TeamViewer和TeamViewer Management Console中管理客户支持事项。 

本例提供的应用程序用于创建服务事项。附带的程序代码可帮助您理解如何在您自己的应用环境中集成服务队列功能。您可通过以下链接下载应用程序及C#代码。

下载
返回顶部