更新时间:2023-09-27 GMT+08:00
控制三方视频通话图像展示模式
场景描述
视频座席修改通话三方视频展现模式。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/voicecall/{agentid}/adjustvideomode
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
1 |
agentid |
string |
True |
座席的工号,取值范围:101~59999。 |
日志中的方法名
adjustVideoMode
请求说明
- 请求头
表2 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。
- 消息体
表3 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
mode
Interger
True
mode展现模式,取值范围:0-3,0:通话三方画面等大,1:用户最大化,2:座席最大化,3:第三方最大化
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述 |
2 |
retcode |
string |
错误码。取值如下: 0:成功 非0:失败 |
3 |
result |
object |
预留字段 |
错误结果码
- 200-031
- 200-032
- 200-033
- 200-034
- 200-035
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "mode": "0" }
- 响应参数
{ "result": {}, "message": "success", "retcode": "0" }
父主题: 呼叫控制类:voicecall