下载语音留言

下载指定的语音留言。

下载步骤

  1. 获取语音留言的下载链接
  2. 下载语音留言

请求 URL

GET {base_url}/{api_path}/vm/download?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
msg_id 是 String 语音留言的唯一 ID。
注： 可使用 查询单个分机或群语音信箱的语音留言 接口查询语音留言 ID。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
file String 语音留言的唯一文件名。
download_resource_url String 语音留言的下载 URL。
注： 下载 URL 的有效时长为 30 分钟。

示例

请求示例

获取语音留言 (ID 为 1713033769-00000619) 的下载 URL。

GET /openapi/v1.0/vm/download?access_token=OhhwaZiSoRIJdeC34wQYH7hUjHcuKpf5&msg_id=1713033769-00000619 HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI

响应示例

HTTP/1.1 200 OK

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "PBX-Voicemail-x.15.0.x-download-20240423160019-3nHw52nGalosEJ62.wav",
    "download_resource_url": "/api/download/PBX-Voicemail-x.15.0.x-download-20240423160019-3nHw52nGalosEJ62.wav"
}

下载语音留言

在获取语音留言下载 URL 后，你需要将下载 URL 与 {base_url} 整合，组成一个下载请求 URL，并发送请求下载语音留言。

下载链接格式

GET {base_url}/{download_resource_url}?access_token={access_token}

下载链接示例

GET https://yeastardocs.example.yeastarcloud.com/api/download/PBX-Voicemail-x.15.0.x-download-20240423160019-3nHw52nGalosEJ62.wav?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr HTTP/1.1