更新时间:2023-09-27 GMT+08:00

截图:imagecapture

场景描述

H5视频呼叫的场景下,座席如果要对用户进行截图,则调用该接口。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/mediacall/{agentid}/imagecapture

其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号,取值范围:101~59999。

日志中的方法名

imageCapture

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    userType

    string

    True

    用户类型。

    默认为“user”代表用户

    2

    callid

    string

    True

    呼叫标识。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

retcode

string

消息发送结果。

  • 0:成功
  • 非0:失败

2

message

string

描述

触发事件

  • 截图事件(AgentEvent_ImageCapture)

错误结果码

  • 106-011
  • 106-015
  • 100-007

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
    "callid":"1552524689-16797284",
    "userType":"user"
    }
  • 响应参数
    {
        "message": "success",
        "retcode": "0"
    }