查询单个分机或群语音信箱的语音留言
查询单个分机的语音信箱或群语音信箱中的语音留言。
请求 URL
GET {base_url}/{api_path}/vm/get?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
page | 否 | Integer | 定义显示第几个页面。 |
page_size | 否 | Integer | 定义每页显示几项查询结果。 |
number | 是 | Integer | 要查询的分机或群语音信箱的号码。 注: 对于群语音信箱,只支持查询模式设置为 共享至成员
的群语音信箱中的语音留言。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
total_number | Integer | 语音留言总数量。 |
data | Array<Vm_DetailInfo> | 语音留言的详细信息。 |
- Vm_DetailInfo
-
表 3. 参数 类型 说明 msg_id String 语音留言的唯一 ID。 file_name String 分机或群语音信箱中按照接收顺序命名的语音留言文件名。 is_read Integer 语音留言是否已读。 0
:未读1
:已读
duration Integer 语音留言时长 (单位:秒)。 size Integer 文件大小 (单位:字节)。 group_voicemail_read_status Array<Gvm_Read> 群语音信箱中每个成员的语音留言读取状态。 注: 此参数仅在查询群语音信箱中的语音留言时返回读取状态。查询分机时,该参数返回 null。name String 留言方的名称。 time String 留言的时间。 number String 留言方的号码。
示例
请求示例
查询群语音信箱 (号码:6100) 的语音留言。
GET /openapi/v1.0/vm/get?access_token=aX64YMVu2lh6bQvWI94ek40yB5Q6jDKX&number=6100 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 1,
"data": [
{
"msg_id": "1713840555-00000623",
"file_name": "msg0000.wav",
"is_read": 1,
"duration": 18,
"size": 290604,
"group_voicemail_read_status": [
{
"name": "Kristin Hale",
"number": "1002",
"is_read": 0
},
{
"name": "Leo Ball",
"number": "1000",
"is_read": 1
},
{
"name": "Dave Harris",
"number": "1001",
"is_read": 0
},
{
"name": "Terrel Smith",
"number": "1003",
"is_read": 0
}
],
"name": "John(Customer Example)",
"time": "2024/04/23 10:49:15",
"number": "5503301"
}
]
}