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

网呼放音

前置条件

  • 已开通网络呼叫中心
  • 座席已签入
  • 座席不在三方通话中

场景描述

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

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

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

beginNetPlay

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    fileName

    string

    True

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

    2

    position

    long

    False

    播放文件起始位置(秒)。

    3

    playTime

    int

    False

    播放次数,取值范围:

    • 1:播放1次
    • 0:无限次循环播放

    默认为1。

    说明:

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

    4

    fileFormat

    int

    False

    文件编码格式,取值范围:

    0:按资源侧缺省配置格式播放

    1: 24K VOX格式

    2:32K VOX 格式

    默认为0。

    5

    ccId

    int

    True

    放音文件所在呼叫中心编号,可从WAS上的Web配置台>配置NIRC>配置CCS客户端>客户端ID获取。

    6

    locationId

    int

    False

    分布式节点编号,作为输入参数,只有在单UAP组网并且平台配置支持分布式的场景下,此参数有效。

    取值范围为:0-65535

响应说明

表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
  • 100-018
  • 500-007

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "fileName": "Y:/12/0/20211019/155/1406470.V3",
        "position": "0",
        "playTime": "1",
        "fileFormat": "0",
        "ccId": "1",
        "locationId": "-1"
    }
  • 响应参数
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }