查询语音留言

查询单个分机、多个分机或所有分机的语音留言。

请求地址

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

请求参数

参数 是否必选 类型 描述
number 是 String 分机号码。表示要查询哪个分机的语音留言。

取值范围：

  • 单个分机号码：查询指定分机的语音留言。

    例如："number":"1000"

  • 多个分机号码：查询多个分机的语音留言。多个分机之间用半角逗号（,）隔开。

    例如："number":"1000,1001"

  • all：查询所有分机的语音留言。

    例如："number":"all"

响应参数

注： 如果查询的分机没有语音留言文件，PBX 只响应请求成功或请求失败的参数。
参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。
voicemails Array <VoicemailInfo> 语音留言列表。
VoicemailInfo
参数 类型 描述
number String 分机号码。
voicemail Array <ExtensionVoicemail> 指定分机的语音留言列表。
ExtensionVoicemail
参数 类型 描述
voicemailfile String 语音留言文件名。
messagefrom String 语音留言是哪个号码发送的。
voicemailstatus String 语音留言的状态。
  • read：已读。
  • unread：未读。
voicemaildate String 收到语音留言的日期和时间。
voicemaillength String 语音留言的时长。

示例

请求示例

查询分机4000的语音留言。

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

{
	"number": "4000"
}
响应示例
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",
	"voicemails": [
		{
			"number": "4000",
			"voicemail": [
				{
					"voicemailfile": "msg0000.wav",
					"messagefrom": "3000",
					"voicemailstatus": "unread",
					"voicemaildate": "2019-10-20 21:41:42",
					"voicemaillength": "77"
				},
				{
					"voicemailfile": "msg0001.wav",
					"messagefrom": "2000",
					"voicemailstatus": "unread",
					"voicemaildate": "2019-10-20 21:49:35",
					"voicemaillength": "18"
				}
			]
		}
	]
}