下载语音留言

下载分机的语音留言文件。

Endpoint

POST /api/v1.1.0/voicemail/get_random?token={token}

请求参数

注： 要下载分机的某个语音留言文件，需要先向 PBX 请求该语音留言文件的随机串。
名称 是否必需 类型 描述
extid 是 Int 要下载哪个分机的语音留言文件。
voicemailfile 是 String 语音留言文件名。
voicemailstatus 是 String 语音留言的状态。
  • read：要下载的语音留言已读，从 read 文件夹获取指定的语音留言文件。
  • unread：要下载的语音留言未读，从 unread 文件夹获取指定的语音留言文件。
allowedip 否 String

设置允许下载语音留言的设备 IP 地址。

  • 不填写allowedip：只能通过第三方服务器可以下载文件。
  • allowedip 值为空：只能通过第三方服务器可以下载文件。
  • allowedip 填写 IP 地址：只能通过该 IP 地址或第三方服务器可以下载文件。
注：
  • allowedip 只能填写一个 IP 地址。

响应参数

名称 类型 描述
extid Int 哪个分机的语音留言。
voicemailstatus String 语音留言的状态。
  • read：已读。
  • unread：未读。
voicemailfile String 语音留言文件的名称。
random String 语音留言文件的随机串。

使用这个随机串组合成下载播放该录音文件请求。

实际示例

请求示例

POST /api/v1.1.0/voicemail/get_random?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8

Host: api.yeastarcloud.com
{
    "extid": "1004",
    "voicemailfile": "msg0000.wav",
    "voicemailstatus": "unread"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "extid": "1004",
    "voicemailstatus": "unread",
    "voicemailfile": "msg0000.wav",
    "random": "70f477822e6a379d7359b2d926ea95a5"
}

语音留言下载链接示例

使用 API 响应的 random 随机串组合成语音留言下载链接。

语音留言下载链接格式：

https://{pbx domain}/api/v1.1.0/voicemail/download?extid=｛extid｝&voicemailstatus=｛voicemailstatus｝&token=｛token｝&voicemailfile={voicemailfile}&random=｛random｝

下面是语音留言下载链接示例：

https://api.yeastarcloud.com/api/v1.1.0/voicemail/download?extid=1005&voicemailstatus=unread&token=72d6640a05811af51e0279461e5272ce&voicemailfile=msg0000.wav&random=1635079c6517f8b82f811cb11e5860d8