查询群语音信箱问候语列表

查询群语音信箱的问候语列表。

请求 URL

GET {base_url}/{api_path}/vm_greeting/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
extension 是 String 群语音信箱问候语的号码。
注： 可使用 查询群语音信箱列表 接口查询群语音信箱的号码。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 群语音信箱的问候语总数。
greeting_list Array <Greeting_Info> 每条问候语的基本信息。
Greeting_Info
参数 类型 说明
id Integer 问候语的唯一 ID。
module String 问候语所属的模块。
  • groupvoicemail
number String 问候语所属的群语音信箱的号码。
file String 问候语的文件名。
suffix String 问候语的文件扩展名。
  • .wav
  • .WAV
type String 问候语类型。
  • record：通过分机录制或从本地上传的问候语。
  • tts：通过文本生成语音功能生成的问候语。
real_filename String 问候语完整文件名 (包含文件扩展名)。

示例

请求示例

GET /openapi/v1.0/vm_greeting/list?access_token=UIFGAl0HUpg8i78V0Z6nCx5YghKqE235&extension=6300 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "greeting_list": [
        {
            "id": 22,
            "module": "groupvoicemail",
            "number": "6300",
            "file": "group_vm_night.wav",
            "suffix": ".wav",
            "type": "record",
            "real_filename": "group_vm_night.wav"
        },
        {
            "id": 21,
            "module": "groupvoicemail",
            "number": "6300",
            "file": "group_vm_absent.wav",
            "suffix": ".wav",
            "type": "record",
            "real_filename": "group_vm_absent.wav"
        }
    ]
}