Update Read Status of a Voicemail Message

Update the read status of a specific voicemail message to "Read".

Scenario

The PBX is used for room extension management in a hotel, and the hotel system utilizes a third-party voicemail system to store voicemail messages. When there is a voicemail message left for a room extension, the third-party voicemail system calls the API to add a voicemail message to the PBX extension registered on the room phone. As a result, the message indicator on the room phone will light up, notifying the guest of the new voicemail message.

After the guest reads the voicemail message, the third-party voicemail system calls the API to update the read status of the voicemail message to "Read". In this way, the message indicator on the room phone will turn off.

Request URL

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

Request parameters

Response parameters

Examples

Request example

POST /openapi/v1.0/vm/update?access_token=UN4AwGY5YMn2tQDqM8LoRi9oPeInD0oP HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
User-Agent: OpenAPI

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

Response example

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