开始录音
- 仅私有云模式下可用。
- 暂不支持质检员插入,侦听,耳语后进行录音操作。
- 暂不支持视频录制。
- 由basic.properties 中IF_ENABLE_AGENT_SELFRECORD开关控制是否允许使用该接口。
场景描述
对座席开始录音操作。
接口方法
设置成“PUT”。该接口仅支持PUT方法,不支持POST、GET和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/recordplay/{agentid}/record
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
1 |
agentid |
string |
True |
座席的工号,取值范围:101~59999。 |
日志中的方法名
beginRecord
请求说明
-
表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
False
录音文件存储路径(最大长度为100,可为空)。
不传或为空时,系统自动生成,格式如下:
盘符:\VDN号\媒体类型编号\年月日\工号\文件名+后缀
其中盘符可以由basic.properties中MAPPINGDISK配置项配置,不配置时默认为“Y”
2
mediaType
int
True
被录制的媒体类型,目前只能填写5,普通语音
3
recordMode
int
False
录制的方式
0:覆盖方式
1:追加方式
当不传参或传入参数为其他值时,默认为0
4
recordFormat
int
False
录制的文件格式
0: 按资源侧缺省配置格式播放,语音缺省文件格式,在录音资源侧配置
1: 24KVOX语音文件
2: 32KVOX语音文件
3: 64KALAW语音文件
不传参时,默认为0
说明:一套环境中,只能使用一种录音格式,不能在不同的呼叫中设置不同的录音格式。
下发的录音格式,需要与UAP上配置的放音格式保持一致。
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述 |
2 |
retcode |
string |
错误码。取值如下: 0:成功 非0:失败 |
3 |
result |
Map |
返回结果信息对象。 该对象的参数说明请参见表5。 |
触发事件
- 录音开始(AgentMediaEvent_Record)
- 录音开始失败(AgentMediaEvent_Record_Fail)
- 物理话机振铃(AgentOther_PhoneAlerting)
- 物理话机摘机(AgentOther_PhoneOffhook)
错误结果码
- 000-002
- 100-006
- 100-007
- 500-008
- 500-011
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "fileName": "Y:/15/0/20201119/186/142702.V3", "mediaType": 5, "recordMode": 0, "recordFormat": 0 }
- 响应参数
{ "result": { "taskId": "5086" }, "message": "success", "retcode": "0" }