调用PauseWhiteBoardRecording暂停白板录制。
使用说明
调用本接口前,您必须已经调用StartWhiteBoardRecording启动白板录制。
QPS限制
本接口的单用户QPS限制为200次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PauseWhiteBoardRecording |
系统规定参数。取值:PauseWhiteBoardRecording。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
AppID | String | 是 | 7mbj**** |
白板应用唯一标识符。获取AppID,请参见CreateApp。 |
UserId | String | 是 | 123456 |
暂停白板录制的用户ID(客户业务用户),由1~32位大小写字母、数字、下划线、短划线(-)组成。 |
DocKey | String | 是 | 4EZlwmRW0gDG**** |
白板文档唯一标识符。获取DocKey,请参见CreateWhiteBoard。 |
RecordId | String | 是 | 8a4556336bc6456b918e8eedbed6**** |
白板录制Session的唯一标识符。获取RecordId,请参见StartWhiteBoardRecording。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | B62D36BC-C41E-4436-B74B-2D0DB2E9E338 |
请求ID。 |
ResponseSuccess | Boolean | true |
请求结果。 |
ErrorCode | String | null |
错误码。 |
ErrorMsg | String | null |
错误信息。 |
Result | Object |
返回的结果信息。 |
|
PauseTime | Long | 1622173522279 |
暂停录制的时间,使用UNIX时间戳表示,单位:秒。 |
示例
请求示例
http(s)://rtc-white-board.cn-shanghai.aliyuncs.com/?Action=PauseWhiteBoardRecording
&AppID=7mbj****
&UserId=123456
&DocKey=4EZlwmRW0gDG****
&RecordId=8a4556336bc6456b918e8eedbed6****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<PauseWhiteBoardRecordingResponse>
<RequestId>B62D36BC-C41E-4436-B74B-2D0DB2E9E338</RequestId>
<ResponseSuccess>true</ResponseSuccess>
<ErrorMsg/>
<ErrorCode/>
<Result>
<PauseTime>1622173522279</PauseTime>
</Result>
</PauseWhiteBoardRecordingResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "B62D36BC-C41E-4436-B74B-2D0DB2E9E338",
"ResponseSuccess" : true,
"ErrorMsg" : "",
"ErrorCode" : "",
"Result" : {
"PauseTime" : 1622173522279
}
}