下载语音留言

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

下载步骤

  1. 获取语音留言文件的随机串。
  2. 使用随机串,组合成语音留言文件的下载链接
    注: 随机串的有效时长为30秒,并且每个随机串只能使用一次。

请求地址

{base_url}/{api_path}/voicemail/get_random?token={token}

请求参数

参数 是否必选 类型 描述
number String 分机号码。表示要下载哪个分机的语音留言文件。
voicemailfile String 语音留言文件名。
voicemailstatus String 语音留言的状态。

取值范围

  • read:要下载的语音留言已读,从 read 文件夹获取指定的语音留言文件。
  • unread:要下载的语音留言未读,从 unread 文件夹获取指定的语音留言文件。
allowedip String

设置允许下载语音留言的设备 IP 地址。默认不带此参数,表示只能通过应用服务器下载文件。

取值范围

  • 空值:只能通过应用服务器下载文件。

    例如:"allowedip":" "

  • IP 地址:只能通过该 IP 地址或应用服务器下载文件。

    例如:"allowedip":"192.168.5.20"

响应参数

参数 类型 描述
status String 请求结果。
  • Success:成功。
  • Failed:失败。
number String 分机号码。表示下载的是哪个分机的语音留言。
voicemailstatus String 语音留言的状态
  • read:已读。
  • unread:未读。
voicemailfile String 语音留言文件的名称。
random String 语音留言文件的随机串。

使用这个随机串组合成该语音留言文件的下载链接。

示例

请求示例

获取分机1023语音留言文件“msg0000.wav”的随机串。

POST /api/v2.0.0/voicemail/get_random?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "1023",
	"voicemailfile": "msg0000.wav",
	"voicemailstatus": "unread"
}
响应示例
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"number": "1023",
	"voicemailstatus": "unread",
	"voicemailfile": "msg0000.wav",
	"random": "7d48ba0d1fb647346ed81d6b677f7423"
}

语音留言下载链接示例

使用随机串(random)组合成语音留言的下载链接。

语音留言下载链接格式

https://{pbx ip}:{https port}/api/v2.0.0/voicemail/download?
number={number}&voicemailstatus={voicemailstatus}&token={token}&voicemailfile=
{voicemailfile}&random={random}

语音留言下载链接示例

https://192.168.5.150:8088/api/v2.0.0/voicemail/download?
number=1005&voicemailstatus=unread&token=72d6640a05811af51e0279461e5272ce&
voicemailfile=msg0000.wav&random=1635079c6517f8b82f811cb11e5860d8