互动白板API的调用是通过向白板服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。通过阅读本文,您可以了解到调用互动白板API的请求结构。

互动白板的API是RPC风格,您可以通过发送HTTP GET请求调用API,并支持通过HTTP或HTTPS通道进行请求通信,为了获得更高的安全性,推荐您使用HTTPS通道发送请求。请求及返回结果都使用UTF-8字符集进行编码,请求结构如下所示。

https://Endpoint/?Action=xx&Version=xx&Parameters
  • Endpoint:互动白板API的服务接入地址为rtc-white-board.cn-shanghai.aliyuncs.com。
  • Action:要执行的操作,例如调用createApp创建白板应用。
  • Version:要使用的API版本,目前互动白板的API版本是2020-12-14。
  • Parameters:请求参数,每个参数之间用&分隔。请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情请参见公共参数

下面是一个调用createApp删除频道的示例:

说明 为了便于您的查看,本文中的示例都做了格式化处理。
https://rtc-white-board.cn-shanghai.aliyuncs.com/?Action=createApp
&AppName=white_board
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2020-12-14
&SignatureVersion=1.0
&Signature=%1h%3D****
&Timestamp=2020-12-29T09%3A22%3A32Z  
...