播放群语音信箱问候语

播放群语音信箱问候语。

播放问候语步骤

  1. 获取问候语的播放 URL
  2. 下载并播放问候语

请求 URL

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

请求参数

参数 是否必填 类型 说明
extension 是 String 分机号码。
注： 可使用 搜索特定分机 接口查询分机号码。
file 是 String 要播放的问候语的完整文件名 (包含文件扩展名)。
注： 可使用 查询群语音信箱问候语列表 接口查询问候语的完整文件名。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
file String 问候语的完整文件名 (包含文件扩展名)。
play_resource_url String 问候语的播放 URL。
注： 播放 URL 的有效时长为 30 分钟。

示例

请求示例

获取群语音信箱 (号码：6300) 的问候语 (完整文件名：group_vm_welcome.wav) 的播放 URL。

GET /openapi/v1.0/vm_greeting/play?access_token=VZxAbA2kfB6o6eBEh2XJTxIi8auE3KCC&extension=6300&file=group_vm_welcome.wav HTTP/1.1 

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

响应示例

HTTP/1.1 200 OK

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "group_vm_welcome.wav",
    "play_resource_url": "/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105718-NaXXXXXXXXXXXP9O.wav"
}

下载并播放问候语

获取问候语的播放 URL 后，将其与 {base_url} 组合，然后使用组合后的完整链接下载问候语并在本地播放。

播放链接格式

{base_url}/{play_resource_url}

播放链接示例

https://yeastardocs.example.yeastarcloud.com/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105718-NaXXXXXXXXXXXP9O.wav