调用SetAppCallbackUrl为白板应用设置回调地址及回调鉴权码。
使用说明
- 调用本接口前,您必须已经调用CreateApp创建白板应用。
- 目前互动白板控制台还未正式上线,请通过互动白板服务端SDK进行白板应用的相关操作。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SetAppCallbackUrl |
系统规定参数。取值:SetAppCallbackUrl。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
AppID | String | 是 | 7mbj**** |
白板应用唯一标识符。获取白板应用ID,请参见CreateApp。 |
AppCallbackUrl | String | 是 | http://www.example.com/callback |
白板应用回调地址URL。 |
AppCallbackAuthKey | String | 是 | CallbackSecret123 |
白板应用回调鉴权码,由8~20位大小写字母、数字或下划线组成。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CFB5E6AA-823B-415B-AA03-4B9892049B68 |
请求ID。 |
ResponseSuccess | Boolean | true |
调用结果。 |
ErrorCode | String | null |
错误码。 |
ErrorMsg | String | null |
错误信息。 |
Result | Boolean | true |
返回的结果信息。 |
示例
请求示例
http(s)://rtc-white-board.cn-shanghai.aliyuncs.com/?Action=SetAppCallbackUrl
&AppCallbackUrl=http://www.example.com/callback
&AppID=7mbj****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SetAppCallbackUrlResponse>
<RequestId>CFB5E6AA-823B-415B-AA03-4B9892049B68</RequestId>
<ResponseSuccess>true</ResponseSuccess>
<Result>true</Result>
</SetAppCallbackUrlResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CFB5E6AA-823B-415B-AA03-4B9892049B68",
"ResponseSuccess" : true,
"Result" : true
}