更新语音留言的读取状态

使用场景

PBX 用于酒店系统中的房间分机管理，而酒店系统使用第三方语音留言系统存储语音留言。当房间分机有语音留言时，第三方语音留言系统可以调用 API 添加一个语音留言到注册了对应房间话机的 PBX 分机，从而触发话机上的消息指示灯亮起，提示客人有新的语音留言。

客人读取了新的语音留言后，第三方语音留言系统可以调用 API 更新此语音留言的读取状态为已读，从而触发话机上的消息指示灯熄灭。

请求 URL

POST {base_url}/{api_path}/vm/update?access_token={access_token}

请求参数


参数	是否必填	类型	说明
id	是	String	语音留言的唯一 ID。注：可使用查询单个分机或群语音信箱的语音留言接口查询语音留言 ID。
vm_status	是	String	设置语音留言的读取状态。取值范围：`1` (已读)。

响应参数

表 1.
参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。

示例

请求示例

POST /openapi/v1.0/vm/update?access_token=UN4AwGY5YMn2tQDqM8LoRi9oPeInD0oP HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
User-Agent: OpenAPI

{
  "id": "1718161323-00000002",
  "vm_status": 1
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}