文档首页/ 云客服/ API参考/ 录音/话单类/ 录音/ 录音回放:recordplay/ 开始录屏
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

开始录屏

仅私有部署模式下可用

前置条件

  • 座席已签入

  • 座席侧已成功初始化VRC组件

场景描述

对座席开始录屏操作。

接口方法

设置成“PUT”。该接口仅支持PUT方法，不支持POST、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/recordplay/{agentid}/startrecordscreen

其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号，取值范围：101～59999。

日志中的方法名

startRecordScreen

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。
  • 消息体

    无

响应说明

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下：

0：成功

非0：失败

触发事件

  • 开始录屏成功（AgentMediaEvent_StartRecordScreen_Succ）

  • 开始录屏失败（AgentMediaEvent_StartRecordScreen_Fail）

错误结果码

  • 100-006

  • 100-007

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

    无

  • 响应参数 
    {
  "result": {},
  "message": "success",
  "retcode": "0"
}