服务端 API 调试工具

使用指引

腾讯会议服务端 API 调试工具是一款为方便开发者进行腾讯会议 Rest API 接口联调的可视化调试工具。开发者无需编写过多代码,仅需聚焦于业务场景,无缝对接企业邮箱、日程、会议室管理系统实现行业应用、企业办公平台与腾讯会议音视频的连接,降低接入门槛和增加开发调试效率。

立即前往 服务端 API 调试工具

下图为开发者工具主页面,主要包含四个区域:1. 应用选择区、2. 接口列表、3. 参数编辑区、4. 信息展示区。下面详细介绍服务端 API 调试工具的使用方法。

应用选择区

调试接口前您需要先选择调试的应用,工具支持调试企业自建应用和第三方应用。单击选择应用进入应用选择页,您可以在您创建的应用列表中单击直接选择,或者通过输入应用凭证等信息输入选择需要调试的应用。应用凭证信息可以在企业管理后台 > 应用管理后台 > 应用编辑页中查看。

接口列表

选定调试的应用后,应用列表展示该类型应用可以调试的接口列表,您可以选择需要调试的接口,右侧展示对应接口的参数编辑和对应的 API 文档。您也可以在应用列表或者参数区单击星星图标进行接口收藏,收藏的接口将展示在我的收藏中,方便您快速查找常用接口进行调试。

参数编辑区

参数编辑区展示调试的接口的基本信息及需要用户编辑的信息,展示信息包括接口调用方法、接口域名。编辑信息包括请求参数、请求体、请求头等。其中请求体的编辑提供两种编辑方式:JSON 编辑和参数编辑,您可以根据习惯进行编辑,编辑完成后点击发送调用进行接口请求。

注:开发者工具发送的是真实请求,操作线上真实资源,请小心操作。

请求参数

选定具体联调接口后,该接口相关的请求参数字段将展示在页面上,REST API 接口分为有请求参数的接口和无请求参数的接口。若联调的接口为有请求参数的接口,则请求参数将分为必填项和非必填项,其中必填项不可删除,非必填项可根据实际需要进行删除,如查询用户的会议列表接口。若联调的接口为无请求参数的接口,则页面不展示任何请求参数信息,如创建会议接口。

请求体

REST API 接口分为有请求体的接口和无请求体的接口。若联调的接口为有请求体的接口,请求体信息以 JSON 字符串或参数编辑的格式显示。其中请求体信息中的每个字段都有相应的描述,包括字段的数据类型以及是否必需(required),非必需字段则不包含 required 的描述信息。您可根据提示输入相应的字段信息来构建请求体,并根据实际需要进行删减或一键还原参数结构。若联调的接口为无请求体的接口,则页面不展示任何请求体信息,如通过会议 ID 查询接口。

请求头

自建应用

自建应用使用 JWT 鉴权方式,鉴权指引请参见 企业自建应用鉴权

请求头字段分为必填字段和非必填字段,非必填字段可根据实际需要进行删除。请求头的字段涉及到调用 REST API 接口时的签名验证,所以务必确保正确填写请求头信息。

注:每次请求新的接口时,都需要重新生成 X-TC-Timestamp、X-TC-Nonce 与 X-TC-Signature 字段,否则将导致请求接口失败。

请求头字段说明:

  • X-TC-Key 字段为必填字段,当选定调试的应用后, X-TC-Key 的值将自动同步填充到该位置,无需再次填写。

  • X-TC-Timestamp 字段为必填字段,单击生成当前时间戳,即可生成一个单位为秒的当前时间戳。

  • X-TC-Nonce 字段为必填字段,单击生成一个随机数,即可生成一个随机整数。

  • X-TC-Signature 字段为必填字段,单击获取签名可获取签名。

  • X-TC-Registered 字段为必填字段,企业用户在调用 API 时请求头部 X-TC-Registered 字段必须传入为1。

  • AppId 为应用所属企业 ID,在您选定调试的应用后会自动填充

  • SdkId 为所调试的应用 ID,在您选定调试的应用后会自动填充。

第三方应用

第三方应用使用 OAuth2.0 鉴权,鉴权指引请参见 第三方应用鉴权

请求头字段说明:

  • X-TC-Timestamp 字段为必填字段,单击生成当前时间戳,即可生成一个单位为秒的当前时间戳。

  • X-TC-Nonce 字段为必填字段,单击生成一个随机数,即可生成一个随机整数。

  • X-TC-Registered 字段为必填字段,企业用户在调用 API 时请求头部 X-TC-Registered 字段必须传入为1。

  • OpenId 为调试者在该应用的 ID,用户在授权应用后能够获取该 ID,您可以通过在接口列表中选择应用凭证-获取用户 access_token/刷新用户 access_token,调用接口后会自动填充或者您也可以手动编辑需要调用接口的用户信息

  • Accesstoken 为调试者在该应用下的令牌信息,用户在授权应用后能够获取该 token,您可以通过在接口列表中选择应用凭证-获取用户 access_token/刷新用户 access_token,调用接口后会自动填充或者您也可以手动编辑需要调用接口的用户信息。

信息展示区

发送接口请求后,右侧展示调用结果,包括响应体、响应头、原始请求信息,展示本次请求等状态码和错误码。若调试成功您可以一键复制代码拷贝到您的代码中,若调试失败,您可以通过接口报错信息进行调整后重新调用,或者您可以一键复制日志 ID 到技术支持进行问题排查。

同时开发者工具将会记录您仅30天的调用历史,您可以一键恢复接口调用信息进行后续调整调试。

下载 腾讯会议 Rest API 开发者工具-服务端 API 调试工具.pdf
文章内容是否对您有帮助?
有帮助
无帮助