更新时间:2024-08-02 GMT+08:00

开始放音

前置条件

  • 座席已签入
  • 座席不在通话中

场景描述

对座席开始放音操作(座席签入号码收到呼叫,接通后播放录音)。

因为该接口能够播放任意录音文件,二次开发时,请谨慎使用该接口。

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

beginPlay

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    voicepath

    string

    True

    文件路径。最大长度100个字符。

    2

    startpostion

    long

    False

    播放文件起始位置,单位 s。

    3

    volumechange

    string

    False

    放音音量,默认"50"。0-5位数字。

    4

    speedchange

    string

    False

    放音音速,默认"50"。0-5位数字。

    5

    times

    int

    False

    播放次数,默认为1。

    说明:

    当输入其他值时,均默认为1。

    6

    codeformat

    int

    False

    文件编码格式,目前暂时只支持0:默认为0。

    7

    locationId

    int

    False

    分布式节呼叫中心点ID。

    通过轮询接口获取的录音开始事件,会返回locationId的值

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

object

预留字段

触发事件

  • 录音播放开始(AgentMediaEvent_Play)
  • 录音播放成功(AgentMediaEvent_Play_Succ)
  • 录音播放失败(AgentMediaEvent_Play_Fail)
  • 停止录音播放(AgentMediaEvent_StopPlayDone)

错误结果码

  • 100-006
  • 100-007
  • 500-007

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "voicepath": "Y:/1/0/20180621/105/1406470.V3",
        "startpostion": 0,
        "volumechange": 20,
        "speedchange": 20,
        "times": 1,
        "codeformat": 0,
        "locationId": -1
    }
  • 响应参数
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }