文档首页/ 云客服/ API参考/ 语音通知/ 查询语音通知的录音文件（queryVoiceNotificationRecording）
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

查询语音通知的录音文件（queryVoiceNotificationRecording）

场景描述

查询语音通知录音数据，该API只查询审核通过语音通知的数据。

录音文件可通过系统管理员登录客户服务云进入菜单“配置中心>资源管理配置>音视频资源管理”进行配置，也可通过调用上传IVR语音文件接口进行配置。

接口方法

POST

接口URI

https://域名/apiaccess/rest/voiceNotification/v1/queryVoiceNotificationRecording，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

appKey字段，用户标识，请联系运营人员获取appKey

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。

生成方式参见C1 系统配置类接口鉴权方式。
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

object

True

-

1.1

offset

integer

False

起始游标，即分页查询时的起始记录行号。

首次查询传入“0”。

后续查询其他分页时传入该分页的第一条记录的序号。返回记录中第一条记录序号为“0”，后续依次排序。例如每页为50条录，查询第二页时应传入“50”。

不传时默认0，无最大值限制

1.2

limit

integer

False

分页查询时的每页记录数，正整数，不传时默认100，最大值100，传入超过100的值也会转换为100

1.3

type

integer

False

录音文件类型 0：音频，2：text文本

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1

    schema

    object

    True

    -

    1.1

    returnCode

    string

    True

    返回码，0：成功，其他失败（1：请求参数type不正确）

    1.2

    description

    string

    False

    返回描述

    1.3

    voiceInfo

    object

    False

    录音信息

    1.3.1

    tenant_id

    string

    True

    租户id

    1.3.2

    uploaddate

    number

    True

    上传时间，格式为timestamp

    1.3.3

    voice_id

    string

    True

    录音id

    1.3.4

    name

    string

    True

    录音名称

    1.3.5

    voicecontent

    string

    False

    语音内容

    1.3.6

    type

    number

    True

    类型 0：音频，2：text文本

    1.3.7

    tenantSpaceName

    string

    False

    租户名称

    1.3.8

    auditaccount

    string

    False

    审核者账号

    1.3.9

    noReference

    boolean

    False

    提示音和故障音是否被引用

    1.3.10

    auditcomments

    string

    False

    审核意见

    1.3.11

    auditdate

    number

    False

    审核时间，格式为timestamp

    1.3.12

    scene

    number

    False

    使用场景

    1.3.13

    uploadaccount

    string

    False

    上传账号

    1.3.14

    isUpdateRec

    number

    False

    是否是更新记录

    1.3.15

    status

    number

    False

    回调状态

    1.3.16

    callbackTimes

    number

    False

    回调次数
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数

  • 响应状态码: 401

    未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 403

    鉴权失败

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

请求头:

{
"Content-Type": application/json
"x-app-key": ********************
"Authorization": Bearer ************************
}

请求参数:

{
 "offset":0,
 "limit":10,
 "type":2
}

响应参数:

{
    "returnCode": "0",
    "description": "query success",
    "voiceInfo": [
        {
            "tenant_id": "20******234",
            "uploaddate": 163*****4000,
            "voice_id": "113379*********9999",
            "name": "welcome",
            "voicecontent": "{\"0\":{\"languageId\":\"0\",\"textcontent\":\"欢迎光临\"}}",
            "type": 2,
            "tenantSpaceName": "************"
        },
    ]
}
父主题： 语音通知